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 { "percent_hack_domains", opt_stringptr, {&percent_hack_domains} },
248 { "perl_at_start", opt_bool, {&opt_perl_at_start} },
249 { "perl_startup", opt_stringptr, {&opt_perl_startup} },
250 { "perl_taintmode", opt_bool, {&opt_perl_taintmode} },
253 { "pgsql_servers", opt_stringptr, {&pgsql_servers} },
255 { "pid_file_path", opt_stringptr, {&pid_file_path} },
256 { "pipelining_advertise_hosts", opt_stringptr, {&pipelining_advertise_hosts} },
257 #ifndef DISABLE_PIPE_CONNECT
258 { "pipelining_connect_advertise_hosts", opt_stringptr,
259 {&pipe_connect_advertise_hosts} },
262 { "prdr_enable", opt_bool, {&prdr_enable} },
264 { "preserve_message_logs", opt_bool, {&preserve_message_logs} },
265 { "primary_hostname", opt_stringptr, {&primary_hostname} },
266 { "print_topbitchars", opt_bool, {&print_topbitchars} },
267 { "process_log_path", opt_stringptr, {&process_log_path} },
268 { "prod_requires_admin", opt_bool, {&prod_requires_admin} },
270 { "proxy_protocol_timeout", opt_time, {&proxy_protocol_timeout} },
272 { "qualify_domain", opt_stringptr, {&qualify_domain_sender} },
273 { "qualify_recipient", opt_stringptr, {&qualify_domain_recipient} },
274 { "queue_domains", opt_stringptr, {&queue_domains} },
275 #ifndef DISABLE_QUEUE_RAMP
276 { "queue_fast_ramp", opt_bool, {&queue_fast_ramp} },
278 { "queue_list_requires_admin",opt_bool, {&queue_list_requires_admin} },
279 { "queue_only", opt_bool, {&queue_only} },
280 { "queue_only_file", opt_stringptr, {&queue_only_file} },
281 { "queue_only_load", opt_fixed, {&queue_only_load} },
282 { "queue_only_load_latch", opt_bool, {&queue_only_load_latch} },
283 { "queue_only_override", opt_bool, {&queue_only_override} },
284 { "queue_run_in_order", opt_bool, {&queue_run_in_order} },
285 { "queue_run_max", opt_stringptr, {&queue_run_max} },
286 { "queue_smtp_domains", opt_stringptr, {&queue_smtp_domains} },
287 { "receive_timeout", opt_time, {&receive_timeout} },
288 { "received_header_text", opt_stringptr, {&received_header_text} },
289 { "received_headers_max", opt_int, {&received_headers_max} },
290 { "recipient_unqualified_hosts", opt_stringptr, {&recipient_unqualified_hosts} },
291 { "recipients_max", opt_int, {&recipients_max} },
292 { "recipients_max_reject", opt_bool, {&recipients_max_reject} },
294 { "redis_servers", opt_stringptr, {&redis_servers} },
296 { "remote_max_parallel", opt_int, {&remote_max_parallel} },
297 { "remote_sort_domains", opt_stringptr, {&remote_sort_domains} },
298 { "retry_data_expire", opt_time, {&retry_data_expire} },
299 { "retry_interval_max", opt_time, {&retry_interval_max} },
300 { "return_path_remove", opt_bool, {&return_path_remove} },
301 { "return_size_limit", opt_mkint|opt_hidden, {&bounce_return_size_limit} },
302 { "rfc1413_hosts", opt_stringptr, {&rfc1413_hosts} },
303 { "rfc1413_query_timeout", opt_time, {&rfc1413_query_timeout} },
304 { "sender_unqualified_hosts", opt_stringptr, {&sender_unqualified_hosts} },
305 { "slow_lookup_log", opt_int, {&slow_lookup_log} },
306 { "smtp_accept_keepalive", opt_bool, {&smtp_accept_keepalive} },
307 { "smtp_accept_max", opt_int, {&smtp_accept_max} },
308 { "smtp_accept_max_nonmail", opt_int, {&smtp_accept_max_nonmail} },
309 { "smtp_accept_max_nonmail_hosts", opt_stringptr, {&smtp_accept_max_nonmail_hosts} },
310 { "smtp_accept_max_per_connection", opt_stringptr, {&smtp_accept_max_per_connection} },
311 { "smtp_accept_max_per_host", opt_stringptr, {&smtp_accept_max_per_host} },
312 { "smtp_accept_queue", opt_int, {&smtp_accept_queue} },
313 { "smtp_accept_queue_per_connection", opt_int, {&smtp_accept_queue_per_connection} },
314 { "smtp_accept_reserve", opt_int, {&smtp_accept_reserve} },
315 { "smtp_active_hostname", opt_stringptr, {&raw_active_hostname} },
316 { "smtp_backlog_monitor", opt_int, {&smtp_backlog_monitor} },
317 { "smtp_banner", opt_stringptr, {&smtp_banner} },
318 { "smtp_check_spool_space", opt_bool, {&smtp_check_spool_space} },
319 { "smtp_connect_backlog", opt_int, {&smtp_connect_backlog} },
320 { "smtp_enforce_sync", opt_bool, {&smtp_enforce_sync} },
321 { "smtp_etrn_command", opt_stringptr, {&smtp_etrn_command} },
322 { "smtp_etrn_serialize", opt_bool, {&smtp_etrn_serialize} },
323 { "smtp_load_reserve", opt_fixed, {&smtp_load_reserve} },
324 { "smtp_max_synprot_errors", opt_int, {&smtp_max_synprot_errors} },
325 { "smtp_max_unknown_commands",opt_int, {&smtp_max_unknown_commands} },
326 { "smtp_ratelimit_hosts", opt_stringptr, {&smtp_ratelimit_hosts} },
327 { "smtp_ratelimit_mail", opt_stringptr, {&smtp_ratelimit_mail} },
328 { "smtp_ratelimit_rcpt", opt_stringptr, {&smtp_ratelimit_rcpt} },
329 { "smtp_receive_timeout", opt_func, {.fn = &fn_smtp_receive_timeout} },
330 { "smtp_reserve_hosts", opt_stringptr, {&smtp_reserve_hosts} },
331 { "smtp_return_error_details",opt_bool, {&smtp_return_error_details} },
333 { "smtputf8_advertise_hosts", opt_stringptr, {&smtputf8_advertise_hosts} },
335 #ifdef WITH_CONTENT_SCAN
336 { "spamd_address", opt_stringptr, {&spamd_address} },
339 { "spf_guess", opt_stringptr, {&spf_guess} },
340 { "spf_smtp_comment_template",opt_stringptr, {&spf_smtp_comment_template} },
342 { "split_spool_directory", opt_bool, {&split_spool_directory} },
343 { "spool_directory", opt_stringptr, {&spool_directory} },
344 { "spool_wireformat", opt_bool, {&spool_wireformat} },
346 { "sqlite_dbfile", opt_stringptr, {&sqlite_dbfile} },
347 { "sqlite_lock_timeout", opt_int, {&sqlite_lock_timeout} },
349 { "strict_acl_vars", opt_bool, {&strict_acl_vars} },
350 { "strip_excess_angle_brackets", opt_bool, {&strip_excess_angle_brackets} },
351 { "strip_trailing_dot", opt_bool, {&strip_trailing_dot} },
352 { "syslog_duplication", opt_bool, {&syslog_duplication} },
353 { "syslog_facility", opt_stringptr, {&syslog_facility_str} },
354 { "syslog_pid", opt_bool, {&syslog_pid} },
355 { "syslog_processname", opt_stringptr, {&syslog_processname} },
356 { "syslog_timestamp", opt_bool, {&syslog_timestamp} },
357 { "system_filter", opt_stringptr, {&system_filter} },
358 { "system_filter_directory_transport", opt_stringptr,{&system_filter_directory_transport} },
359 { "system_filter_file_transport",opt_stringptr,{&system_filter_file_transport} },
360 { "system_filter_group", opt_gid, {&system_filter_gid} },
361 { "system_filter_pipe_transport",opt_stringptr,{&system_filter_pipe_transport} },
362 { "system_filter_reply_transport",opt_stringptr,{&system_filter_reply_transport} },
363 { "system_filter_user", opt_uid, {&system_filter_uid} },
364 { "tcp_nodelay", opt_bool, {&tcp_nodelay} },
365 #ifdef USE_TCP_WRAPPERS
366 { "tcp_wrappers_daemon_name", opt_stringptr, {&tcp_wrappers_daemon_name} },
368 { "timeout_frozen_after", opt_time, {&timeout_frozen_after} },
369 { "timezone", opt_stringptr, {&timezone_string} },
370 { "tls_advertise_hosts", opt_stringptr, {&tls_advertise_hosts} },
372 { "tls_alpn", opt_stringptr, {&tls_alpn} },
373 { "tls_certificate", opt_stringptr, {&tls_certificate} },
374 { "tls_crl", opt_stringptr, {&tls_crl} },
375 { "tls_dh_max_bits", opt_int, {&tls_dh_max_bits} },
376 { "tls_dhparam", opt_stringptr, {&tls_dhparam} },
377 { "tls_eccurve", opt_stringptr, {&tls_eccurve} },
378 # ifndef DISABLE_OCSP
379 { "tls_ocsp_file", opt_stringptr, {&tls_ocsp_file} },
381 { "tls_on_connect_ports", opt_stringptr, {&tls_in.on_connect_ports} },
382 { "tls_privatekey", opt_stringptr, {&tls_privatekey} },
383 { "tls_remember_esmtp", opt_bool, {&tls_remember_esmtp} },
384 { "tls_require_ciphers", opt_stringptr, {&tls_require_ciphers} },
385 # ifndef DISABLE_TLS_RESUME
386 { "tls_resumption_hosts", opt_stringptr, {&tls_resumption_hosts} },
388 { "tls_try_verify_hosts", opt_stringptr, {&tls_try_verify_hosts} },
389 { "tls_verify_certificates", opt_stringptr, {&tls_verify_certificates} },
390 { "tls_verify_hosts", opt_stringptr, {&tls_verify_hosts} },
392 { "trusted_groups", opt_gidlist, {&trusted_groups} },
393 { "trusted_users", opt_uidlist, {&trusted_users} },
394 { "unknown_login", opt_stringptr, {&unknown_login} },
395 { "unknown_username", opt_stringptr, {&unknown_username} },
396 { "untrusted_set_sender", opt_stringptr, {&untrusted_set_sender} },
397 { "uucp_from_pattern", opt_stringptr, {&uucp_from_pattern} },
398 { "uucp_from_sender", opt_stringptr, {&uucp_from_sender} },
399 { "warn_message_file", opt_stringptr, {&warn_message_file} },
400 { "write_rejectlog", opt_bool, {&write_rejectlog} }
404 static int optionlist_config_size = nelem(optionlist_config);
411 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
416 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
422 uschar buf[EXIM_DRIVERNAME_MAX];
424 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
426 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
428 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
429 builtin_macro_create(buf);
430 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
432 if (ai->macros_create) (ai->macros_create)();
437 options_logging(void)
439 uschar buf[EXIM_DRIVERNAME_MAX];
441 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
443 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
444 builtin_macro_create(buf);
449 #else /*!MACRO_PREDEF*/
451 extern char **environ;
453 static void save_config_line(const uschar* line);
454 static void save_config_position(const uschar *file, int line);
455 static void print_config(BOOL admin, BOOL terse);
458 #define CSTATE_STACK_SIZE 10
460 const uschar *config_directory = NULL;
463 /* Structure for chain (stack) of .included files */
465 typedef struct config_file_item {
466 struct config_file_item *next;
467 const uschar *filename;
468 const uschar *directory;
473 /* Structure for chain of configuration lines (-bP config) */
475 typedef struct config_line_item {
476 struct config_line_item *next;
480 static config_line_item* config_lines;
482 /* Structure of table of conditional words and their state transitions */
484 typedef struct cond_item {
492 /* Structure of table of syslog facility names and values */
494 typedef struct syslog_fac_item {
500 static const uschar * const hidden = US"<value not displayable>";
502 /* Static variables */
504 static config_file_item *config_file_stack = NULL; /* For includes */
506 static uschar *syslog_facility_str = NULL;
507 static uschar next_section[24];
508 static uschar time_buffer[24];
510 /* State variables for conditional loading (.ifdef / .else / .endif) */
512 static int cstate = 0;
513 static int cstate_stack_ptr = -1;
514 static int cstate_stack[CSTATE_STACK_SIZE];
516 /* Table of state transitions for handling conditional inclusions. There are
517 four possible state transitions:
521 .elifdef true (or .else)
524 .endif just causes the previous cstate to be popped off the stack */
526 static int next_cstate[3][4] =
528 /* State 0: reading from file, or reading until next .else or .endif */
530 /* State 1: condition failed, skipping until next .else or .endif */
532 /* State 2: skipping until .endif */
536 /* Table of conditionals and the states to set. For each name, there are four
537 values: the length of the name (to save computing it each time), the state to
538 set if a macro was found in the line, the state to set if a macro was not found
539 in the line, and a stack manipulation setting which is:
541 -1 pull state value off the stack
542 0 don't alter the stack
543 +1 push value onto stack, before setting new state
546 static cond_item cond_list[] = {
547 { US"ifdef", 5, 0, 1, 1 },
548 { US"ifndef", 6, 1, 0, 1 },
549 { US"elifdef", 7, 2, 3, 0 },
550 { US"elifndef", 8, 3, 2, 0 },
551 { US"else", 4, 2, 2, 0 },
552 { US"endif", 5, 0, 0, -1 }
555 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
557 /* Table of syslog facility names and their values */
559 static syslog_fac_item syslog_list[] = {
560 { US"mail", LOG_MAIL },
561 { US"user", LOG_USER },
562 { US"news", LOG_NEWS },
563 { US"uucp", LOG_UUCP },
564 { US"local0", LOG_LOCAL0 },
565 { US"local1", LOG_LOCAL1 },
566 { US"local2", LOG_LOCAL2 },
567 { US"local3", LOG_LOCAL3 },
568 { US"local4", LOG_LOCAL4 },
569 { US"local5", LOG_LOCAL5 },
570 { US"local6", LOG_LOCAL6 },
571 { US"local7", LOG_LOCAL7 },
572 { US"daemon", LOG_DAEMON }
575 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
578 #define opt_fn_print BIT(0)
579 #define opt_fn_print_label BIT(1)
582 /*************************************************
583 * Find the name of an option *
584 *************************************************/
586 /* This function is to aid debugging. Various functions take arguments that are
587 pointer variables in the options table or in option tables for various drivers.
588 For debugging output, it is useful to be able to find the name of the option
589 which is currently being processed. This function finds it, if it exists, by
590 searching the table(s).
592 Arguments: a value that is presumed to be in the table above
593 Returns: the option name, or an empty string
597 readconf_find_option(void *p)
599 for (int i = 0; i < nelem(optionlist_config); i++)
600 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
602 for (router_instance * r = routers; r; r = r->next)
604 router_info *ri = r->info;
605 for (int i = 0; i < *ri->options_count; i++)
607 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
608 if (p == CS (r->options_block) + ri->options[i].v.offset)
609 return US ri->options[i].name;
613 for (transport_instance * t = transports; t; t = t->next)
615 transport_info *ti = t->info;
616 for (int i = 0; i < *ti->options_count; i++)
618 optionlist * op = &ti->options[i];
619 if ((op->type & opt_mask) != opt_stringptr) continue;
620 if (p == ( op->type & opt_public
622 : CS t->options_block
635 /*************************************************
636 * Deal with an assignment to a macro *
637 *************************************************/
639 /* We have a new definition; append to the list.
642 name Name of the macro; will be copied
643 val Expansion result for the macro; will be copied
647 macro_create(const uschar * name, const uschar * val, BOOL command_line)
649 macro_item * m = store_get(sizeof(macro_item), GET_UNTAINTED);
651 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
653 m->command_line = command_line;
654 m->namelen = Ustrlen(name);
655 m->replen = Ustrlen(val);
656 m->name = string_copy(name);
657 m->replacement = string_copy(val);
669 /* This function is called when a line that starts with an upper case letter is
670 encountered. The argument "line" should contain a complete logical line, and
671 start with the first letter of the macro name. The macro name and the
672 replacement text are extracted and stored. Redefinition of existing,
673 non-command line, macros is permitted using '==' instead of '='.
676 s points to the start of the logical line
678 Returns: FALSE iff fatal error
682 macro_read_assignment(uschar *s)
684 uschar name[EXIM_DRIVERNAME_MAX];
689 while (isalnum(*s) || *s == '_')
691 if (namelen >= sizeof(name) - 1)
693 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
694 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
697 name[namelen++] = *s++;
701 Uskip_whitespace(&s);
704 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
713 Uskip_whitespace(&s);
715 /* If an existing macro of the same name was defined on the command line, we
716 just skip this definition. It's an error to attempt to redefine a macro without
717 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
718 It is also an error to define a macro whose name begins with the name of a
719 previously defined macro. This is the requirement that make using a tree
720 for macros hard; we must check all macros for the substring. Perhaps a
721 sorted list, and a bsearch, would work?
722 Note: it is documented that the other way round works. */
724 for (m = macros; m; m = m->next)
726 if (Ustrcmp(m->name, name) == 0)
728 if (!m->command_line && !redef)
730 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
731 "defined (use \"==\" if you want to redefine it)", name);
737 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
739 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
740 "a macro because previously defined macro \"%s\" is a substring",
745 /* We cannot have this test, because it is documented that a substring
746 macro is permitted (there is even an example).
748 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
749 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
750 * "a macro because it is a substring of previously defined macro \"%s\"",
755 /* Check for an overriding command-line definition. */
757 if (m && m->command_line) return TRUE;
759 /* Redefinition must refer to an existing macro. */
764 m->replen = Ustrlen(s);
765 m->replacement = string_copy(s);
769 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
774 /* We have a new definition. */
776 (void) macro_create(name, s, FALSE);
784 /* Process line for macros. The line is in big_buffer starting at offset len.
785 Expand big_buffer if needed. Handle definitions of new macros, and
786 macro expansions, rewriting the line in the buffer.
789 len Offset in buffer of start of line
790 newlen Pointer to offset of end of line, updated on return
791 macro_found Pointer to return that a macro was expanded
793 Return: pointer to first nonblank char in line
797 macros_expand(int len, int * newlen, BOOL * macro_found)
799 uschar * ss = big_buffer + len;
802 /* Find the true start of the physical line - leading spaces are always
805 Uskip_whitespace(&ss);
807 /* Process the physical line for macros. If this is the start of the logical
808 line, skip over initial text at the start of the line if it starts with an
809 upper case character followed by a sequence of name characters and an equals
810 sign, because that is the definition of a new macro, and we don't do
811 replacement therein. */
814 if (len == 0 && isupper(*s))
816 while (isalnum(*s) || *s == '_') s++;
817 if (Uskip_whitespace(&s) != '=') s = ss; /* Not a macro definition */
820 /* Skip leading chars which cannot start a macro name, to avoid multiple
821 pointless rescans in Ustrstr calls. */
823 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
825 /* For each defined macro, scan the line (from after XXX= if present),
826 replacing all occurrences of the macro. */
828 *macro_found = FALSE;
829 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
834 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
838 while ((p = Ustrstr(t, m->name)) != NULL)
842 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
843 m->name, (int) Ustrlen(ss)-1, ss);
844 /* Expand the buffer if necessary */
846 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
848 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
849 uschar *newbuffer = store_malloc(newsize);
850 memcpy(newbuffer, big_buffer, *newlen + 1);
851 p = newbuffer + (p - big_buffer);
852 s = newbuffer + (s - big_buffer);
853 ss = newbuffer + (ss - big_buffer);
854 t = newbuffer + (t - big_buffer);
855 big_buffer_size = newsize;
856 store_free(big_buffer);
857 big_buffer = newbuffer;
860 /* Shuffle the remaining characters up or down in the buffer before
861 copying in the replacement text. Don't rescan the replacement for this
865 if ((moveby = m->replen - m->namelen) != 0)
867 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
870 Ustrncpy(p, m->replacement, m->replen);
872 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
877 /* An empty macro replacement at the start of a line could mean that ss no
878 longer points to the first non-blank character. */
880 Uskip_whitespace(&ss);
884 /*************************************************
885 * Read configuration line *
886 *************************************************/
888 /* A logical line of text is read from the configuration file into the big
889 buffer, taking account of macros, .includes, and continuations. The size of
890 big_buffer is increased if necessary. The count of configuration lines is
891 maintained. Physical input lines starting with # (ignoring leading white space,
892 and after macro replacement) and empty logical lines are always ignored.
893 Leading and trailing spaces are removed.
895 If we hit a line of the form "begin xxxx", the xxxx is placed in the
896 next_section vector, and the function returns NULL, indicating the end of a
897 configuration section. On end-of-file, NULL is returned with next_section
902 Returns: a pointer to the first non-blank in the line,
903 or NULL if eof or end of section is reached
907 get_config_line(void)
909 int startoffset = 0; /* To first non-blank char in logical line */
910 int len = 0; /* Of logical line so far */
915 /* Loop for handling continuation lines, skipping comments, and dealing with
920 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
922 if (config_file_stack != NULL) /* EOF inside .include */
924 (void)fclose(config_file);
925 config_file = config_file_stack->file;
926 config_filename = config_file_stack->filename;
927 config_directory = config_file_stack->directory;
928 config_lineno = config_file_stack->lineno;
929 config_file_stack = config_file_stack->next;
931 save_config_position(config_filename, config_lineno);
935 /* EOF at top level */
937 if (cstate_stack_ptr >= 0)
938 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
939 "Unexpected end of configuration file: .endif missing");
941 if (len != 0) break; /* EOF after continuation */
942 next_section[0] = 0; /* EOF at start of logical line */
947 newlen = len + Ustrlen(big_buffer + len);
949 if (config_lines && config_lineno == 1)
950 save_config_position(config_filename, config_lineno);
952 /* Handle pathologically long physical lines - yes, it did happen - by
953 extending big_buffer at this point. The code also copes with very long
956 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
959 big_buffer_size += BIG_BUFFER_SIZE;
960 newbuffer = store_malloc(big_buffer_size);
962 /* This use of strcpy is OK because we know that the string in the old
963 buffer is shorter than the new buffer. */
965 Ustrcpy(newbuffer, big_buffer);
966 store_free(big_buffer);
967 big_buffer = newbuffer;
968 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
970 newlen += Ustrlen(big_buffer + newlen);
973 ss = macros_expand(len, &newlen, ¯o_found);
975 /* Check for comment lines - these are physical lines. */
977 if (*ss == '#') continue;
979 /* Handle conditionals, which are also applied to physical lines. Conditions
980 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
981 expansion occurred on the rest of the line. A preliminary test for the leading
982 '.' saves effort on most lines. */
988 /* Search the list of conditional directives */
990 for (i = 0; i < cond_list_size; i++)
993 cond_item *c = cond_list+i;
994 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
996 /* The following character must be white space or end of string */
998 n = ss[1 + c->namelen];
999 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1001 /* .ifdef and .ifndef push the current state onto the stack, then set
1002 a new one from the table. Stack overflow is an error */
1006 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1007 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1008 ".%s nested too deeply", c->name);
1009 cstate_stack[++cstate_stack_ptr] = cstate;
1010 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1013 /* For any of the others, stack underflow is an error. The next state
1014 comes either from the stack (.endif) or from the table. */
1018 if (cstate_stack_ptr < 0)
1019 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1020 ".%s without matching .ifdef", c->name);
1021 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1022 next_cstate[cstate][macro_found? c->action1 : c->action2];
1025 /* Having dealt with a directive, break the loop */
1030 /* If we have handled a conditional directive, continue with the next
1031 physical line. Otherwise, fall through. */
1033 if (i < cond_list_size) continue;
1036 /* If the conditional state is not 0 (actively using these lines), ignore
1039 if (cstate != 0) continue; /* Conditional skip */
1041 /* Handle .include lines - these are also physical lines. */
1043 if (Ustrncmp(ss, ".include", 8) == 0 &&
1045 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1048 int include_if_exists = isspace(ss[8])? 0 : 10;
1049 config_file_item *save;
1050 struct stat statbuf;
1052 ss += 9 + include_if_exists;
1053 Uskip_whitespace(&ss);
1054 t = ss + Ustrlen(ss);
1055 while (t > ss && isspace(t[-1])) t--;
1056 if (*ss == '\"' && t[-1] == '\"')
1063 /* We allow relative file names. For security reasons currently
1064 relative names not allowed with .include_if_exists. For .include_if_exists
1065 we need to check the permissions/ownership of the containing folder */
1067 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1068 "absolute path \"%s\"", ss);
1071 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1072 ss = string_from_gstring(g);
1075 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1078 save_config_position(config_filename, config_lineno);
1079 save = store_get(sizeof(config_file_item), GET_UNTAINTED);
1080 save->next = config_file_stack;
1081 config_file_stack = save;
1082 save->file = config_file;
1083 save->filename = config_filename;
1084 save->directory = config_directory;
1085 save->lineno = config_lineno;
1087 if (!(config_file = Ufopen(ss, "rb")))
1088 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1089 "configuration file %s", ss);
1091 config_filename = string_copy(ss);
1092 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1097 /* If this is the start of the logical line, remember where the non-blank
1098 data starts. Otherwise shuffle down continuation lines to remove leading
1102 startoffset = ss - big_buffer;
1105 s = big_buffer + len;
1108 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1113 /* Accept the new addition to the line. Remove trailing white space. */
1116 while (len > 0 && isspace(big_buffer[len-1])) len--;
1117 big_buffer[len] = 0;
1119 /* We are done if the line does not end in backslash and contains some data.
1120 Empty logical lines are ignored. For continuations, remove the backslash and
1121 go round the loop to read the continuation line. */
1125 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1126 big_buffer[--len] = 0; /* Remove backslash */
1128 } /* Loop for reading multiple physical lines */
1130 /* We now have a logical line. Test for the end of a configuration section (or,
1131 more accurately, for the start of the next section). Place the name of the next
1132 section in next_section, and return NULL. If the name given is longer than
1133 next_section, truncate it. It will be unrecognized later, because all the known
1134 section names do fit. Leave space for pluralizing. */
1136 s = big_buffer + startoffset; /* First non-space character */
1139 save_config_line(s);
1141 if (strncmpic(s, US"begin ", 6) == 0)
1144 Uskip_whitespace(&s);
1145 if (big_buffer + len - s > sizeof(next_section) - 2)
1146 s[sizeof(next_section) - 2] = 0;
1147 Ustrcpy(next_section, s);
1151 /* Return the first non-blank character. */
1158 /*************************************************
1160 *************************************************/
1162 /* The yield is the pointer to the next uschar. Names longer than the
1163 output space are silently truncated. This function is also used from acl.c when
1167 name where to put the name
1171 Returns: new input pointer
1175 readconf_readname(uschar *name, int len, uschar *s)
1178 BOOL broken = FALSE;
1180 if (isalpha(Uskip_whitespace(&s)))
1181 while (isalnum(*s) || *s == '_')
1183 if (p < len-1) name[p++] = *s;
1193 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1194 "exim item name too long (>%d), unable to use \"%s\" (truncated)",
1197 Uskip_whitespace(&s);
1204 /*************************************************
1205 * Read a time value *
1206 *************************************************/
1208 /* This function is also called from outside, to read argument
1209 time values. The format of a time value is:
1211 [<n>w][<n>d][<n>h][<n>m][<n>s]
1213 as long as at least one is present. If a format error is encountered,
1214 return a negative value. The value must be terminated by the given
1219 terminator required terminating character
1220 return_msec if TRUE, allow fractional seconds and return milliseconds
1222 Returns: the time value, or -1 on syntax error
1223 value is seconds if return_msec is FALSE
1224 value is milliseconds if return_msec is TRUE
1228 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1236 if (!isdigit(*s)) return -1;
1237 (void)sscanf(CCS s, "%d%n", &value, &count);
1242 case 'w': value *= 7;
1243 case 'd': value *= 24;
1244 case 'h': value *= 60;
1245 case 'm': value *= 60;
1250 if (!return_msec) return -1;
1251 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1253 if (*s++ != 's') return -1;
1254 yield += (int)(fraction * 1000.0);
1260 if (return_msec) value *= 1000;
1262 if (*s == terminator) return yield;
1264 /* Control never reaches here. */
1269 /*************************************************
1270 * Read a fixed point value *
1271 *************************************************/
1273 /* The value is returned *1000
1277 terminator required terminator
1279 Returns: the value, or -1 on error
1283 readconf_readfixed(const uschar *s, int terminator)
1287 if (!isdigit(*s)) return -1;
1288 (void)sscanf(CS s, "%d%n", &value, &count);
1290 yield = value * 1000;
1294 while (isdigit((*(++s))))
1296 yield += (*s - '0') * m;
1301 return (*s == terminator)? yield : (-1);
1306 /*************************************************
1307 * Find option in list *
1308 *************************************************/
1310 /* The lists are always in order, so binary chop can be used.
1313 name the option name to search for
1314 ol the first entry in the option list
1315 last one more than the offset of the last entry in the option list
1317 Returns: pointer to an option entry, or NULL if not found
1321 find_option(const uschar *name, optionlist *ol, int last)
1324 while (last > first)
1326 int middle = (first + last)/2;
1327 int c = Ustrcmp(name, ol[middle].name);
1329 if (c == 0) return ol + middle;
1330 else if (c > 0) first = middle + 1;
1338 /*************************************************
1339 * Find a set flag in option list *
1340 *************************************************/
1342 /* Because some versions of Unix make no restrictions on the values of uids and
1343 gids (even negative ones), we cannot represent "unset" by a special value.
1344 There is therefore a separate boolean variable for each one indicating whether
1345 a value is set or not. This function returns a pointer to the boolean, given
1346 the original option name. It is a major disaster if the flag cannot be found.
1349 name the name of the uid or gid option
1350 oltop points to the start of the relevant option list
1351 last one more than the offset of the last item in the option list
1352 data_block NULL when reading main options => data values in the option
1353 list are absolute addresses; otherwise they are byte offsets
1354 in data_block (used for driver options)
1356 Returns: a pointer to the boolean flag.
1360 get_set_flag(const uschar *name, optionlist *oltop, int last, void *data_block)
1363 uschar name2[EXIM_DRIVERNAME_MAX];
1364 sprintf(CS name2, "*set_%.50s", name);
1365 if (!(ol = find_option(name2, oltop, last)))
1366 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1367 "Exim internal error: missing set flag for %s", name);
1369 ? (BOOL *)(US data_block + ol->v.offset) : (BOOL *)ol->v.value;
1375 /*************************************************
1376 * Output extra characters message and die *
1377 *************************************************/
1379 /* Called when an option line has junk on the end. Sometimes this is because
1380 the sysadmin thinks comments are permitted.
1383 s points to the extra characters
1384 t1..t3 strings to insert in the log message
1386 Returns: doesn't return; dies
1390 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1392 uschar *comment = US"";
1393 if (*s == '#') comment = US" (# is comment only at line start)";
1394 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1395 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1400 /*************************************************
1401 * Read rewrite information *
1402 *************************************************/
1404 /* Each line of rewrite information contains:
1406 . A complete address in the form user@domain, possibly with
1407 leading * for each part; or alternatively, a regex.
1409 . A replacement string (which will be expanded).
1411 . An optional sequence of one-letter flags, indicating which
1412 headers etc. to apply this rule to.
1414 All this is decoded and placed into a control block. The OR of the flags is
1415 maintained in a common word.
1418 p points to the string that makes up the rule
1419 existflags points to the overall flag word
1420 isglobal TRUE if reading global rewrite rules
1422 Returns: the control block for the parsed rule.
1425 static rewrite_rule *
1426 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1428 rewrite_rule * next = store_get(sizeof(rewrite_rule), GET_UNTAINTED);
1431 next->key = string_dequote(&p);
1433 Uskip_whitespace(&p);
1435 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1436 "missing rewrite replacement string");
1439 next->replacement = string_dequote(&p);
1441 while (*p) switch (*p++)
1443 case ' ': case '\t': break;
1445 case 'q': next->flags |= rewrite_quit; break;
1446 case 'w': next->flags |= rewrite_whole; break;
1448 case 'h': next->flags |= rewrite_all_headers; break;
1449 case 's': next->flags |= rewrite_sender; break;
1450 case 'f': next->flags |= rewrite_from; break;
1451 case 't': next->flags |= rewrite_to; break;
1452 case 'c': next->flags |= rewrite_cc; break;
1453 case 'b': next->flags |= rewrite_bcc; break;
1454 case 'r': next->flags |= rewrite_replyto; break;
1456 case 'E': next->flags |= rewrite_all_envelope; break;
1457 case 'F': next->flags |= rewrite_envfrom; break;
1458 case 'T': next->flags |= rewrite_envto; break;
1460 case 'Q': next->flags |= rewrite_qualify; break;
1461 case 'R': next->flags |= rewrite_repeat; break;
1464 next->flags |= rewrite_smtp;
1465 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1467 "rewrite rule has the S flag but is not a regular expression");
1471 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1472 "unknown rewrite flag character '%c' "
1473 "(could be missing quotes round replacement item)", p[-1]);
1477 /* If no action flags are set, set all the "normal" rewrites. */
1479 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1480 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1482 /* Remember which exist, for optimization, and return the rule */
1484 *existflags |= next->flags;
1491 /*************************************************
1492 * Read global rewrite information *
1493 *************************************************/
1495 /* Each line is a single rewrite rule; it is parsed into a control block
1496 by readconf_one_rewrite(), and its flags are ORed into the global flag
1497 word rewrite_existflags. */
1500 readconf_rewrites(void)
1502 rewrite_rule **chain = &global_rewrite_rules;
1505 while ((p = get_config_line()) != NULL)
1507 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1509 chain = &(next->next);
1515 /*************************************************
1517 *************************************************/
1519 /* Strings are read into the normal store pool. As long we aren't too
1520 near the end of the current block, the string will just use what is necessary
1521 on the top of the stacking pool, because string_cat() uses the extension
1525 s the rest of the input line
1526 name the option name (for errors)
1528 Returns: pointer to the string
1532 read_string(const uschar *s, const uschar *name)
1537 if (*s != '\"') return string_copy(s);
1540 yield = string_dequote(&s);
1542 if (s == ss+1 || s[-1] != '\"')
1543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1544 "missing quote at end of string value for %s", name);
1546 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1552 /*************************************************
1553 * Custom-handler options *
1554 *************************************************/
1556 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1558 if (flags & opt_fn_print)
1560 if (flags & opt_fn_print_label) printf("%s = ", name);
1561 printf("%s\n", smtp_receive_timeout_s
1562 ? string_printing2(smtp_receive_timeout_s, SP_TAB)
1563 : readconf_printtime(smtp_receive_timeout));
1565 else if (*str == '$')
1566 smtp_receive_timeout_s = string_copy(str);
1569 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1570 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1571 if (smtp_receive_timeout < 0)
1572 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1577 /*************************************************
1578 * Handle option line *
1579 *************************************************/
1581 /* This function is called from several places to process a line containing the
1582 setting of an option. The first argument is the line to be decoded; it has been
1583 checked not to be empty and not to start with '#'. Trailing newlines and white
1584 space have been removed. The second argument is a pointer to the list of
1585 variable names that are to be recognized, together with their types and
1586 locations, and the third argument gives the number of entries in the list.
1588 The fourth argument is a pointer to a data block. If it is NULL, then the data
1589 values in the options list are absolute addresses. Otherwise, they are byte
1590 offsets in the data block.
1592 String option data may continue onto several lines; this function reads further
1593 data from config_file if necessary.
1595 The yield of this function is normally zero. If a string continues onto
1596 multiple lines, then the data value is permitted to be followed by a comma
1597 or a semicolon (for use in drivers) and the yield is that character.
1600 buffer contains the configuration line to be handled
1601 oltop points to the start of the relevant option list
1602 last one more than the offset of the last item in the option list
1603 data_block NULL when reading main options => data values in the option
1604 list are absolute addresses; otherwise they are byte offsets
1605 in data_block when they have opt_public set; otherwise
1606 they are byte offsets in data_block->options_block.
1607 unknown_txt format string to use in panic message for unknown option;
1608 must contain %s for option name
1609 if given as NULL, don't panic on unknown option
1611 Returns: TRUE if an option was read successfully,
1612 FALSE false for an unknown option if unknown_txt == NULL,
1613 otherwise panic and die on an unknown option
1617 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1618 void *data_block, uschar *unknown_txt)
1622 int count, type, value;
1626 BOOL boolvalue = TRUE;
1627 BOOL freesptr = TRUE;
1628 optionlist *ol, *ol2;
1632 uschar *inttype = US"";
1635 uschar **str_target;
1636 uschar name[EXIM_DRIVERNAME_MAX];
1637 uschar name2[EXIM_DRIVERNAME_MAX];
1639 /* There may be leading spaces; thereafter, we expect an option name starting
1642 while (isspace(*s)) s++;
1644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1646 /* Read the name of the option, and skip any subsequent white space. If
1647 it turns out that what we read was "hide", set the flag indicating that
1648 this is a secure option, and loop to read the next word. */
1650 for (int n = 0; n < 2; n++)
1652 while (isalnum(*s) || *s == '_')
1654 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1658 while (isspace(*s)) s++;
1659 if (Ustrcmp(name, "hide") != 0) break;
1660 issecure = opt_secure;
1664 /* Deal with "no_" or "not_" here for booleans */
1666 if (Ustrncmp(name, "no_", 3) == 0)
1672 if (Ustrncmp(name, "not_", 4) == 0)
1678 /* Search the list for the given name. A non-existent name, or an option that
1679 is set twice, is a disaster. */
1681 if (!(ol = find_option(name + offset, oltop, last)))
1683 if (!unknown_txt) return FALSE;
1684 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1687 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1688 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1689 "\"%s\" option set for the second time", name);
1691 ol->type |= opt_set | issecure;
1692 type = ol->type & opt_mask;
1694 /* Types with data values must be followed by '='; the "no[t]_" prefix
1695 applies only to boolean values. */
1697 if (type < opt_bool || type > opt_bool_last)
1700 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1701 "negation prefix applied to a non-boolean option");
1703 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1704 "unexpected end of line (data missing) after %s", name);
1706 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1709 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1710 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1711 ultimately expands to one of those values. */
1713 else if (*s && (offset != 0 || *s != '='))
1714 extra_chars_error(s, US"boolean option ", name, US"");
1716 /* Skip white space after = */
1718 if (*s == '=') while (isspace((*(++s))));
1720 /* If there is a data block and the opt_public flag is not set, change
1721 the data block pointer to the private options block. */
1723 if (data_block && !(ol->type & opt_public))
1724 data_block = (void *)(((driver_instance *)data_block)->options_block);
1726 /* Now get the data according to the type. */
1730 /* If a string value is not enclosed in quotes, it consists of
1731 the rest of the current line, verbatim. Otherwise, string escapes
1734 A transport is specified as a string, which is then looked up in the
1735 list of transports. A search type is specified as one of a number of
1738 A set or rewrite rules for a driver is specified as a string, which is
1739 then parsed into a suitable chain of control blocks.
1741 Uids and gids are specified as strings which are then looked up in the
1742 passwd file. Lists of uids and gids are similarly specified as colon-
1743 separated strings. */
1748 case opt_expand_uid:
1749 case opt_expand_gid:
1754 reset_point = store_mark();
1755 sptr = read_string(s, name);
1757 /* Having read a string, we now have several different ways of using it,
1758 depending on the data type, so do another switch. If keeping the actual
1759 string is not required (because it is interpreted), freesptr is set TRUE,
1760 and at the end we reset the pool. */
1764 /* If this was a string, set the variable to point to the new string,
1765 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1766 rules, we still keep the string (for printing), and parse the rules into a
1767 control block and flags word. */
1770 str_target = data_block ? USS (US data_block + ol->v.offset)
1772 if (ol->type & opt_rep_con)
1774 uschar * saved_condition;
1775 /* We already have a condition, we're conducting a crude hack to let
1776 multiple condition rules be chained together, despite storing them in
1778 *str_target = string_copy_perm( (saved_condition = *str_target)
1779 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1780 saved_condition, sptr)
1783 /* TODO(pdp): there is a memory leak here and just below
1784 when we set 3 or more conditions; I still don't
1785 understand the store mechanism enough to know
1786 what's the safe way to free content from an earlier store.
1787 AFAICT, stores stack, so freeing an early stored item also stores
1788 all data alloc'd after it. If we knew conditions were adjacent,
1789 we could survive that, but we don't. So I *think* we need to take
1790 another bit from opt_type to indicate "malloced"; this seems like
1791 quite a hack, especially for this one case. It also means that
1792 we can't ever reclaim the store from the *first* condition.
1794 Because we only do this once, near process start-up, I'm prepared to
1795 let this slide for the time being, even though it rankles. */
1797 else if (ol->type & opt_rep_str)
1800 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1801 : Ustrncmp(name, "set", 3) == 0 ? ';'
1803 int sep_i = -(int)sep_o;
1804 const uschar * list = sptr;
1806 gstring * list_o = NULL;
1810 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1811 list_o = string_cat(list_o, *str_target);
1814 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1815 list_o = string_append_listele(list_o, sep_o, s);
1818 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1829 *USS (US data_block + ol->v.offset) = sptr;
1831 *USS ol->v.value = sptr;
1833 if (type == opt_rewrite)
1838 rewrite_rule **chain;
1841 sprintf(CS name2, "*%.50s_rules", name);
1842 ol2 = find_option(name2, oltop, last);
1843 sprintf(CS name2, "*%.50s_flags", name);
1844 ol3 = find_option(name2, oltop, last);
1847 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1848 "rewrite rules not available for driver");
1852 chain = (rewrite_rule **)(US data_block + ol2->v.offset);
1853 flagptr = (int *)(US data_block + ol3->v.offset);
1857 chain = (rewrite_rule **)ol2->v.value;
1858 flagptr = (int *)ol3->v.value;
1861 /* This will trap if sptr is tainted. Not sure if that can happen */
1862 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1864 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1866 chain = &(next->next);
1869 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1871 "non-header rewrite - not allowed at transport time -");
1875 /* If it was an expanded uid, see if there is any expansion to be
1876 done by checking for the presence of a $ character. If there is, save it
1877 in the corresponding *expand_user option field. Otherwise, fall through
1878 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1881 case opt_expand_uid:
1882 sprintf(CS name2, "*expand_%.50s", name);
1883 if ((ol2 = find_option(name2, oltop, last)))
1885 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1888 *(USS(US data_block + ol2->v.offset)) = ss;
1890 *(USS ol2->v.value) = ss;
1894 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1900 /* Look up a fixed uid, and also make use of the corresponding gid
1901 if a passwd entry is returned and the gid has not been set. */
1904 if (!route_finduser(sptr, &pw, &uid))
1905 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1907 *(uid_t *)(US data_block + ol->v.offset) = uid;
1909 *(uid_t *)ol->v.value = uid;
1911 /* Set the flag indicating a fixed value is set */
1913 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1915 /* Handle matching gid if we have a passwd entry: done by finding the
1916 same name with terminating "user" changed to "group"; if not found,
1917 ignore. Also ignore if the value is already set. */
1919 if (pw == NULL) break;
1920 Ustrcpy(name+Ustrlen(name)-4, US"group");
1921 ol2 = find_option(name, oltop, last);
1922 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1923 (ol2->type & opt_mask) == opt_expand_gid))
1925 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1929 *((gid_t *)(US data_block + ol2->v.offset)) = pw->pw_gid;
1931 *((gid_t *)ol2->v.value) = pw->pw_gid;
1937 /* If it was an expanded gid, see if there is any expansion to be
1938 done by checking for the presence of a $ character. If there is, save it
1939 in the corresponding *expand_user option field. Otherwise, fall through
1940 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1943 case opt_expand_gid:
1944 sprintf(CS name2, "*expand_%.50s", name);
1945 if ((ol2 = find_option(name2, oltop, last)))
1947 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1950 *(USS(US data_block + ol2->v.offset)) = ss;
1952 *(USS ol2->v.value) = ss;
1956 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1962 /* Handle freestanding gid */
1965 if (!route_findgroup(sptr, &gid))
1966 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1968 *((gid_t *)(US data_block + ol->v.offset)) = gid;
1970 *((gid_t *)ol->v.value) = gid;
1971 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1974 /* If it was a uid list, look up each individual entry, and build
1975 a vector of uids, with a count in the first element. Put the vector
1976 in malloc store so we can free the string. (We are reading into
1977 permanent store already.) */
1985 const uschar *op = expand_string (sptr);
1988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1989 name, expand_string_message);
1992 if (*p != 0) count++;
1993 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1994 list = store_malloc(count*sizeof(uid_t));
1995 list[ptr++] = (uid_t)(count - 1);
1998 *((uid_t **)(US data_block + ol->v.offset)) = list;
2000 *((uid_t **)ol->v.value) = list;
2006 /* If p is tainted we trap. Not sure that can happen */
2007 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2008 if (!route_finduser(big_buffer, NULL, &uid))
2009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2016 /* If it was a gid list, look up each individual entry, and build
2017 a vector of gids, with a count in the first element. Put the vector
2018 in malloc store so we can free the string. (We are reading into permanent
2027 const uschar *op = expand_string (sptr);
2030 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2031 name, expand_string_message);
2034 if (*p != 0) count++;
2035 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2036 list = store_malloc(count*sizeof(gid_t));
2037 list[ptr++] = (gid_t)(count - 1);
2040 *((gid_t **)(US data_block + ol->v.offset)) = list;
2042 *((gid_t **)ol->v.value) = list;
2048 /* If p is tainted we trap. Not sure that can happen */
2049 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2050 if (!route_findgroup(big_buffer, &gid))
2051 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2059 /* Release store if the value of the string doesn't need to be kept. */
2061 if (freesptr) reset_point = store_reset(reset_point);
2064 /* Expanded boolean: if no characters follow, or if there are no dollar
2065 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2066 save the string for later expansion in the alternate place. */
2068 case opt_expand_bool:
2069 if (*s && Ustrchr(s, '$') != 0)
2071 sprintf(CS name2, "*expand_%.50s", name);
2072 if ((ol2 = find_option(name2, oltop, last)))
2074 reset_point = store_mark();
2075 sptr = read_string(s, name);
2077 *(USS(US data_block + ol2->v.offset)) = sptr;
2079 *(USS ol2->v.value) = sptr;
2086 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2087 look for yes/not/true/false. Some booleans are stored in a single bit in
2088 a single int. There's a special fudge for verify settings; without a suffix
2089 they set both xx_sender and xx_recipient. The table points to the sender
2090 value; search subsequently for the recipient. There's another special case:
2091 opt_bool_set also notes when a boolean has been set. */
2095 case opt_bool_verify:
2099 s = readconf_readname(name2, EXIM_DRIVERNAME_MAX, s);
2100 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2102 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2104 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2105 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2106 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2107 US"for boolean option ", name);
2110 /* Handle single-bit type. */
2112 if (type == opt_bit)
2114 int bit = 1 << ((ol->type >> 16) & 31);
2115 int * ptr = data_block
2116 ? (int *)(US data_block + ol->v.offset)
2117 : (int *)ol->v.value;
2118 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2122 /* Handle full BOOL types */
2125 *((BOOL *)(US data_block + ol->v.offset)) = boolvalue;
2127 *((BOOL *)ol->v.value) = boolvalue;
2131 if (type == opt_bool_verify)
2133 sprintf(CS name2, "%.50s_recipient", name + offset);
2134 if ((ol2 = find_option(name2, oltop, last)))
2136 *((BOOL *)(US data_block + ol2->v.offset)) = boolvalue;
2138 *((BOOL *)ol2->v.value) = boolvalue;
2141 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2143 else if (type == opt_bool_set)
2145 sprintf(CS name2, "*set_%.50s", name + offset);
2146 if ((ol2 = find_option(name2, oltop, last)))
2148 *((BOOL *)(US data_block + ol2->v.offset)) = TRUE;
2150 *((BOOL *)ol2->v.value) = TRUE;
2158 inttype = US"octal ";
2160 /* Integer: a simple(ish) case; allow octal and hex formats, and
2161 suffixes K, M, G, and T. The different types affect output, not input. */
2170 lvalue = strtol(CS s, CSS &endptr, intbase);
2173 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2176 if (errno != ERANGE && *endptr)
2178 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2180 if ((mp = Ustrchr(mp, *endptr)))
2185 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2196 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2197 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2198 "absolute value of integer \"%s\" is too large (overflow)", s);
2200 while (isspace(*endptr)) endptr++;
2202 extra_chars_error(endptr, inttype, US"integer value for ", name);
2204 value = (int)lvalue;
2208 *(int *)(US data_block + ol->v.offset) = value;
2210 *(int *)ol->v.value = value;
2213 /* Integer held in K: again, allow formats and suffixes as above. */
2219 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2222 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2225 if (errno != ERANGE && *endptr)
2227 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2229 if ((mp = Ustrchr(mp, *endptr)))
2234 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2243 lvalue = (lvalue + 512)/1024;
2246 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2247 "absolute value of integer \"%s\" is too large (overflow)", s);
2249 while (isspace(*endptr)) endptr++;
2251 extra_chars_error(endptr, inttype, US"integer value for ", name);
2254 *(int_eximarith_t *)(US data_block + ol->v.offset) = lvalue;
2256 *(int_eximarith_t *)ol->v.value = lvalue;
2260 /* Fixed-point number: held to 3 decimal places. */
2263 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2264 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2265 "fixed-point number expected for %s", name);
2267 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2268 "integer \"%s\" is too large (overflow)", s);
2272 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2273 "integer \"%s\" is too large (overflow)", s);
2275 /* We get a coverity error here for using count, as it derived
2276 from the tainted buffer pointed to by s, as parsed by sscanf().
2277 By the definition of sscanf we must be accessing between start
2278 and end of s (assuming it is nul-terminated...) so ignore the error. */
2279 /* coverity[tainted_data] */
2280 if (s[count] == '.')
2283 while (isdigit(s[++count]))
2285 value += (s[count] - '0') * d;
2290 while (isspace(s[count])) count++;
2293 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2296 *((int *)(US data_block + ol->v.offset)) = value;
2298 *((int *)ol->v.value) = value;
2301 /* There's a special routine to read time values. */
2304 value = readconf_readtime(s, 0, FALSE);
2306 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2309 *((int *)(US data_block + ol->v.offset)) = value;
2311 *((int *)ol->v.value) = value;
2314 /* A time list is a list of colon-separated times, with the first
2315 element holding the size of the list and the second the number of
2321 int * list = data_block
2322 ? (int *)(US data_block + ol->v.offset)
2323 : (int *)ol->v.value;
2325 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2328 uschar *snext = Ustrchr(s, ':');
2332 while (ss > s && isspace(ss[-1])) ss--;
2335 value = readconf_readtime(s, terminator, FALSE);
2337 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2339 if (count > 1 && value <= list[count])
2340 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2341 "time value out of order for %s", name);
2342 list[count+1] = value;
2343 if (snext == NULL) break;
2345 while (isspace(*s)) s++;
2348 if (count > list[0] - 2)
2349 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2351 if (count > 0 && list[2] == 0) count = 0;
2358 void (*fn)() = ol->v.fn;
2369 /*************************************************
2370 * Print a time value *
2371 *************************************************/
2374 Argument: a time value in seconds
2375 Returns: pointer to a fixed buffer containing the time as a string,
2376 in readconf_readtime() format
2380 readconf_printtime(int t)
2383 uschar *p = time_buffer;
2400 if (w > 0) p += sprintf(CS p, "%dw", w);
2401 if (d > 0) p += sprintf(CS p, "%dd", d);
2402 if (h > 0) p += sprintf(CS p, "%dh", h);
2403 if (m > 0) p += sprintf(CS p, "%dm", m);
2404 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2411 /*************************************************
2412 * Print an individual option value *
2413 *************************************************/
2415 /* This is used by the -bP option, so prints to the standard output.
2416 The entire options list is passed in as an argument, because some options come
2417 in pairs - typically uid/gid settings, which can either be explicit numerical
2418 values, or strings to be expanded later. If the numerical value is unset,
2419 search for "*expand_<name>" to see if there is a string equivalent.
2422 ol option entry, or NULL for an unknown option
2424 options_block NULL for main configuration options; otherwise points to
2425 a driver block; if the option doesn't have opt_public
2426 set, then options_block->options_block is where the item
2428 oltop points to the option list in which ol exists
2429 last one more than the offset of the last entry in optop
2430 no_labels do not show "foo = " at the start.
2432 Returns: boolean success
2436 print_ol(optionlist *ol, const uschar *name, void *options_block,
2437 optionlist *oltop, int last, BOOL no_labels)
2446 uschar name2[EXIM_DRIVERNAME_MAX];
2450 printf("%s is not a known option\n", name);
2454 /* Non-admin callers cannot see options that have been flagged secure by the
2457 if (!f.admin_user && ol->type & opt_secure)
2460 printf("%s\n", CCS hidden);
2462 printf("%s = %s\n", name, CCS hidden);
2466 /* Else show the value of the option */
2468 value = ol->v.value;
2471 if (!(ol->type & opt_public))
2472 options_block = (void *)(((driver_instance *)options_block)->options_block);
2473 value = (void *)(US options_block + (long int)value);
2476 switch(ol->type & opt_mask)
2479 case opt_rewrite: /* Show the text value */
2481 if (!no_labels) printf("%s = ", name);
2482 printf("%s\n", s ? string_printing2(s, SP_TAB) : US"");
2486 if (!no_labels) printf("%s = ", name);
2487 printf("%d\n", *((int *)value));
2492 int x = *((int *)value);
2493 if (x != 0 && (x & 1023) == 0)
2497 if ((x & 1023) == 0)
2502 if (!no_labels) printf("%s = ", name);
2503 printf("%d%c\n", x, c);
2507 if (!no_labels) printf("%s = ", name);
2515 int_eximarith_t x = *((int_eximarith_t *)value);
2516 if (!no_labels) printf("%s = ", name);
2517 if (x == 0) printf("0\n");
2518 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2519 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2520 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2521 else printf(PR_EXIM_ARITH "K\n", x);
2526 if (!no_labels) printf("%s = ", name);
2527 printf("%#o\n", *((int *)value));
2530 /* Can be negative only when "unset", in which case integer */
2534 int x = *((int *)value);
2537 if (x < 0) printf("%s =\n", name); else
2539 if (!no_labels) printf("%s = ", name);
2540 printf("%d.", x/1000);
2553 /* If the numerical value is unset, try for the string value */
2555 case opt_expand_uid:
2556 if (! *get_set_flag(name, oltop, last, options_block))
2558 sprintf(CS name2, "*expand_%.50s", name);
2559 if ((ol2 = find_option(name2, oltop, last)))
2562 s = *USS (US options_block + ol2->v.offset);
2564 s = *USS ol2->v.value;
2565 if (!no_labels) printf("%s = ", name);
2566 printf("%s\n", s ? string_printing(s) : US"");
2571 /* Else fall through */
2574 if (!no_labels) printf("%s = ", name);
2575 if (! *get_set_flag(name, oltop, last, options_block))
2578 if ((pw = getpwuid(*((uid_t *)value))))
2579 printf("%s\n", pw->pw_name);
2581 printf("%ld\n", (long int)(*((uid_t *)value)));
2584 /* If the numerical value is unset, try for the string value */
2586 case opt_expand_gid:
2587 if (! *get_set_flag(name, oltop, last, options_block))
2589 sprintf(CS name2, "*expand_%.50s", name);
2590 if ( (ol2 = find_option(name2, oltop, last))
2591 && (ol2->type & opt_mask) == opt_stringptr)
2594 s = *USS (US options_block + ol2->v.offset);
2596 s = *USS ol2->v.value;
2597 if (!no_labels) printf("%s = ", name);
2598 printf("%s\n", s ? string_printing(s) : US"");
2603 /* Else fall through */
2606 if (!no_labels) printf("%s = ", name);
2607 if (! *get_set_flag(name, oltop, last, options_block))
2610 if ((gr = getgrgid(*((int *)value))))
2611 printf("%s\n", gr->gr_name);
2613 printf("%ld\n", (long int)(*((int *)value)));
2617 uidlist = *((uid_t **)value);
2618 if (!no_labels) printf("%s =", name);
2621 uschar sep = no_labels ? '\0' : ' ';
2622 for (int i = 1; i <= (int)(uidlist[0]); i++)
2624 uschar *name = NULL;
2625 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2626 if (sep != '\0') printf("%c", sep);
2627 if (name) printf("%s", name);
2628 else printf("%ld", (long int)(uidlist[i]));
2636 gidlist = *((gid_t **)value);
2637 if (!no_labels) printf("%s =", name);
2640 uschar sep = no_labels ? '\0' : ' ';
2641 for (int i = 1; i <= (int)(gidlist[0]); i++)
2643 uschar *name = NULL;
2644 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2645 if (sep != '\0') printf("%c", sep);
2646 if (name) printf("%s", name);
2647 else printf("%ld", (long int)(gidlist[i]));
2655 if (!no_labels) printf("%s = ", name);
2656 printf("%s\n", readconf_printtime(*((int *)value)));
2661 int *list = (int *)value;
2662 if (!no_labels) printf("%s = ", name);
2663 for (int i = 0; i < list[1]; i++)
2664 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2670 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2674 case opt_expand_bool:
2675 sprintf(CS name2, "*expand_%.50s", name);
2676 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2679 s = *USS (US options_block + ol2->v.offset);
2681 s = *USS ol2->v.value;
2684 if (!no_labels) printf("%s = ", name);
2685 printf("%s\n", string_printing(s));
2688 /* s == NULL => string not set; fall through */
2694 case opt_bool_verify:
2696 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2700 ol->v.fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2708 /*************************************************
2709 * Print value from main configuration *
2710 *************************************************/
2712 /* This function, called as a result of encountering the -bP option,
2713 causes the value of any main configuration variable to be output if the
2714 second argument is NULL. There are some special values:
2716 all print all main configuration options
2717 config_file print the name of the configuration file
2718 (configure_file will still work, for backward
2720 routers print the routers' configurations
2721 transports print the transports' configuration
2722 authenticators print the authenticators' configuration
2723 macros print the macros' configuration
2724 router_list print a list of router names
2725 transport_list print a list of transport names
2726 authenticator_list print a list of authentication mechanism names
2727 macro_list print a list of macro names
2728 +name print a named list item
2729 local_scan print the local_scan options
2730 config print the configuration as it is parsed
2731 environment print the used execution environment
2733 If the second argument is not NULL, it must be one of "router", "transport",
2734 "authenticator" or "macro" in which case the first argument identifies the
2735 driver whose options are to be printed.
2738 name option name if type == NULL; else driver name
2739 type NULL or driver type name, as described above
2740 no_labels avoid the "foo = " at the start of an item
2742 Returns: Boolean success
2746 readconf_print(const uschar *name, uschar *type, BOOL no_labels)
2748 BOOL names_only = FALSE;
2749 optionlist *ol2 = NULL;
2750 driver_instance *d = NULL;
2759 static uschar *types[] = { US"address", US"domain", US"host",
2761 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2762 &hostlist_anchor, &localpartlist_anchor };
2764 for (int i = 0; i < 4; i++)
2765 if ((t = tree_search(*(anchors[i]), name+1)))
2767 namedlist_block * nb = t->data.ptr;
2768 const uschar * s = nb->hide ? hidden : nb->string;
2771 printf("%s\n", CCS s);
2773 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2777 printf("no address, domain, host, or local part list called \"%s\" "
2778 "exists\n", name+1);
2783 if ( Ustrcmp(name, "configure_file") == 0
2784 || Ustrcmp(name, "config_file") == 0)
2786 printf("%s\n", CS config_main_filename);
2790 if (Ustrcmp(name, "all") == 0)
2792 for (optionlist * ol = optionlist_config;
2793 ol < optionlist_config + nelem(optionlist_config); ol++)
2794 if (!(ol->type & opt_hidden))
2795 (void) print_ol(ol, US ol->name, NULL,
2796 optionlist_config, nelem(optionlist_config),
2801 if (Ustrcmp(name, "local_scan") == 0)
2803 #ifndef LOCAL_SCAN_HAS_OPTIONS
2804 printf("local_scan() options are not supported\n");
2807 for (optionlist * ol = local_scan_options;
2808 ol < local_scan_options + local_scan_options_count; ol++)
2809 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2810 local_scan_options_count, no_labels);
2815 if (Ustrcmp(name, "config") == 0)
2817 print_config(f.admin_user, no_labels);
2821 if (Ustrcmp(name, "routers") == 0)
2826 else if (Ustrcmp(name, "transports") == 0)
2828 type = US"transport";
2831 else if (Ustrcmp(name, "authenticators") == 0)
2833 type = US"authenticator";
2836 else if (Ustrcmp(name, "macros") == 0)
2841 else if (Ustrcmp(name, "router_list") == 0)
2847 else if (Ustrcmp(name, "transport_list") == 0)
2849 type = US"transport";
2853 else if (Ustrcmp(name, "authenticator_list") == 0)
2855 type = US"authenticator";
2859 else if (Ustrcmp(name, "macro_list") == 0)
2865 else if (Ustrcmp(name, "environment") == 0)
2870 for (p = USS environ; *p; p++) ;
2871 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2873 for (p = USS environ; *p; p++)
2876 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2884 return print_ol(find_option(name,
2885 optionlist_config, nelem(optionlist_config)),
2886 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2889 /* Handle the options for a router or transport. Skip options that are flagged
2890 as hidden. Some of these are options with names starting with '*', used for
2891 internal alternative representations of other options (which the printing
2892 function will sort out). Others are synonyms kept for backward compatibility.
2895 if (Ustrcmp(type, "router") == 0)
2897 d = (driver_instance *)routers;
2898 ol2 = optionlist_routers;
2899 size = optionlist_routers_size;
2901 else if (Ustrcmp(type, "transport") == 0)
2903 d = (driver_instance *)transports;
2904 ol2 = optionlist_transports;
2905 size = optionlist_transports_size;
2907 else if (Ustrcmp(type, "authenticator") == 0)
2909 d = (driver_instance *)auths;
2910 ol2 = optionlist_auths;
2911 size = optionlist_auths_size;
2914 else if (Ustrcmp(type, "macro") == 0)
2916 /* People store passwords in macros and they were previously not available
2917 for printing. So we have an admin_users restriction. */
2920 fprintf(stderr, "exim: permission denied\n");
2923 for (macro_item * m = macros; m; m = m->next)
2924 if (!name || Ustrcmp(name, m->name) == 0)
2927 printf("%s\n", CS m->name);
2929 printf("%s\n", CS m->replacement);
2931 printf("%s=%s\n", CS m->name, CS m->replacement);
2935 if (!name) return TRUE;
2937 printf("%s %s not found\n", type, name);
2943 for (; d; d = d->next) printf("%s\n", CS d->name);
2947 /* Either search for a given driver, or print all of them */
2949 for (; d; d = d->next)
2953 printf("\n%s %s:\n", d->name, type);
2954 else if (Ustrcmp(d->name, name) != 0) continue;
2956 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2957 if (!(ol->type & opt_hidden))
2958 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2960 for (optionlist * ol = d->info->options;
2961 ol < d->info->options + *(d->info->options_count); ol++)
2962 if (!(ol->type & opt_hidden))
2963 rc |= print_ol(ol, US ol->name, d, d->info->options,
2964 *d->info->options_count, no_labels);
2966 if (name) return rc;
2968 if (!name) return TRUE;
2970 printf("%s %s not found\n", type, name);
2976 /*************************************************
2977 * Read a named list item *
2978 *************************************************/
2980 /* This function reads a name and a list (i.e. string). The name is used to
2981 save the list in a tree, sorted by its name. Each entry also has a number,
2982 which can be used for caching tests, but if the string contains any expansion
2983 items other than $key, the number is set negative to inhibit caching. This
2984 mechanism is used for domain, host, and address lists that are referenced by
2988 anchorp points to the tree anchor
2989 numberp points to the current number for this tree
2990 max the maximum number permitted
2991 s the text of the option line, starting immediately after the name
2993 tname the name of the list type, for messages
2994 hide do not output value on "-bP"
3000 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3001 uschar *tname, BOOL hide)
3003 BOOL forcecache = FALSE;
3006 namedlist_block * nb = store_get_perm(sizeof(namedlist_block), FALSE);
3008 if (Ustrncmp(s, "_cache", 6) == 0)
3015 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3017 if (*numberp >= max)
3018 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3021 Uskip_whitespace(&s);
3023 while (isalnum(*s) || *s == '_') s++;
3024 t = store_get(sizeof(tree_node) + s-ss, ss);
3025 Ustrncpy(t->name, ss, s-ss);
3027 Uskip_whitespace(&s);
3029 if (!tree_insertnode(anchorp, t))
3030 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3031 "duplicate name \"%s\" for a named %s", t->name, tname);
3034 nb->number = *numberp;
3038 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3039 "missing '=' after \"%s\"", t->name);
3040 Uskip_whitespace(&s);
3041 nb->string = read_string(s, t->name);
3042 nb->cache_data = NULL;
3044 /* Check the string for any expansions; if any are found, mark this list
3045 uncacheable unless the user has explicited forced caching. */
3047 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3053 /*************************************************
3054 * Unpick data for a rate limit *
3055 *************************************************/
3057 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3061 s string, in the form t,b,f,l
3062 where t is the threshold (integer)
3063 b is the initial delay (time)
3064 f is the multiplicative factor (fixed point)
3065 k is the maximum time (time)
3066 threshold where to store threshold
3067 base where to store base in milliseconds
3068 factor where to store factor in milliseconds
3069 limit where to store limit
3071 Returns: nothing (panics on error)
3075 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3078 uschar bstring[16], lstring[16];
3080 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3081 factor, lstring) == 4)
3083 *base = readconf_readtime(bstring, 0, TRUE);
3084 *limit = readconf_readtime(lstring, 0, TRUE);
3085 if (*base >= 0 && *limit >= 0) return;
3087 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3093 /*************************************************
3094 * Read main configuration options *
3095 *************************************************/
3097 /* This function is the first to be called for configuration reading. It
3098 opens the configuration file and reads general configuration settings until
3099 it reaches the end of the configuration section. The file is then left open so
3100 that the remaining configuration data can subsequently be read if needed for
3103 The configuration file must be owned either by root or exim, and be writeable
3104 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3105 in the config file, so the test is done on the compiled in values. A slight
3106 anomaly, to be carefully documented.
3108 The name of the configuration file is taken from a list that is included in the
3109 binary of Exim. It can be altered from the command line, but if that is done,
3110 root privilege is immediately withdrawn unless the caller is root or exim.
3111 The first file on the list that exists is used.
3113 For use on multiple systems that share file systems, first look for a
3114 configuration file whose name has the current node name on the end. If that is
3115 not found, try the generic name. For really contorted configurations, that run
3116 multiple Exims with different uid settings, first try adding the effective uid
3117 before the node name. These complications are going to waste resources on most
3118 systems. Therefore they are available only when requested by compile-time
3122 readconf_main(BOOL nowarn)
3125 struct stat statbuf;
3126 uschar *s, *filename;
3127 const uschar *list = config_main_filelist;
3129 /* Loop through the possible file names */
3131 /* Should never be a tainted list */
3132 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3135 /* Cut out all the fancy processing unless specifically wanted */
3137 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3138 uschar *suffix = filename + Ustrlen(filename);
3140 /* Try for the node-specific file if a node name exists */
3142 # ifdef CONFIGURE_FILE_USE_NODE
3144 if (uname(&uts) >= 0)
3146 # ifdef CONFIGURE_FILE_USE_EUID
3147 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3148 if (!(config_file = Ufopen(filename, "rb")))
3149 # endif /* CONFIGURE_FILE_USE_EUID */
3151 sprintf(CS suffix, ".%.256s", uts.nodename);
3152 config_file = Ufopen(filename, "rb");
3155 # endif /* CONFIGURE_FILE_USE_NODE */
3157 /* Otherwise, try the generic name, possibly with the euid added */
3159 # ifdef CONFIGURE_FILE_USE_EUID
3162 sprintf(CS suffix, ".%ld", (long int)original_euid);
3163 config_file = Ufopen(filename, "rb");
3165 # endif /* CONFIGURE_FILE_USE_EUID */
3167 /* Finally, try the unadorned name */
3172 config_file = Ufopen(filename, "rb");
3174 #else /* if neither defined */
3176 /* This is the common case when the fancy processing is not included. */
3178 config_file = Ufopen(filename, "rb");
3181 /* If the file does not exist, continue to try any others. For any other
3182 error, break out (and die). */
3184 if (config_file || errno != ENOENT) break;
3187 /* On success, save the name for verification; config_filename is used when
3188 logging configuration errors (it changes for .included files) whereas
3189 config_main_filename is the name shown by -bP. Failure to open a configuration
3190 file is a serious disaster. */
3194 uschar *last_slash = Ustrrchr(filename, '/');
3195 config_filename = config_main_filename = string_copy(filename);
3197 /* The config_main_directory we need for the $config_dir expansion.
3198 config_main_filename we need for $config_file expansion.
3199 And config_dir is the directory of the current configuration, used for
3200 relative .includes. We do need to know it's name, as we change our working
3203 if (filename[0] == '/')
3204 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3207 /* relative configuration file name: working dir + / + basename(filename) */
3209 uschar buf[PATH_MAX];
3212 if (os_getcwd(buf, PATH_MAX) == NULL)
3214 perror("exim: getcwd");
3217 g = string_cat(NULL, buf);
3219 /* If the dir does not end with a "/", append one */
3220 if (g->s[g->ptr-1] != '/')
3221 g = string_catn(g, US"/", 1);
3223 /* If the config file contains a "/", extract the directory part */
3225 g = string_catn(g, filename, last_slash - filename);
3227 config_main_directory = string_from_gstring(g);
3229 config_directory = config_main_directory;
3233 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3234 "%s", config_main_filelist);
3236 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3237 string_open_failed("configuration file %s", filename));
3239 /* Now, once we found and opened our configuration file, we change the directory
3240 to a safe place. Later we change to $spool_directory. */
3242 if (Uchdir("/") < 0)
3244 perror("exim: chdir `/': ");
3248 /* Check the status of the file we have opened, if we have retained root
3249 privileges and the file isn't /dev/null (which *should* be 0666). */
3251 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3253 if (fstat(fileno(config_file), &statbuf) != 0)
3254 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3257 if ( statbuf.st_uid != root_uid /* owner not root */
3258 #ifdef CONFIGURE_OWNER
3259 && statbuf.st_uid != config_uid /* owner not the special one */
3262 statbuf.st_gid != root_gid /* group not root & */
3263 #ifdef CONFIGURE_GROUP
3264 && statbuf.st_gid != config_gid /* group not the special one */
3266 && (statbuf.st_mode & 020) != 0 /* group writeable */
3268 (statbuf.st_mode & 2) != 0 /* world writeable */
3270 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3271 "wrong owner, group, or mode", big_buffer);
3273 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3274 This assumes we will need this much storage to handle all the allocations
3275 during startup; it won't help when .include is being used. When it does, it
3276 will cut down on the number of store blocks (and malloc calls, and sbrk
3277 syscalls). It also assume we're on the relevant pool. */
3279 if (statbuf.st_size > 8192)
3281 rmark r = store_mark();
3282 void * dummy = store_get((int)statbuf.st_size, GET_UNTAINTED);
3287 /* Process the main configuration settings. They all begin with a lower case
3288 letter. If we see something starting with an upper case letter, it is taken as
3289 a macro definition. */
3291 while ((s = get_config_line()))
3296 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3298 "found unexpected BOM (Byte Order Mark)");
3302 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE);
3306 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3308 if (Ustrncmp(t, "domainlist", 10) == 0)
3309 read_named_list(&domainlist_anchor, &domainlist_count,
3310 MAX_NAMED_LIST, t+10, US"domain list", hide);
3312 else if (Ustrncmp(t, "hostlist", 8) == 0)
3313 read_named_list(&hostlist_anchor, &hostlist_count,
3314 MAX_NAMED_LIST, t+8, US"host list", hide);
3316 else if (Ustrncmp(t, "addresslist", 11) == 0)
3317 read_named_list(&addresslist_anchor, &addresslist_count,
3318 MAX_NAMED_LIST, t+11, US"address list", hide);
3320 else if (Ustrncmp(t, "localpartlist", 13) == 0)
3321 read_named_list(&localpartlist_anchor, &localpartlist_count,
3322 MAX_NAMED_LIST, t+13, US"local part list", hide);
3325 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3326 NULL, US"main option \"%s\" unknown");
3330 /* If local_sender_retain is set, local_from_check must be unset. */
3332 if (local_sender_retain && local_from_check)
3333 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3334 "local_sender_retain are set; this combination is not allowed");
3336 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3339 if (timezone_string && !*timezone_string) timezone_string = NULL;
3341 /* The max retry interval must not be greater than 24 hours. */
3343 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3345 /* remote_max_parallel must be > 0 */
3347 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3349 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3350 start of a new SMTP message. */
3352 freeze_tell_config = freeze_tell;
3354 /* The primary host name may be required for expansion of spool_directory
3355 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3356 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3357 canonize it. Some people like upper case letters in their host names, so we
3358 don't force the case. */
3360 if (!primary_hostname)
3362 const uschar * hostname;
3365 if (uname(&uts) < 0)
3366 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3367 hostname = US uts.nodename;
3369 if (Ustrchr(hostname, '.') == NULL)
3372 struct hostent *hostdata;
3376 && ( !dns_ipv4_lookup
3377 || match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3378 MCL_DOMAIN, TRUE, NULL) != OK))
3385 # if HAVE_GETIPNODEBYNAME
3387 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3389 hostdata = gethostbyname2(CS hostname, af);
3392 hostdata = gethostbyname(CS hostname);
3396 { hostname = US hostdata->h_name; break; }
3398 if (af == AF_INET) break;
3403 primary_hostname = string_copy(hostname);
3406 /* Set up default value for smtp_active_hostname */
3408 smtp_active_hostname = primary_hostname;
3410 /* If spool_directory wasn't set in the build-time configuration, it must have
3411 got set above. Of course, writing to the log may not work if log_file_path is
3412 not set, but it will at least get to syslog or somewhere, with any luck. */
3414 if (!*spool_directory)
3415 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3418 /* Expand the spool directory name; it may, for example, contain the primary
3419 host name. Same comment about failure. */
3421 if (!(s = expand_string(spool_directory)))
3422 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3423 "\"%s\": %s", spool_directory, expand_string_message);
3424 spool_directory = s;
3426 /* Expand log_file_path, which must contain "%s" in any component that isn't
3427 the null string or "syslog". It is also allowed to contain one instance of %D
3428 or %M. However, it must NOT contain % followed by anything else. */
3432 const uschar *ss, *sss;
3433 int sep = ':'; /* Fixed for log file path */
3434 if (!(s = expand_string(log_file_path)))
3435 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3436 "\"%s\": %s", log_file_path, expand_string_message);
3439 /* should never be a tainted list */
3440 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3443 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3444 if (!(t = Ustrstr(sss, "%s")))
3445 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3446 "contain \"%%s\"", sss);
3448 if ((t = Ustrchr(sss, '%')))
3449 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3450 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3451 "unexpected \"%%\" character", s);
3457 /* Interpret syslog_facility into an integer argument for 'ident' param to
3458 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3461 if (syslog_facility_str)
3464 uschar *s = syslog_facility_str;
3466 if ((Ustrlen(syslog_facility_str) >= 4) &&
3467 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3470 for (i = 0; i < syslog_list_size; i++)
3471 if (strcmpic(s, syslog_list[i].name) == 0)
3473 syslog_facility = syslog_list[i].value;
3477 if (i >= syslog_list_size)
3478 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3479 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3482 /* Expand pid_file_path */
3486 if (!(s = expand_string(pid_file_path)))
3487 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3488 "\"%s\": %s", pid_file_path, expand_string_message);
3492 /* Set default value of process_log_path */
3494 if (!process_log_path || !*process_log_path)
3495 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3497 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3500 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3502 /* Unpick the SMTP rate limiting options, if set */
3504 if (smtp_ratelimit_mail)
3505 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3506 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3508 if (smtp_ratelimit_rcpt)
3509 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3510 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3512 /* The qualify domains default to the primary host name */
3514 if (!qualify_domain_sender)
3515 qualify_domain_sender = primary_hostname;
3516 if (!qualify_domain_recipient)
3517 qualify_domain_recipient = qualify_domain_sender;
3519 /* Setting system_filter_user in the configuration sets the gid as well if a
3520 name is given, but a numerical value does not. */
3522 if (system_filter_uid_set && !system_filter_gid_set)
3524 struct passwd *pw = getpwuid(system_filter_uid);
3526 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3527 (long int)system_filter_uid);
3528 system_filter_gid = pw->pw_gid;
3529 system_filter_gid_set = TRUE;
3532 /* If the errors_reply_to field is set, check that it is syntactically valid
3533 and ensure it contains a domain. */
3535 if (errors_reply_to)
3538 int start, end, domain;
3539 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3540 &start, &end, &domain, FALSE);
3543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3544 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3547 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3548 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3551 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3552 smtp_accept_max must also be set. */
3554 if (smtp_accept_max == 0 && (smtp_accept_queue > 0 || smtp_accept_max_per_host))
3555 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3556 "smtp_accept_max must be set if smtp_accept_queue or "
3557 "smtp_accept_max_per_host is set");
3559 /* Set up the host number if anything is specified. It is an expanded string
3560 so that it can be computed from the host name, for example. We do this last
3561 so as to ensure that everything else is set up before the expansion. */
3563 if (host_number_string)
3567 uschar *s = expand_string(host_number_string);
3570 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3571 "failed to expand localhost_number \"%s\": %s",
3572 host_number_string, expand_string_message);
3573 n = Ustrtol(s, &end, 0);
3574 while (isspace(*end)) end++;
3576 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3577 "localhost_number value is not a number: %s", s);
3578 if (n > LOCALHOST_MAX)
3579 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3580 "localhost_number is greater than the maximum allowed value (%d)",
3586 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3588 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3590 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3591 tls_verify_hosts ? "" : "try_");
3593 /* Magic number: at time of writing, 1024 has been the long-standing value
3594 used by so many clients, and what Exim used to use always, that it makes
3595 sense to just min-clamp this max-clamp at that. */
3596 if (tls_dh_max_bits < 1024)
3597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3598 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3600 /* If openssl_options is set, validate it */
3601 if (openssl_options)
3604 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3605 "openssl_options is set but we're using GnuTLS");
3608 if (!tls_openssl_options_parse(openssl_options, &dummy))
3609 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3610 "openssl_options parse error: %s", openssl_options);
3613 #endif /*DISABLE_TLS*/
3615 if (!nowarn && !keep_environment && environ && *environ)
3616 log_write(0, LOG_MAIN,
3617 "Warning: purging the environment.\n"
3618 " Suggested action: use keep_environment.");
3623 /*************************************************
3624 * Initialize one driver *
3625 *************************************************/
3627 /* This is called once the driver's generic options, if any, have been read.
3628 We can now find the driver, set up defaults for the private options, and
3629 unset any "set" bits in the private options table (which might have been
3630 set by another incarnation of the same driver).
3633 d pointer to driver instance block, with generic
3635 drivers_available vector of available drivers
3636 size_of_info size of each block in drivers_available
3637 class class of driver, for error message
3639 Returns: pointer to the driver info block
3642 static driver_info *
3643 init_driver(driver_instance *d, driver_info *drivers_available,
3644 int size_of_info, uschar *class)
3646 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3647 dd = (driver_info *)((US dd) + size_of_info))
3648 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3650 int len = dd->options_len;
3652 d->options_block = store_get_perm(len, FALSE);
3653 memcpy(d->options_block, dd->options_block, len);
3654 for (int i = 0; i < *(dd->options_count); i++)
3655 dd->options[i].type &= ~opt_set;
3659 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3660 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3662 return NULL; /* never obeyed */
3669 driver_init_fini(driver_instance * d, const uschar * class)
3671 if (!d->driver_name)
3672 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3673 "no driver defined for %s \"%s\"", class, d->name);
3678 /*************************************************
3679 * Initialize driver list *
3680 *************************************************/
3682 /* This function is called for routers, transports, and authentication
3683 mechanisms. It reads the data from the current point in the configuration file
3684 up to the end of the section, and sets up a chain of instance blocks according
3685 to the file's contents. The file will already have been opened by a call to
3686 readconf_main, and must be left open for subsequent reading of further data.
3688 Any errors cause a panic crash. Note that the blocks with names driver_info and
3689 driver_instance must map the first portions of all the _info and _instance
3690 blocks for this shared code to work.
3693 class "router", "transport", or "authenticator"
3694 anchor &routers, &transports, &auths
3695 drivers_available available drivers
3696 size_of_info size of each info block
3697 instance_default points to default data for an instance
3698 instance_size size of instance block
3699 driver_optionlist generic option list
3700 driver_optionlist_count count of generic option list
3706 readconf_driver_init(
3708 driver_instance **anchor,
3709 driver_info *drivers_available,
3711 void *instance_default,
3713 optionlist *driver_optionlist,
3714 int driver_optionlist_count)
3716 driver_instance **p = anchor;
3717 driver_instance *d = NULL;
3720 while ((buffer = get_config_line()))
3722 uschar name[EXIM_DRIVERNAME_MAX];
3725 /* Read the first name on the line and test for the start of a new driver. A
3726 macro definition indicates the end of the previous driver. If this isn't the
3727 start of a new driver, the line will be re-read. */
3729 s = readconf_readname(name, sizeof(name), buffer);
3731 /* Handle macro definition, first finishing off the initialization of the
3732 previous driver, if any. */
3734 if (isupper(*name) && *s == '=')
3738 /* s is using big_buffer, so this call had better not */
3739 driver_init_fini(d, class);
3742 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE);
3746 /* If the line starts with a name terminated by a colon, we are at the
3747 start of the definition of a new driver. The rest of the line must be
3752 /* Finish off initializing the previous driver. */
3755 driver_init_fini(d, class);
3757 /* Check that we haven't already got a driver of this name */
3759 for (d = *anchor; d; d = d->next)
3760 if (Ustrcmp(name, d->name) == 0)
3761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3762 "there are two %ss called \"%s\"", class, name);
3764 /* Set up a new driver instance data block on the chain, with
3765 its default values installed. */
3767 d = store_get_perm(instance_size, FALSE);
3768 memcpy(d, instance_default, instance_size);
3771 d->name = string_copy(name);
3772 d->srcfile = config_filename;
3773 d->srcline = config_lineno;
3775 /* Clear out the "set" bits in the generic options */
3777 for (int i = 0; i < driver_optionlist_count; i++)
3778 driver_optionlist[i].type &= ~opt_set;
3780 /* Check nothing more on this line, then do the next loop iteration. */
3782 Uskip_whitespace(&s);
3783 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3787 /* Not the start of a new driver. Give an error if we have not set up a
3788 current driver yet. */
3791 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3793 /* First look to see if this is a generic option; if it is "driver",
3794 initialize the driver. If is it not a generic option, we can look for a
3795 private option provided that the driver has been previously set up. */
3797 if (readconf_handle_option(buffer, driver_optionlist,
3798 driver_optionlist_count, d, NULL))
3800 if (!d->info && d->driver_name)
3801 init_driver(d, drivers_available, size_of_info, class);
3804 /* Handle private options - pass the generic block because some may
3805 live therein. A flag with each option indicates if it is in the public
3809 readconf_handle_option(buffer, d->info->options,
3810 *(d->info->options_count), d, US"option \"%s\" unknown");
3812 /* The option is not generic and the driver name has not yet been given. */
3814 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3815 "(\"driver\" must be specified before any private options)", name);
3818 /* Run the initialization function for the final driver. */
3821 driver_init_fini(d, class);
3826 /*************************************************
3827 * Check driver dependency *
3828 *************************************************/
3830 /* This function is passed a driver instance and a string. It checks whether
3831 any of the string options for the driver contains the given string as an
3835 d points to a driver instance block
3836 s the string to search for
3838 Returns: TRUE if a dependency is found
3842 readconf_depends(driver_instance *d, uschar *s)
3844 int count = *(d->info->options_count);
3847 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3848 if ((ol->type & opt_mask) == opt_stringptr)
3850 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3851 uschar * value = *USS(US options_block + ol->v.offset);
3853 if (value && (ss = Ustrstr(value, s)) != NULL)
3855 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3856 isalnum(ss[Ustrlen(s)])) continue;
3857 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3858 d->name, ol->name, s);
3863 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3870 /*************************************************
3871 * Decode an error type for retries *
3872 *************************************************/
3874 /* This function is global because it is also called from the main
3875 program when testing retry information. It decodes strings such as "quota_7d"
3876 into numerical error codes.
3879 pp points to start of text
3880 p points past end of text
3881 basic_errno points to an int to receive the main error number
3882 more_errno points to an int to receive the secondary error data
3884 Returns: NULL if decoded correctly; else points to error text
3888 readconf_retry_error(const uschar *pp, const uschar *p,
3889 int *basic_errno, int *more_errno)
3892 const uschar *q = pp;
3893 while (q < p && *q != '_') q++;
3896 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3898 *basic_errno = ERRNO_EXIMQUOTA;
3899 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3900 return US"bad time value";
3903 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3905 *basic_errno = ECONNREFUSED;
3908 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3909 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3910 else return US"A or MX expected after \"refused\"";
3914 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3916 *basic_errno = ETIMEDOUT;
3920 int xlen = p - q - 1;
3921 const uschar *x = q + 1;
3923 static uschar *extras[] =
3924 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3925 static int values[] =
3926 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3928 for (i = 0; i < nelem(extras); i++)
3929 if (strncmpic(x, extras[i], xlen) == 0)
3931 *more_errno = values[i];
3935 if (i >= nelem(extras))
3936 if (strncmpic(x, US"DNS", xlen) == 0)
3937 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3938 "available in retry rules (it has never worked) - treated as "
3941 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3945 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3946 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3947 strncmpic(pp, US"data_4", 6) == 0)
3950 int x = 255; /* means "any 4xx code" */
3951 if (p != pp + 8) bad = TRUE; else
3953 int a = pp[6], b = pp[7];
3957 if (isdigit(b)) x += b - '0';
3958 else if (b == 'x') x += 100;
3961 else if (a != 'x' || b != 'x') bad = TRUE;
3965 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3966 "x is literal and d is any digit", pp);
3968 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3969 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3970 *more_errno = x << 8;
3973 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3974 strncmpic(q+1, US"failed", p-q-1) == 0)
3975 *basic_errno = ERRNO_AUTHFAIL;
3977 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3978 *basic_errno = ERRNO_SMTPCLOSED;
3980 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3981 *basic_errno = ERRNO_TLSREQUIRED;
3983 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3984 *basic_errno = ERRNO_UNKNOWNHOST;
3986 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3987 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3995 /*************************************************
3996 * Read retry information *
3997 *************************************************/
3999 /* Each line of retry information contains:
4001 . A domain name pattern or an address pattern;
4003 . An error name, possibly with additional data, or *;
4005 . An optional sequence of retry items, each consisting of an identifying
4006 letter, a cutoff time, and optional parameters.
4008 All this is decoded and placed into a control block. */
4011 /* Subroutine to read an argument, preceded by a comma and terminated
4012 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4013 1 = fixed point number (returned *1000).
4016 paddr pointer to pointer to current character; updated
4017 type 0 => read a time; 1 => read a fixed point number
4019 Returns: time in seconds or fixed point number * 1000
4023 retry_arg(const uschar **paddr, int type)
4025 const uschar *p = *paddr;
4028 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4030 Uskip_whitespace(&p);
4032 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4034 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4035 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4040 case 0: return readconf_readtime(pp, *p, FALSE);
4041 case 1: return readconf_readfixed(pp, *p);
4043 return 0; /* Keep picky compilers happy */
4046 /* The function proper */
4049 readconf_retries(void)
4051 retry_config **chain = &retries;
4055 while ((p = get_config_line()))
4057 retry_rule **rchain;
4061 next = store_get(sizeof(retry_config), GET_UNTAINTED);
4064 chain = &(next->next);
4065 next->basic_errno = next->more_errno = 0;
4066 next->senders = NULL;
4068 rchain = &(next->rules);
4070 next->pattern = string_dequote(&p);
4071 Uskip_whitespace(&p);
4073 while (mac_isgraph(*p)) p++;
4074 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4075 "missing error type in retry rule");
4077 /* Test error names for things we understand. */
4079 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4080 &next->more_errno)))
4081 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4083 /* There may be an optional address list of senders to be used as another
4084 constraint on the rule. This was added later, so the syntax is a bit of a
4085 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4088 Uskip_whitespace(&p);
4089 if (Ustrncmp(p, "senders", 7) == 0)
4092 Uskip_whitespace(&p);
4093 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4094 "\"=\" expected after \"senders\" in retry rule");
4095 Uskip_whitespace(&p);
4096 next->senders = string_dequote(&p);
4099 /* Now the retry rules. Keep the maximum timeout encountered. */
4101 Uskip_whitespace(&p);
4105 retry_rule * rule = store_get(sizeof(retry_rule), GET_UNTAINTED);
4107 rchain = &(rule->next);
4109 rule->rule = toupper(*p++);
4110 rule->timeout = retry_arg(&p, 0);
4111 if (rule->timeout > retry_maximum_timeout)
4112 retry_maximum_timeout = rule->timeout;
4116 case 'F': /* Fixed interval */
4117 rule->p1 = retry_arg(&p, 0);
4120 case 'G': /* Geometrically increasing intervals */
4121 case 'H': /* Ditto, but with randomness */
4122 rule->p1 = retry_arg(&p, 0);
4123 rule->p2 = retry_arg(&p, 1);
4127 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4131 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4132 (rule->rule != 'F' && rule->p2 < 1000))
4133 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4134 "bad parameters for retry rule");
4136 if (Uskip_whitespace(&p) == ';')
4139 Uskip_whitespace(&p);
4142 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4149 /*************************************************
4150 * Initialize authenticators *
4151 *************************************************/
4153 /* Read the authenticators section of the configuration file.
4162 #ifndef DISABLE_PIPE_CONNECT
4166 readconf_driver_init(US"authenticator",
4167 (driver_instance **)(&auths), /* chain anchor */
4168 (driver_info *)auths_available, /* available drivers */
4169 sizeof(auth_info), /* size of info block */
4170 &auth_defaults, /* default values for generic options */
4171 sizeof(auth_instance), /* size of instance block */
4172 optionlist_auths, /* generic options */
4173 optionlist_auths_size);
4175 for (auth_instance * au = auths; au; au = au->next)
4177 if (!au->public_name)
4178 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4179 "the %s authenticator", au->name);
4181 for (auth_instance * bu = au->next; bu; bu = bu->next)
4182 if (strcmpic(au->public_name, bu->public_name) == 0)
4183 if ( au->client && bu->client
4184 || au->server && bu->server)
4185 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4186 "(%s and %s) have the same public name (%s)",
4187 au->client && bu->client ? US"client" : US"server",
4188 au->name, bu->name, au->public_name);
4189 #ifndef DISABLE_PIPE_CONNECT
4193 #ifndef DISABLE_PIPE_CONNECT
4194 f.smtp_in_early_pipe_no_auth = nauths > 16;
4199 /* For error messages, a string describing the config location associated
4200 with current processing. NULL if we are not in an authenticator. */
4203 authenticator_current_name(void)
4205 if (!authenticator_name) return NULL;
4206 return string_sprintf(" (authenticator %s, %s %d)", authenticator_name, driver_srcfile, driver_srcline);
4213 /*************************************************
4214 * Read ACL information *
4215 *************************************************/
4217 /* If this run of Exim is not doing something that involves receiving a
4218 message, we can just skip over the ACL information. No need to parse it.
4220 First, we have a function for acl_read() to call back to get the next line. We
4221 need to remember the line we passed, because at the end it will contain the
4222 name of the next ACL. */
4224 static uschar *acl_line;
4229 acl_line = get_config_line();
4234 /* Now the main function:
4245 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4248 acl_line = get_config_line();
4252 uschar name[EXIM_DRIVERNAME_MAX];
4256 p = readconf_readname(name, sizeof(name), acl_line);
4257 if (isupper(*name) && *p == '=')
4259 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE);
4260 acl_line = get_config_line();
4264 if (*p != ':' || name[0] == 0)
4265 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4267 node = store_get_perm(sizeof(tree_node) + Ustrlen(name), name);
4268 Ustrcpy(node->name, name);
4269 if (!tree_insertnode(&acl_anchor, node))
4270 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4271 "there are two ACLs called \"%s\"", name);
4273 node->data.ptr = acl_read(acl_callback, &error);
4275 if (node->data.ptr == NULL && error != NULL)
4276 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4282 /*************************************************
4283 * Read configuration for local_scan() *
4284 *************************************************/
4286 /* This function is called after "begin local_scan" is encountered in the
4287 configuration file. If the local_scan() function allows for configuration
4288 options, we can process them. Otherwise, we expire in a panic.
4295 local_scan_init(void)
4297 #ifndef LOCAL_SCAN_HAS_OPTIONS
4298 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4299 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4303 while ((p = get_config_line()))
4304 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4305 NULL, US"local_scan option \"%s\" unknown");
4311 /*************************************************
4312 * Read rest of configuration (after main) *
4313 *************************************************/
4315 /* This function reads the rest of the runtime configuration, after the main
4316 configuration. It is called only when actually needed. Each subsequent section
4317 of the configuration starts with a line of the form
4321 where the name is "routers", "transports", etc. A section is terminated by
4322 hitting the next "begin" line, and the next name is left in next_section.
4323 Because it may confuse people as to whether the names are singular or plural,
4324 we add "s" if it's missing. There is always enough room in next_section for
4325 this. This function is basically just a switch.
4331 static uschar *section_list[] = {
4345 while(next_section[0] != 0)
4349 int last = nelem(section_list);
4351 int n = Ustrlen(next_section);
4353 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4357 int c = strcmpic(next_section, section_list[mid]);
4359 if (c > 0) first = mid + 1; else last = mid;
4361 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4362 "\"%.*s\" is not a known configuration section name", n, next_section);
4363 mid = (last + first)/2;
4367 if (((had ^= bit) & bit) == 0)
4368 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4369 "\"%.*s\" section is repeated in the configuration file", n,
4374 case 0: readconf_acl(); break;
4375 case 1: auths_init(); break;
4376 case 2: local_scan_init(); break;
4377 case 3: readconf_retries(); break;
4378 case 4: readconf_rewrites(); break;
4379 case 5: route_init(); break;
4380 case 6: transport_init(); break;
4384 (void)fclose(config_file);
4387 /* Init the storage for the pre-parsed config lines */
4389 readconf_save_config(const uschar *s)
4391 save_config_line(string_sprintf("# Exim Configuration (%s)",
4392 f.running_in_test_harness ? US"X" : s));
4396 save_config_position(const uschar *file, int line)
4398 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4401 /* Append a pre-parsed logical line to the config lines store,
4402 this operates on a global (static) list that holds all the pre-parsed
4403 config lines, we do no further processing here, output formatting and
4404 honouring of <hide> or macros will be done during output */
4407 save_config_line(const uschar* line)
4409 static config_line_item *current;
4410 config_line_item *next;
4412 next = (config_line_item*) store_get(sizeof(config_line_item), GET_UNTAINTED);
4413 next->line = string_copy(line);
4416 if (!config_lines) config_lines = next;
4417 else current->next = next;
4422 /* List the parsed config lines, care about nice formatting and
4423 hide the <hide> values unless we're the admin user */
4425 print_config(BOOL admin, BOOL terse)
4427 const int TS = terse ? 0 : 2;
4431 for (const config_line_item * i = config_lines; i; i = i->next)
4433 uschar * current, * p;
4435 if (r) store_reset(r);
4438 /* skip over to the first non-space */
4439 for (current = string_copy(i->line); *current && isspace(*current); ++current)
4445 /* Collapse runs of spaces. We stop this if we encounter one of the
4446 following characters: "'$, as this may indicate careful formatting */
4448 for (p = current; *p; p++) if (isspace(*p))
4451 if (*p != ' ') *p = ' ';
4453 for (next = p; isspace(*next); ++next)
4457 memmove(p+1, next, Ustrlen(next)+1);
4459 if (*next == '"' || *next == '\'' || *next == '$')
4464 if (current[0] == '#')
4467 /* begin lines are left aligned */
4468 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4470 if (!terse) puts("");
4475 /* router/acl/transport block names */
4476 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4478 if (!terse) puts("");
4479 printf("%*s%s\n", TS, "", current);
4483 /* hidden lines (all MACROS or lines prefixed with "hide") */
4485 && ( isupper(*current)
4486 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4490 if ((p = Ustrchr(current, '=')))
4493 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4495 /* e.g.: hide split_spool_directory */
4497 printf("%*s\n", indent, CCS hidden);
4501 /* rest is public */
4502 printf("%*s%s\n", indent, "", current);
4504 if (r) store_reset(r);
4507 #endif /*!MACRO_PREDEF*/
4510 /* End of readconf.c */