1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar
* syslog_facility_str
;
22 static void fn_smtp_receive_timeout(const uschar
*, const uschar
*);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config
[] = {
32 { "*set_exim_group", opt_bool
|opt_hidden
, &exim_gid_set
},
33 { "*set_exim_user", opt_bool
|opt_hidden
, &exim_uid_set
},
34 { "*set_system_filter_group", opt_bool
|opt_hidden
, &system_filter_gid_set
},
35 { "*set_system_filter_user", opt_bool
|opt_hidden
, &system_filter_uid_set
},
36 { "accept_8bitmime", opt_bool
, &accept_8bitmime
},
37 { "acl_not_smtp", opt_stringptr
, &acl_not_smtp
},
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr
, &acl_not_smtp_mime
},
41 { "acl_not_smtp_start", opt_stringptr
, &acl_not_smtp_start
},
42 { "acl_smtp_auth", opt_stringptr
, &acl_smtp_auth
},
43 { "acl_smtp_connect", opt_stringptr
, &acl_smtp_connect
},
44 { "acl_smtp_data", opt_stringptr
, &acl_smtp_data
},
46 { "acl_smtp_data_prdr", opt_stringptr
, &acl_smtp_data_prdr
},
49 { "acl_smtp_dkim", opt_stringptr
, &acl_smtp_dkim
},
51 { "acl_smtp_etrn", opt_stringptr
, &acl_smtp_etrn
},
52 { "acl_smtp_expn", opt_stringptr
, &acl_smtp_expn
},
53 { "acl_smtp_helo", opt_stringptr
, &acl_smtp_helo
},
54 { "acl_smtp_mail", opt_stringptr
, &acl_smtp_mail
},
55 { "acl_smtp_mailauth", opt_stringptr
, &acl_smtp_mailauth
},
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr
, &acl_smtp_mime
},
59 { "acl_smtp_notquit", opt_stringptr
, &acl_smtp_notquit
},
60 { "acl_smtp_predata", opt_stringptr
, &acl_smtp_predata
},
61 { "acl_smtp_quit", opt_stringptr
, &acl_smtp_quit
},
62 { "acl_smtp_rcpt", opt_stringptr
, &acl_smtp_rcpt
},
64 { "acl_smtp_starttls", opt_stringptr
, &acl_smtp_starttls
},
66 { "acl_smtp_vrfy", opt_stringptr
, &acl_smtp_vrfy
},
67 { "add_environment", opt_stringptr
, &add_environment
},
68 { "admin_groups", opt_gidlist
, &admin_groups
},
69 { "allow_domain_literals", opt_bool
, &allow_domain_literals
},
70 { "allow_mx_to_ip", opt_bool
, &allow_mx_to_ip
},
71 { "allow_utf8_domains", opt_bool
, &allow_utf8_domains
},
72 { "auth_advertise_hosts", opt_stringptr
, &auth_advertise_hosts
},
73 { "auto_thaw", opt_time
, &auto_thaw
},
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr
, &av_scanner
},
77 { "bi_command", opt_stringptr
, &bi_command
},
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr
, &bmi_config_file
},
81 { "bounce_message_file", opt_stringptr
, &bounce_message_file
},
82 { "bounce_message_text", opt_stringptr
, &bounce_message_text
},
83 { "bounce_return_body", opt_bool
, &bounce_return_body
},
84 { "bounce_return_linesize_limit", opt_mkint
, &bounce_return_linesize_limit
},
85 { "bounce_return_message", opt_bool
, &bounce_return_message
},
86 { "bounce_return_size_limit", opt_mkint
, &bounce_return_size_limit
},
87 { "bounce_sender_authentication",opt_stringptr
,&bounce_sender_authentication
},
88 { "callout_domain_negative_expire", opt_time
, &callout_cache_domain_negative_expire
},
89 { "callout_domain_positive_expire", opt_time
, &callout_cache_domain_positive_expire
},
90 { "callout_negative_expire", opt_time
, &callout_cache_negative_expire
},
91 { "callout_positive_expire", opt_time
, &callout_cache_positive_expire
},
92 { "callout_random_local_part",opt_stringptr
, &callout_random_local_part
},
93 { "check_log_inodes", opt_int
, &check_log_inodes
},
94 { "check_log_space", opt_Kint
, &check_log_space
},
95 { "check_rfc2047_length", opt_bool
, &check_rfc2047_length
},
96 { "check_spool_inodes", opt_int
, &check_spool_inodes
},
97 { "check_spool_space", opt_Kint
, &check_spool_space
},
98 { "chunking_advertise_hosts", opt_stringptr
, &chunking_advertise_hosts
},
99 { "commandline_checks_require_admin", opt_bool
,&commandline_checks_require_admin
},
100 { "daemon_smtp_port", opt_stringptr
|opt_hidden
, &daemon_smtp_port
},
101 { "daemon_smtp_ports", opt_stringptr
, &daemon_smtp_port
},
102 { "daemon_startup_retries", opt_int
, &daemon_startup_retries
},
103 { "daemon_startup_sleep", opt_time
, &daemon_startup_sleep
},
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool
, &dcc_direct_add_header
},
106 { "dccifd_address", opt_stringptr
, &dccifd_address
},
107 { "dccifd_options", opt_stringptr
, &dccifd_options
},
109 { "debug_store", opt_bool
, &debug_store
},
110 { "delay_warning", opt_timelist
, &delay_warning
},
111 { "delay_warning_condition", opt_stringptr
, &delay_warning_condition
},
112 { "deliver_drop_privilege", opt_bool
, &deliver_drop_privilege
},
113 { "deliver_queue_load_max", opt_fixed
, &deliver_queue_load_max
},
114 { "delivery_date_remove", opt_bool
, &delivery_date_remove
},
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool
, &disable_fsync
},
118 { "disable_ipv6", opt_bool
, &disable_ipv6
},
120 { "dkim_verify_signers", opt_stringptr
, &dkim_verify_signers
},
122 #ifdef EXPERIMENTAL_DMARC
123 { "dmarc_forensic_sender", opt_stringptr
, &dmarc_forensic_sender
},
124 { "dmarc_history_file", opt_stringptr
, &dmarc_history_file
},
125 { "dmarc_tld_file", opt_stringptr
, &dmarc_tld_file
},
127 { "dns_again_means_nonexist", opt_stringptr
, &dns_again_means_nonexist
},
128 { "dns_check_names_pattern", opt_stringptr
, &check_dns_names_pattern
},
129 { "dns_cname_loops", opt_int
, &dns_cname_loops
},
130 { "dns_csa_search_limit", opt_int
, &dns_csa_search_limit
},
131 { "dns_csa_use_reverse", opt_bool
, &dns_csa_use_reverse
},
132 { "dns_dnssec_ok", opt_int
, &dns_dnssec_ok
},
133 { "dns_ipv4_lookup", opt_stringptr
, &dns_ipv4_lookup
},
134 { "dns_retrans", opt_time
, &dns_retrans
},
135 { "dns_retry", opt_int
, &dns_retry
},
136 { "dns_trust_aa", opt_stringptr
, &dns_trust_aa
},
137 { "dns_use_edns0", opt_int
, &dns_use_edns0
},
138 /* This option is now a no-op, retained for compatibility */
139 { "drop_cr", opt_bool
, &drop_cr
},
140 /*********************************************************/
141 { "dsn_advertise_hosts", opt_stringptr
, &dsn_advertise_hosts
},
142 { "dsn_from", opt_stringptr
, &dsn_from
},
143 { "envelope_to_remove", opt_bool
, &envelope_to_remove
},
144 { "errors_copy", opt_stringptr
, &errors_copy
},
145 { "errors_reply_to", opt_stringptr
, &errors_reply_to
},
146 #ifndef DISABLE_EVENT
147 { "event_action", opt_stringptr
, &event_action
},
149 { "exim_group", opt_gid
, &exim_gid
},
150 { "exim_path", opt_stringptr
, &exim_path
},
151 { "exim_user", opt_uid
, &exim_uid
},
152 { "extra_local_interfaces", opt_stringptr
, &extra_local_interfaces
},
153 { "extract_addresses_remove_arguments", opt_bool
, &extract_addresses_remove_arguments
},
154 { "finduser_retries", opt_int
, &finduser_retries
},
155 { "freeze_tell", opt_stringptr
, &freeze_tell
},
156 { "gecos_name", opt_stringptr
, &gecos_name
},
157 { "gecos_pattern", opt_stringptr
, &gecos_pattern
},
159 { "gnutls_allow_auto_pkcs11", opt_bool
, &gnutls_allow_auto_pkcs11
},
160 { "gnutls_compat_mode", opt_bool
, &gnutls_compat_mode
},
162 { "header_line_maxsize", opt_int
, &header_line_maxsize
},
163 { "header_maxsize", opt_int
, &header_maxsize
},
164 { "headers_charset", opt_stringptr
, &headers_charset
},
165 { "helo_accept_junk_hosts", opt_stringptr
, &helo_accept_junk_hosts
},
166 { "helo_allow_chars", opt_stringptr
, &helo_allow_chars
},
167 { "helo_lookup_domains", opt_stringptr
, &helo_lookup_domains
},
168 { "helo_try_verify_hosts", opt_stringptr
, &helo_try_verify_hosts
},
169 { "helo_verify_hosts", opt_stringptr
, &helo_verify_hosts
},
170 { "hold_domains", opt_stringptr
, &hold_domains
},
171 { "host_lookup", opt_stringptr
, &host_lookup
},
172 { "host_lookup_order", opt_stringptr
, &host_lookup_order
},
173 { "host_reject_connection", opt_stringptr
, &host_reject_connection
},
174 { "hosts_connection_nolog", opt_stringptr
, &hosts_connection_nolog
},
176 { "hosts_proxy", opt_stringptr
, &hosts_proxy
},
178 { "hosts_treat_as_local", opt_stringptr
, &hosts_treat_as_local
},
180 { "ibase_servers", opt_stringptr
, &ibase_servers
},
182 { "ignore_bounce_errors_after", opt_time
, &ignore_bounce_errors_after
},
183 { "ignore_fromline_hosts", opt_stringptr
, &ignore_fromline_hosts
},
184 { "ignore_fromline_local", opt_bool
, &ignore_fromline_local
},
185 { "keep_environment", opt_stringptr
, &keep_environment
},
186 { "keep_malformed", opt_time
, &keep_malformed
},
188 { "ldap_ca_cert_dir", opt_stringptr
, &eldap_ca_cert_dir
},
189 { "ldap_ca_cert_file", opt_stringptr
, &eldap_ca_cert_file
},
190 { "ldap_cert_file", opt_stringptr
, &eldap_cert_file
},
191 { "ldap_cert_key", opt_stringptr
, &eldap_cert_key
},
192 { "ldap_cipher_suite", opt_stringptr
, &eldap_cipher_suite
},
193 { "ldap_default_servers", opt_stringptr
, &eldap_default_servers
},
194 { "ldap_require_cert", opt_stringptr
, &eldap_require_cert
},
195 { "ldap_start_tls", opt_bool
, &eldap_start_tls
},
196 { "ldap_version", opt_int
, &eldap_version
},
198 { "local_from_check", opt_bool
, &local_from_check
},
199 { "local_from_prefix", opt_stringptr
, &local_from_prefix
},
200 { "local_from_suffix", opt_stringptr
, &local_from_suffix
},
201 { "local_interfaces", opt_stringptr
, &local_interfaces
},
202 #ifdef HAVE_LOCAL_SCAN
203 { "local_scan_timeout", opt_time
, &local_scan_timeout
},
205 { "local_sender_retain", opt_bool
, &local_sender_retain
},
206 { "localhost_number", opt_stringptr
, &host_number_string
},
207 { "log_file_path", opt_stringptr
, &log_file_path
},
208 { "log_selector", opt_stringptr
, &log_selector_string
},
209 { "log_timezone", opt_bool
, &log_timezone
},
210 { "lookup_open_max", opt_int
, &lookup_open_max
},
211 { "max_username_length", opt_int
, &max_username_length
},
212 { "message_body_newlines", opt_bool
, &message_body_newlines
},
213 { "message_body_visible", opt_mkint
, &message_body_visible
},
214 { "message_id_header_domain", opt_stringptr
, &message_id_domain
},
215 { "message_id_header_text", opt_stringptr
, &message_id_text
},
216 { "message_logs", opt_bool
, &message_logs
},
217 { "message_size_limit", opt_stringptr
, &message_size_limit
},
218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
219 { "move_frozen_messages", opt_bool
, &move_frozen_messages
},
221 { "mua_wrapper", opt_bool
, &mua_wrapper
},
223 { "mysql_servers", opt_stringptr
, &mysql_servers
},
225 { "never_users", opt_uidlist
, &never_users
},
227 { "openssl_options", opt_stringptr
, &openssl_options
},
230 { "oracle_servers", opt_stringptr
, &oracle_servers
},
232 { "percent_hack_domains", opt_stringptr
, &percent_hack_domains
},
234 { "perl_at_start", opt_bool
, &opt_perl_at_start
},
235 { "perl_startup", opt_stringptr
, &opt_perl_startup
},
236 { "perl_taintmode", opt_bool
, &opt_perl_taintmode
},
239 { "pgsql_servers", opt_stringptr
, &pgsql_servers
},
241 { "pid_file_path", opt_stringptr
, &pid_file_path
},
242 { "pipelining_advertise_hosts", opt_stringptr
, &pipelining_advertise_hosts
},
243 #ifdef EXPERIMENTAL_PIPE_CONNECT
244 { "pipelining_connect_advertise_hosts", opt_stringptr
,
245 &pipe_connect_advertise_hosts
},
248 { "prdr_enable", opt_bool
, &prdr_enable
},
250 { "preserve_message_logs", opt_bool
, &preserve_message_logs
},
251 { "primary_hostname", opt_stringptr
, &primary_hostname
},
252 { "print_topbitchars", opt_bool
, &print_topbitchars
},
253 { "process_log_path", opt_stringptr
, &process_log_path
},
254 { "prod_requires_admin", opt_bool
, &prod_requires_admin
},
255 { "qualify_domain", opt_stringptr
, &qualify_domain_sender
},
256 { "qualify_recipient", opt_stringptr
, &qualify_domain_recipient
},
257 { "queue_domains", opt_stringptr
, &queue_domains
},
258 { "queue_list_requires_admin",opt_bool
, &queue_list_requires_admin
},
259 { "queue_only", opt_bool
, &queue_only
},
260 { "queue_only_file", opt_stringptr
, &queue_only_file
},
261 { "queue_only_load", opt_fixed
, &queue_only_load
},
262 { "queue_only_load_latch", opt_bool
, &queue_only_load_latch
},
263 { "queue_only_override", opt_bool
, &queue_only_override
},
264 { "queue_run_in_order", opt_bool
, &queue_run_in_order
},
265 { "queue_run_max", opt_stringptr
, &queue_run_max
},
266 { "queue_smtp_domains", opt_stringptr
, &queue_smtp_domains
},
267 { "receive_timeout", opt_time
, &receive_timeout
},
268 { "received_header_text", opt_stringptr
, &received_header_text
},
269 { "received_headers_max", opt_int
, &received_headers_max
},
270 { "recipient_unqualified_hosts", opt_stringptr
, &recipient_unqualified_hosts
},
271 { "recipients_max", opt_int
, &recipients_max
},
272 { "recipients_max_reject", opt_bool
, &recipients_max_reject
},
274 { "redis_servers", opt_stringptr
, &redis_servers
},
276 { "remote_max_parallel", opt_int
, &remote_max_parallel
},
277 { "remote_sort_domains", opt_stringptr
, &remote_sort_domains
},
278 { "retry_data_expire", opt_time
, &retry_data_expire
},
279 { "retry_interval_max", opt_time
, &retry_interval_max
},
280 { "return_path_remove", opt_bool
, &return_path_remove
},
281 { "return_size_limit", opt_mkint
|opt_hidden
, &bounce_return_size_limit
},
282 { "rfc1413_hosts", opt_stringptr
, &rfc1413_hosts
},
283 { "rfc1413_query_timeout", opt_time
, &rfc1413_query_timeout
},
284 { "sender_unqualified_hosts", opt_stringptr
, &sender_unqualified_hosts
},
285 { "slow_lookup_log", opt_int
, &slow_lookup_log
},
286 { "smtp_accept_keepalive", opt_bool
, &smtp_accept_keepalive
},
287 { "smtp_accept_max", opt_int
, &smtp_accept_max
},
288 { "smtp_accept_max_nonmail", opt_int
, &smtp_accept_max_nonmail
},
289 { "smtp_accept_max_nonmail_hosts", opt_stringptr
, &smtp_accept_max_nonmail_hosts
},
290 { "smtp_accept_max_per_connection", opt_int
, &smtp_accept_max_per_connection
},
291 { "smtp_accept_max_per_host", opt_stringptr
, &smtp_accept_max_per_host
},
292 { "smtp_accept_queue", opt_int
, &smtp_accept_queue
},
293 { "smtp_accept_queue_per_connection", opt_int
, &smtp_accept_queue_per_connection
},
294 { "smtp_accept_reserve", opt_int
, &smtp_accept_reserve
},
295 { "smtp_active_hostname", opt_stringptr
, &raw_active_hostname
},
296 { "smtp_banner", opt_stringptr
, &smtp_banner
},
297 { "smtp_check_spool_space", opt_bool
, &smtp_check_spool_space
},
298 { "smtp_connect_backlog", opt_int
, &smtp_connect_backlog
},
299 { "smtp_enforce_sync", opt_bool
, &smtp_enforce_sync
},
300 { "smtp_etrn_command", opt_stringptr
, &smtp_etrn_command
},
301 { "smtp_etrn_serialize", opt_bool
, &smtp_etrn_serialize
},
302 { "smtp_load_reserve", opt_fixed
, &smtp_load_reserve
},
303 { "smtp_max_synprot_errors", opt_int
, &smtp_max_synprot_errors
},
304 { "smtp_max_unknown_commands",opt_int
, &smtp_max_unknown_commands
},
305 { "smtp_ratelimit_hosts", opt_stringptr
, &smtp_ratelimit_hosts
},
306 { "smtp_ratelimit_mail", opt_stringptr
, &smtp_ratelimit_mail
},
307 { "smtp_ratelimit_rcpt", opt_stringptr
, &smtp_ratelimit_rcpt
},
308 { "smtp_receive_timeout", opt_func
, &fn_smtp_receive_timeout
},
309 { "smtp_reserve_hosts", opt_stringptr
, &smtp_reserve_hosts
},
310 { "smtp_return_error_details",opt_bool
, &smtp_return_error_details
},
312 { "smtputf8_advertise_hosts", opt_stringptr
, &smtputf8_advertise_hosts
},
314 #ifdef WITH_CONTENT_SCAN
315 { "spamd_address", opt_stringptr
, &spamd_address
},
318 { "spf_guess", opt_stringptr
, &spf_guess
},
320 { "split_spool_directory", opt_bool
, &split_spool_directory
},
321 { "spool_directory", opt_stringptr
, &spool_directory
},
322 { "spool_wireformat", opt_bool
, &spool_wireformat
},
324 { "sqlite_lock_timeout", opt_int
, &sqlite_lock_timeout
},
326 #ifdef EXPERIMENTAL_SRS
327 { "srs_config", opt_stringptr
, &srs_config
},
328 { "srs_hashlength", opt_int
, &srs_hashlength
},
329 { "srs_hashmin", opt_int
, &srs_hashmin
},
330 { "srs_maxage", opt_int
, &srs_maxage
},
331 { "srs_secrets", opt_stringptr
, &srs_secrets
},
332 { "srs_usehash", opt_bool
, &srs_usehash
},
333 { "srs_usetimestamp", opt_bool
, &srs_usetimestamp
},
335 { "strict_acl_vars", opt_bool
, &strict_acl_vars
},
336 { "strip_excess_angle_brackets", opt_bool
, &strip_excess_angle_brackets
},
337 { "strip_trailing_dot", opt_bool
, &strip_trailing_dot
},
338 { "syslog_duplication", opt_bool
, &syslog_duplication
},
339 { "syslog_facility", opt_stringptr
, &syslog_facility_str
},
340 { "syslog_pid", opt_bool
, &syslog_pid
},
341 { "syslog_processname", opt_stringptr
, &syslog_processname
},
342 { "syslog_timestamp", opt_bool
, &syslog_timestamp
},
343 { "system_filter", opt_stringptr
, &system_filter
},
344 { "system_filter_directory_transport", opt_stringptr
,&system_filter_directory_transport
},
345 { "system_filter_file_transport",opt_stringptr
,&system_filter_file_transport
},
346 { "system_filter_group", opt_gid
, &system_filter_gid
},
347 { "system_filter_pipe_transport",opt_stringptr
,&system_filter_pipe_transport
},
348 { "system_filter_reply_transport",opt_stringptr
,&system_filter_reply_transport
},
349 { "system_filter_user", opt_uid
, &system_filter_uid
},
350 { "tcp_nodelay", opt_bool
, &tcp_nodelay
},
351 #ifdef USE_TCP_WRAPPERS
352 { "tcp_wrappers_daemon_name", opt_stringptr
, &tcp_wrappers_daemon_name
},
354 { "timeout_frozen_after", opt_time
, &timeout_frozen_after
},
355 { "timezone", opt_stringptr
, &timezone_string
},
356 { "tls_advertise_hosts", opt_stringptr
, &tls_advertise_hosts
},
358 # ifdef EXPERIMENTAL_REQUIRETLS
359 { "tls_advertise_requiretls", opt_stringptr
, &tls_advertise_requiretls
},
361 { "tls_certificate", opt_stringptr
, &tls_certificate
},
362 { "tls_crl", opt_stringptr
, &tls_crl
},
363 { "tls_dh_max_bits", opt_int
, &tls_dh_max_bits
},
364 { "tls_dhparam", opt_stringptr
, &tls_dhparam
},
365 { "tls_eccurve", opt_stringptr
, &tls_eccurve
},
366 # ifndef DISABLE_OCSP
367 { "tls_ocsp_file", opt_stringptr
, &tls_ocsp_file
},
369 { "tls_on_connect_ports", opt_stringptr
, &tls_in
.on_connect_ports
},
370 { "tls_privatekey", opt_stringptr
, &tls_privatekey
},
371 { "tls_remember_esmtp", opt_bool
, &tls_remember_esmtp
},
372 { "tls_require_ciphers", opt_stringptr
, &tls_require_ciphers
},
373 { "tls_try_verify_hosts", opt_stringptr
, &tls_try_verify_hosts
},
374 { "tls_verify_certificates", opt_stringptr
, &tls_verify_certificates
},
375 { "tls_verify_hosts", opt_stringptr
, &tls_verify_hosts
},
377 { "trusted_groups", opt_gidlist
, &trusted_groups
},
378 { "trusted_users", opt_uidlist
, &trusted_users
},
379 { "unknown_login", opt_stringptr
, &unknown_login
},
380 { "unknown_username", opt_stringptr
, &unknown_username
},
381 { "untrusted_set_sender", opt_stringptr
, &untrusted_set_sender
},
382 { "uucp_from_pattern", opt_stringptr
, &uucp_from_pattern
},
383 { "uucp_from_sender", opt_stringptr
, &uucp_from_sender
},
384 { "warn_message_file", opt_stringptr
, &warn_message_file
},
385 { "write_rejectlog", opt_bool
, &write_rejectlog
}
389 static int optionlist_config_size
= nelem(optionlist_config
);
395 static void fn_smtp_receive_timeout(const uschar
* name
, const uschar
* str
) {/*Dummy*/}
400 options_from_list(optionlist_config
, nelem(optionlist_config
), US
"MAIN", NULL
);
406 struct auth_info
* ai
;
409 options_from_list(optionlist_auths
, optionlist_auths_size
, US
"AUTHENTICATORS", NULL
);
411 for (ai
= auths_available
; ai
->driver_name
[0]; ai
++)
413 spf(buf
, sizeof(buf
), US
"_DRIVER_AUTHENTICATOR_%T", ai
->driver_name
);
414 builtin_macro_create(buf
);
415 options_from_list(ai
->options
, (unsigned)*ai
->options_count
, US
"AUTHENTICATOR", ai
->driver_name
);
420 options_logging(void)
425 for (bp
= log_options
; bp
< log_options
+ log_options_count
; bp
++)
427 spf(buf
, sizeof(buf
), US
"_LOG_%T", bp
->name
);
428 builtin_macro_create(buf
);
433 #else /*!MACRO_PREDEF*/
435 extern char **environ
;
437 static void save_config_line(const uschar
* line
);
438 static void save_config_position(const uschar
*file
, int line
);
439 static void print_config(BOOL admin
, BOOL terse
);
442 #define CSTATE_STACK_SIZE 10
444 const uschar
*config_directory
= NULL
;
447 /* Structure for chain (stack) of .included files */
449 typedef struct config_file_item
{
450 struct config_file_item
*next
;
451 const uschar
*filename
;
452 const uschar
*directory
;
457 /* Structure for chain of configuration lines (-bP config) */
459 typedef struct config_line_item
{
460 struct config_line_item
*next
;
464 static config_line_item
* config_lines
;
466 /* Structure of table of conditional words and their state transitions */
468 typedef struct cond_item
{
476 /* Structure of table of syslog facility names and values */
478 typedef struct syslog_fac_item
{
484 static const char * const hidden
= "<value not displayable>";
486 /* Static variables */
488 static config_file_item
*config_file_stack
= NULL
; /* For includes */
490 static uschar
*syslog_facility_str
= NULL
;
491 static uschar next_section
[24];
492 static uschar time_buffer
[24];
494 /* State variables for conditional loading (.ifdef / .else / .endif) */
496 static int cstate
= 0;
497 static int cstate_stack_ptr
= -1;
498 static int cstate_stack
[CSTATE_STACK_SIZE
];
500 /* Table of state transitions for handling conditional inclusions. There are
501 four possible state transitions:
505 .elifdef true (or .else)
508 .endif just causes the previous cstate to be popped off the stack */
510 static int next_cstate
[3][4] =
512 /* State 0: reading from file, or reading until next .else or .endif */
514 /* State 1: condition failed, skipping until next .else or .endif */
516 /* State 2: skipping until .endif */
520 /* Table of conditionals and the states to set. For each name, there are four
521 values: the length of the name (to save computing it each time), the state to
522 set if a macro was found in the line, the state to set if a macro was not found
523 in the line, and a stack manipulation setting which is:
525 -1 pull state value off the stack
526 0 don't alter the stack
527 +1 push value onto stack, before setting new state
530 static cond_item cond_list
[] = {
531 { US
"ifdef", 5, 0, 1, 1 },
532 { US
"ifndef", 6, 1, 0, 1 },
533 { US
"elifdef", 7, 2, 3, 0 },
534 { US
"elifndef", 8, 3, 2, 0 },
535 { US
"else", 4, 2, 2, 0 },
536 { US
"endif", 5, 0, 0, -1 }
539 static int cond_list_size
= sizeof(cond_list
)/sizeof(cond_item
);
541 /* Table of syslog facility names and their values */
543 static syslog_fac_item syslog_list
[] = {
544 { US
"mail", LOG_MAIL
},
545 { US
"user", LOG_USER
},
546 { US
"news", LOG_NEWS
},
547 { US
"uucp", LOG_UUCP
},
548 { US
"local0", LOG_LOCAL0
},
549 { US
"local1", LOG_LOCAL1
},
550 { US
"local2", LOG_LOCAL2
},
551 { US
"local3", LOG_LOCAL3
},
552 { US
"local4", LOG_LOCAL4
},
553 { US
"local5", LOG_LOCAL5
},
554 { US
"local6", LOG_LOCAL6
},
555 { US
"local7", LOG_LOCAL7
},
556 { US
"daemon", LOG_DAEMON
}
559 static int syslog_list_size
= sizeof(syslog_list
)/sizeof(syslog_fac_item
);
564 /*************************************************
565 * Find the name of an option *
566 *************************************************/
568 /* This function is to aid debugging. Various functions take arguments that are
569 pointer variables in the options table or in option tables for various drivers.
570 For debugging output, it is useful to be able to find the name of the option
571 which is currently being processed. This function finds it, if it exists, by
572 searching the table(s).
574 Arguments: a value that is presumed to be in the table above
575 Returns: the option name, or an empty string
579 readconf_find_option(void *p
)
583 transport_instance
*t
;
585 for (i
= 0; i
< nelem(optionlist_config
); i
++)
586 if (p
== optionlist_config
[i
].value
) return US optionlist_config
[i
].name
;
588 for (r
= routers
; r
; r
= r
->next
)
590 router_info
*ri
= r
->info
;
591 for (i
= 0; i
< *ri
->options_count
; i
++)
593 if ((ri
->options
[i
].type
& opt_mask
) != opt_stringptr
) continue;
594 if (p
== CS (r
->options_block
) + (long int)(ri
->options
[i
].value
))
595 return US ri
->options
[i
].name
;
599 for (t
= transports
; t
; t
= t
->next
)
601 transport_info
*ti
= t
->info
;
602 for (i
= 0; i
< *ti
->options_count
; i
++)
604 optionlist
* op
= &ti
->options
[i
];
605 if ((op
->type
& opt_mask
) != opt_stringptr
) continue;
606 if (p
== ( op
->type
& opt_public
608 : CS t
->options_block
610 + (long int)op
->value
)
621 /*************************************************
622 * Deal with an assignment to a macro *
623 *************************************************/
625 /* We have a new definition; append to the list.
628 name Name of the macro; will be copied
629 val Expansion result for the macro; will be copied
633 macro_create(const uschar
* name
, const uschar
* val
, BOOL command_line
)
635 macro_item
* m
= store_get(sizeof(macro_item
));
637 READCONF_DEBUG
fprintf(stderr
, "%s: '%s' '%s'\n", __FUNCTION__
, name
, val
);
639 m
->command_line
= command_line
;
640 m
->namelen
= Ustrlen(name
);
641 m
->replen
= Ustrlen(val
);
642 m
->name
= string_copy(name
);
643 m
->replacement
= string_copy(val
);
655 /* This function is called when a line that starts with an upper case letter is
656 encountered. The argument "line" should contain a complete logical line, and
657 start with the first letter of the macro name. The macro name and the
658 replacement text are extracted and stored. Redefinition of existing,
659 non-command line, macros is permitted using '==' instead of '='.
662 s points to the start of the logical line
664 Returns: FALSE iff fatal error
668 macro_read_assignment(uschar
*s
)
675 while (isalnum(*s
) || *s
== '_')
677 if (namelen
>= sizeof(name
) - 1)
679 log_write(0, LOG_PANIC
|LOG_CONFIG_IN
,
680 "macro name too long (maximum is " SIZE_T_FMT
" characters)", sizeof(name
) - 1);
683 name
[namelen
++] = *s
++;
687 while (isspace(*s
)) s
++;
690 log_write(0, LOG_PANIC
|LOG_CONFIG_IN
, "malformed macro definition");
699 while (isspace(*s
)) s
++;
701 /* If an existing macro of the same name was defined on the command line, we
702 just skip this definition. It's an error to attempt to redefine a macro without
703 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
704 It is also an error to define a macro whose name begins with the name of a
705 previously defined macro. This is the requirement that make using a tree
706 for macros hard; we must check all macros for the substring. Perhaps a
707 sorted list, and a bsearch, would work?
708 Note: it is documented that the other way round works. */
710 for (m
= macros
; m
; m
= m
->next
)
712 if (Ustrcmp(m
->name
, name
) == 0)
714 if (!m
->command_line
&& !redef
)
716 log_write(0, LOG_CONFIG
|LOG_PANIC
, "macro \"%s\" is already "
717 "defined (use \"==\" if you want to redefine it)", name
);
723 if (m
->namelen
< namelen
&& Ustrstr(name
, m
->name
) != NULL
)
725 log_write(0, LOG_CONFIG
|LOG_PANIC
, "\"%s\" cannot be defined as "
726 "a macro because previously defined macro \"%s\" is a substring",
731 /* We cannot have this test, because it is documented that a substring
732 macro is permitted (there is even an example).
734 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
735 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
736 * "a macro because it is a substring of previously defined macro \"%s\"",
741 /* Check for an overriding command-line definition. */
743 if (m
&& m
->command_line
) return TRUE
;
745 /* Redefinition must refer to an existing macro. */
750 m
->replen
= Ustrlen(s
);
751 m
->replacement
= string_copy(s
);
755 log_write(0, LOG_CONFIG
|LOG_PANIC
, "can't redefine an undefined macro "
760 /* We have a new definition. */
762 (void) macro_create(name
, s
, FALSE
);
770 /* Process line for macros. The line is in big_buffer starting at offset len.
771 Expand big_buffer if needed. Handle definitions of new macros, and
772 macro expansions, rewriting the line in the buffer.
775 len Offset in buffer of start of line
776 newlen Pointer to offset of end of line, updated on return
777 macro_found Pointer to return that a macro was expanded
779 Return: pointer to first nonblank char in line
783 macros_expand(int len
, int * newlen
, BOOL
* macro_found
)
785 uschar
* ss
= big_buffer
+ len
;
789 /* Find the true start of the physical line - leading spaces are always
792 while (isspace(*ss
)) ss
++;
794 /* Process the physical line for macros. If this is the start of the logical
795 line, skip over initial text at the start of the line if it starts with an
796 upper case character followed by a sequence of name characters and an equals
797 sign, because that is the definition of a new macro, and we don't do
798 replacement therein. */
801 if (len
== 0 && isupper(*s
))
803 while (isalnum(*s
) || *s
== '_') s
++;
804 while (isspace(*s
)) s
++;
805 if (*s
!= '=') s
= ss
; /* Not a macro definition */
808 /* Skip leading chars which cannot start a macro name, to avoid multiple
809 pointless rescans in Ustrstr calls. */
811 while (*s
&& !isupper(*s
) && !(*s
== '_' && isupper(s
[1]))) s
++;
813 /* For each defined macro, scan the line (from after XXX= if present),
814 replacing all occurrences of the macro. */
816 *macro_found
= FALSE
;
817 if (*s
) for (m
= *s
== '_' ? macros
: macros_user
; m
; m
= m
->next
)
822 while (*s
&& !isupper(*s
) && !(*s
== '_' && isupper(s
[1]))) s
++;
826 while ((p
= Ustrstr(t
, m
->name
)) != NULL
)
830 READCONF_DEBUG
fprintf(stderr
, "%s: matched '%s' in '%.*s'\n", __FUNCTION__
,
831 m
->name
, (int) Ustrlen(ss
)-1, ss
);
832 /* Expand the buffer if necessary */
834 while (*newlen
- m
->namelen
+ m
->replen
+ 1 > big_buffer_size
)
836 int newsize
= big_buffer_size
+ BIG_BUFFER_SIZE
;
837 uschar
*newbuffer
= store_malloc(newsize
);
838 memcpy(newbuffer
, big_buffer
, *newlen
+ 1);
839 p
= newbuffer
+ (p
- big_buffer
);
840 s
= newbuffer
+ (s
- big_buffer
);
841 ss
= newbuffer
+ (ss
- big_buffer
);
842 t
= newbuffer
+ (t
- big_buffer
);
843 big_buffer_size
= newsize
;
844 store_free(big_buffer
);
845 big_buffer
= newbuffer
;
848 /* Shuffle the remaining characters up or down in the buffer before
849 copying in the replacement text. Don't rescan the replacement for this
853 if ((moveby
= m
->replen
- m
->namelen
) != 0)
855 memmove(p
+ m
->replen
, pp
, (big_buffer
+ *newlen
) - pp
+ 1);
858 Ustrncpy(p
, m
->replacement
, m
->replen
);
860 while (*t
&& !isupper(*t
) && !(*t
== '_' && isupper(t
[1]))) t
++;
865 /* An empty macro replacement at the start of a line could mean that ss no
866 longer points to the first non-blank character. */
868 while (isspace(*ss
)) ss
++;
872 /*************************************************
873 * Read configuration line *
874 *************************************************/
876 /* A logical line of text is read from the configuration file into the big
877 buffer, taking account of macros, .includes, and continuations. The size of
878 big_buffer is increased if necessary. The count of configuration lines is
879 maintained. Physical input lines starting with # (ignoring leading white space,
880 and after macro replacement) and empty logical lines are always ignored.
881 Leading and trailing spaces are removed.
883 If we hit a line of the form "begin xxxx", the xxxx is placed in the
884 next_section vector, and the function returns NULL, indicating the end of a
885 configuration section. On end-of-file, NULL is returned with next_section
890 Returns: a pointer to the first non-blank in the line,
891 or NULL if eof or end of section is reached
895 get_config_line(void)
897 int startoffset
= 0; /* To first non-blank char in logical line */
898 int len
= 0; /* Of logical line so far */
903 /* Loop for handling continuation lines, skipping comments, and dealing with
908 if (Ufgets(big_buffer
+len
, big_buffer_size
-len
, config_file
) == NULL
)
910 if (config_file_stack
!= NULL
) /* EOF inside .include */
912 (void)fclose(config_file
);
913 config_file
= config_file_stack
->file
;
914 config_filename
= config_file_stack
->filename
;
915 config_directory
= config_file_stack
->directory
;
916 config_lineno
= config_file_stack
->lineno
;
917 config_file_stack
= config_file_stack
->next
;
919 save_config_position(config_filename
, config_lineno
);
923 /* EOF at top level */
925 if (cstate_stack_ptr
>= 0)
926 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
927 "Unexpected end of configuration file: .endif missing");
929 if (len
!= 0) break; /* EOF after continuation */
930 next_section
[0] = 0; /* EOF at start of logical line */
935 newlen
= len
+ Ustrlen(big_buffer
+ len
);
937 if (config_lines
&& config_lineno
== 1)
938 save_config_position(config_filename
, config_lineno
);
940 /* Handle pathologically long physical lines - yes, it did happen - by
941 extending big_buffer at this point. The code also copes with very long
944 while (newlen
== big_buffer_size
- 1 && big_buffer
[newlen
- 1] != '\n')
947 big_buffer_size
+= BIG_BUFFER_SIZE
;
948 newbuffer
= store_malloc(big_buffer_size
);
950 /* This use of strcpy is OK because we know that the string in the old
951 buffer is shorter than the new buffer. */
953 Ustrcpy(newbuffer
, big_buffer
);
954 store_free(big_buffer
);
955 big_buffer
= newbuffer
;
956 if (Ufgets(big_buffer
+newlen
, big_buffer_size
-newlen
, config_file
) == NULL
)
958 newlen
+= Ustrlen(big_buffer
+ newlen
);
961 ss
= macros_expand(len
, &newlen
, ¯o_found
);
963 /* Check for comment lines - these are physical lines. */
965 if (*ss
== '#') continue;
967 /* Handle conditionals, which are also applied to physical lines. Conditions
968 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
969 expansion occured on the rest of the line. A preliminary test for the leading
970 '.' saves effort on most lines. */
976 /* Search the list of conditional directives */
978 for (i
= 0; i
< cond_list_size
; i
++)
981 cond_item
*c
= cond_list
+i
;
982 if (Ustrncmp(ss
+1, c
->name
, c
->namelen
) != 0) continue;
984 /* The following character must be white space or end of string */
986 n
= ss
[1 + c
->namelen
];
987 if (n
!= ' ' && n
!= 't' && n
!= '\n' && n
!= 0) break;
989 /* .ifdef and .ifndef push the current state onto the stack, then set
990 a new one from the table. Stack overflow is an error */
994 if (cstate_stack_ptr
>= CSTATE_STACK_SIZE
- 1)
995 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
996 ".%s nested too deeply", c
->name
);
997 cstate_stack
[++cstate_stack_ptr
] = cstate
;
998 cstate
= next_cstate
[cstate
][macro_found? c
->action1
: c
->action2
];
1001 /* For any of the others, stack underflow is an error. The next state
1002 comes either from the stack (.endif) or from the table. */
1006 if (cstate_stack_ptr
< 0)
1007 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1008 ".%s without matching .ifdef", c
->name
);
1009 cstate
= (c
->pushpop
< 0)? cstate_stack
[cstate_stack_ptr
--] :
1010 next_cstate
[cstate
][macro_found? c
->action1
: c
->action2
];
1013 /* Having dealt with a directive, break the loop */
1018 /* If we have handled a conditional directive, continue with the next
1019 physical line. Otherwise, fall through. */
1021 if (i
< cond_list_size
) continue;
1024 /* If the conditional state is not 0 (actively using these lines), ignore
1027 if (cstate
!= 0) continue; /* Conditional skip */
1029 /* Handle .include lines - these are also physical lines. */
1031 if (Ustrncmp(ss
, ".include", 8) == 0 &&
1033 (Ustrncmp(ss
+8, "_if_exists", 10) == 0 && isspace(ss
[18]))))
1036 int include_if_exists
= isspace(ss
[8])?
0 : 10;
1037 config_file_item
*save
;
1038 struct stat statbuf
;
1040 ss
+= 9 + include_if_exists
;
1041 while (isspace(*ss
)) ss
++;
1042 t
= ss
+ Ustrlen(ss
);
1043 while (t
> ss
&& isspace(t
[-1])) t
--;
1044 if (*ss
== '\"' && t
[-1] == '\"')
1051 /* We allow relative file names. For security reasons currently
1052 relative names not allowed with .include_if_exists. For .include_if_exists
1053 we need to check the permissions/ownership of the containing folder */
1055 if (include_if_exists
) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, ".include specifies a non-"
1056 "absolute path \"%s\"", ss
);
1059 gstring
* g
= string_append(NULL
, 3, config_directory
, "/", ss
);
1060 ss
= string_from_gstring(g
);
1063 if (include_if_exists
!= 0 && (Ustat(ss
, &statbuf
) != 0)) continue;
1066 save_config_position(config_filename
, config_lineno
);
1067 save
= store_get(sizeof(config_file_item
));
1068 save
->next
= config_file_stack
;
1069 config_file_stack
= save
;
1070 save
->file
= config_file
;
1071 save
->filename
= config_filename
;
1072 save
->directory
= config_directory
;
1073 save
->lineno
= config_lineno
;
1075 if (!(config_file
= Ufopen(ss
, "rb")))
1076 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to open included "
1077 "configuration file %s", ss
);
1079 config_filename
= string_copy(ss
);
1080 config_directory
= string_copyn(ss
, CUstrrchr(ss
, '/') - ss
);
1085 /* If this is the start of the logical line, remember where the non-blank
1086 data starts. Otherwise shuffle down continuation lines to remove leading
1090 startoffset
= ss
- big_buffer
;
1093 s
= big_buffer
+ len
;
1096 memmove(s
, ss
, (newlen
- len
) - (ss
- s
) + 1);
1101 /* Accept the new addition to the line. Remove trailing white space. */
1104 while (len
> 0 && isspace(big_buffer
[len
-1])) len
--;
1105 big_buffer
[len
] = 0;
1107 /* We are done if the line does not end in backslash and contains some data.
1108 Empty logical lines are ignored. For continuations, remove the backslash and
1109 go round the loop to read the continuation line. */
1113 if (big_buffer
[len
-1] != '\\') break; /* End of logical line */
1114 big_buffer
[--len
] = 0; /* Remove backslash */
1116 } /* Loop for reading multiple physical lines */
1118 /* We now have a logical line. Test for the end of a configuration section (or,
1119 more accurately, for the start of the next section). Place the name of the next
1120 section in next_section, and return NULL. If the name given is longer than
1121 next_section, truncate it. It will be unrecognized later, because all the known
1122 section names do fit. Leave space for pluralizing. */
1124 s
= big_buffer
+ startoffset
; /* First non-space character */
1127 save_config_line(s
);
1129 if (strncmpic(s
, US
"begin ", 6) == 0)
1132 while (isspace(*s
)) s
++;
1133 if (big_buffer
+ len
- s
> sizeof(next_section
) - 2)
1134 s
[sizeof(next_section
) - 2] = 0;
1135 Ustrcpy(next_section
, s
);
1139 /* Return the first non-blank character. */
1146 /*************************************************
1148 *************************************************/
1150 /* The yield is the pointer to the next uschar. Names longer than the
1151 output space are silently truncated. This function is also used from acl.c when
1155 name where to put the name
1159 Returns: new input pointer
1163 readconf_readname(uschar
*name
, int len
, uschar
*s
)
1166 while (isspace(*s
)) s
++;
1169 while (isalnum(*s
) || *s
== '_')
1171 if (p
< len
-1) name
[p
++] = *s
;
1176 while (isspace(*s
)) s
++;
1183 /*************************************************
1184 * Read a time value *
1185 *************************************************/
1187 /* This function is also called from outside, to read argument
1188 time values. The format of a time value is:
1190 [<n>w][<n>d][<n>h][<n>m][<n>s]
1192 as long as at least one is present. If a format error is encountered,
1193 return a negative value. The value must be terminated by the given
1198 terminator required terminating character
1199 return_msec if TRUE, allow fractional seconds and return milliseconds
1201 Returns: the time value, or -1 on syntax error
1202 value is seconds if return_msec is FALSE
1203 value is milliseconds if return_msec is TRUE
1207 readconf_readtime(const uschar
*s
, int terminator
, BOOL return_msec
)
1215 if (!isdigit(*s
)) return -1;
1216 (void)sscanf(CCS s
, "%d%n", &value
, &count
);
1221 case 'w': value
*= 7;
1222 case 'd': value
*= 24;
1223 case 'h': value
*= 60;
1224 case 'm': value
*= 60;
1229 if (!return_msec
) return -1;
1230 (void)sscanf(CCS s
, "%lf%n", &fraction
, &count
);
1232 if (*s
++ != 's') return -1;
1233 yield
+= (int)(fraction
* 1000.0);
1239 if (return_msec
) value
*= 1000;
1241 if (*s
== terminator
) return yield
;
1243 /* Control never reaches here. */
1248 /*************************************************
1249 * Read a fixed point value *
1250 *************************************************/
1252 /* The value is returned *1000
1256 terminator required terminator
1258 Returns: the value, or -1 on error
1262 readconf_readfixed(const uschar
*s
, int terminator
)
1266 if (!isdigit(*s
)) return -1;
1267 (void)sscanf(CS s
, "%d%n", &value
, &count
);
1269 yield
= value
* 1000;
1273 while (isdigit((*(++s
))))
1275 yield
+= (*s
- '0') * m
;
1280 return (*s
== terminator
)? yield
: (-1);
1285 /*************************************************
1286 * Find option in list *
1287 *************************************************/
1289 /* The lists are always in order, so binary chop can be used.
1292 name the option name to search for
1293 ol the first entry in the option list
1294 last one more than the offset of the last entry in the option list
1296 Returns: pointer to an option entry, or NULL if not found
1300 find_option(uschar
*name
, optionlist
*ol
, int last
)
1303 while (last
> first
)
1305 int middle
= (first
+ last
)/2;
1306 int c
= Ustrcmp(name
, ol
[middle
].name
);
1308 if (c
== 0) return ol
+ middle
;
1309 else if (c
> 0) first
= middle
+ 1;
1317 /*************************************************
1318 * Find a set flag in option list *
1319 *************************************************/
1321 /* Because some versions of Unix make no restrictions on the values of uids and
1322 gids (even negative ones), we cannot represent "unset" by a special value.
1323 There is therefore a separate boolean variable for each one indicating whether
1324 a value is set or not. This function returns a pointer to the boolean, given
1325 the original option name. It is a major disaster if the flag cannot be found.
1328 name the name of the uid or gid option
1329 oltop points to the start of the relevant option list
1330 last one more than the offset of the last item in the option list
1331 data_block NULL when reading main options => data values in the option
1332 list are absolute addresses; otherwise they are byte offsets
1333 in data_block (used for driver options)
1335 Returns: a pointer to the boolean flag.
1339 get_set_flag(uschar
*name
, optionlist
*oltop
, int last
, void *data_block
)
1343 sprintf(CS name2
, "*set_%.50s", name
);
1344 ol
= find_option(name2
, oltop
, last
);
1345 if (ol
== NULL
) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
1346 "Exim internal error: missing set flag for %s", name
);
1347 return (data_block
== NULL
)?
(BOOL
*)(ol
->value
) :
1348 (BOOL
*)(US data_block
+ (long int)(ol
->value
));
1354 /*************************************************
1355 * Output extra characters message and die *
1356 *************************************************/
1358 /* Called when an option line has junk on the end. Sometimes this is because
1359 the sysadmin thinks comments are permitted.
1362 s points to the extra characters
1363 t1..t3 strings to insert in the log message
1365 Returns: doesn't return; dies
1369 extra_chars_error(const uschar
*s
, const uschar
*t1
, const uschar
*t2
, const uschar
*t3
)
1371 uschar
*comment
= US
"";
1372 if (*s
== '#') comment
= US
" (# is comment only at line start)";
1373 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1374 "extra characters follow %s%s%s%s", t1
, t2
, t3
, comment
);
1379 /*************************************************
1380 * Read rewrite information *
1381 *************************************************/
1383 /* Each line of rewrite information contains:
1385 . A complete address in the form user@domain, possibly with
1386 leading * for each part; or alternatively, a regex.
1388 . A replacement string (which will be expanded).
1390 . An optional sequence of one-letter flags, indicating which
1391 headers etc. to apply this rule to.
1393 All this is decoded and placed into a control block. The OR of the flags is
1394 maintained in a common word.
1397 p points to the string that makes up the rule
1398 existflags points to the overall flag word
1399 isglobal TRUE if reading global rewrite rules
1401 Returns: the control block for the parsed rule.
1404 static rewrite_rule
*
1405 readconf_one_rewrite(const uschar
*p
, int *existflags
, BOOL isglobal
)
1407 rewrite_rule
*next
= store_get(sizeof(rewrite_rule
));
1410 next
->key
= string_dequote(&p
);
1412 while (isspace(*p
)) p
++;
1414 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1415 "missing rewrite replacement string");
1418 next
->replacement
= string_dequote(&p
);
1420 while (*p
!= 0) switch (*p
++)
1422 case ' ': case '\t': break;
1424 case 'q': next
->flags
|= rewrite_quit
; break;
1425 case 'w': next
->flags
|= rewrite_whole
; break;
1427 case 'h': next
->flags
|= rewrite_all_headers
; break;
1428 case 's': next
->flags
|= rewrite_sender
; break;
1429 case 'f': next
->flags
|= rewrite_from
; break;
1430 case 't': next
->flags
|= rewrite_to
; break;
1431 case 'c': next
->flags
|= rewrite_cc
; break;
1432 case 'b': next
->flags
|= rewrite_bcc
; break;
1433 case 'r': next
->flags
|= rewrite_replyto
; break;
1435 case 'E': next
->flags
|= rewrite_all_envelope
; break;
1436 case 'F': next
->flags
|= rewrite_envfrom
; break;
1437 case 'T': next
->flags
|= rewrite_envto
; break;
1439 case 'Q': next
->flags
|= rewrite_qualify
; break;
1440 case 'R': next
->flags
|= rewrite_repeat
; break;
1443 next
->flags
|= rewrite_smtp
;
1444 if (next
->key
[0] != '^' && Ustrncmp(next
->key
, "\\N^", 3) != 0)
1445 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1446 "rewrite rule has the S flag but is not a regular expression");
1450 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1451 "unknown rewrite flag character '%c' "
1452 "(could be missing quotes round replacement item)", p
[-1]);
1456 /* If no action flags are set, set all the "normal" rewrites. */
1458 if ((next
->flags
& (rewrite_all
| rewrite_smtp
)) == 0)
1459 next
->flags
|= isglobal? rewrite_all
: rewrite_all_headers
;
1461 /* Remember which exist, for optimization, and return the rule */
1463 *existflags
|= next
->flags
;
1470 /*************************************************
1471 * Read global rewrite information *
1472 *************************************************/
1474 /* Each line is a single rewrite rule; it is parsed into a control block
1475 by readconf_one_rewrite(), and its flags are ORed into the global flag
1476 word rewrite_existflags. */
1479 readconf_rewrites(void)
1481 rewrite_rule
**chain
= &global_rewrite_rules
;
1484 while ((p
= get_config_line()) != NULL
)
1486 rewrite_rule
*next
= readconf_one_rewrite(p
, &rewrite_existflags
, TRUE
);
1488 chain
= &(next
->next
);
1494 /*************************************************
1496 *************************************************/
1498 /* Strings are read into the normal store pool. As long we aren't too
1499 near the end of the current block, the string will just use what is necessary
1500 on the top of the stacking pool, because string_cat() uses the extension
1504 s the rest of the input line
1505 name the option name (for errors)
1507 Returns: pointer to the string
1511 read_string(const uschar
*s
, const uschar
*name
)
1516 if (*s
!= '\"') return string_copy(s
);
1519 yield
= string_dequote(&s
);
1521 if (s
== ss
+1 || s
[-1] != '\"')
1522 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1523 "missing quote at end of string value for %s", name
);
1525 if (*s
!= 0) extra_chars_error(s
, US
"string value for ", name
, US
"");
1531 /*************************************************
1532 * Custom-handler options *
1533 *************************************************/
1535 fn_smtp_receive_timeout(const uschar
* name
, const uschar
* str
)
1538 smtp_receive_timeout_s
= string_copy(str
);
1541 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1542 smtp_receive_timeout
= readconf_readtime(str
, 0, FALSE
);
1543 if (smtp_receive_timeout
< 0)
1544 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
1549 /*************************************************
1550 * Handle option line *
1551 *************************************************/
1553 /* This function is called from several places to process a line containing the
1554 setting of an option. The first argument is the line to be decoded; it has been
1555 checked not to be empty and not to start with '#'. Trailing newlines and white
1556 space have been removed. The second argument is a pointer to the list of
1557 variable names that are to be recognized, together with their types and
1558 locations, and the third argument gives the number of entries in the list.
1560 The fourth argument is a pointer to a data block. If it is NULL, then the data
1561 values in the options list are absolute addresses. Otherwise, they are byte
1562 offsets in the data block.
1564 String option data may continue onto several lines; this function reads further
1565 data from config_file if necessary.
1567 The yield of this function is normally zero. If a string continues onto
1568 multiple lines, then the data value is permitted to be followed by a comma
1569 or a semicolon (for use in drivers) and the yield is that character.
1572 buffer contains the configuration line to be handled
1573 oltop points to the start of the relevant option list
1574 last one more than the offset of the last item in the option list
1575 data_block NULL when reading main options => data values in the option
1576 list are absolute addresses; otherwise they are byte offsets
1577 in data_block when they have opt_public set; otherwise
1578 they are byte offsets in data_block->options_block.
1579 unknown_txt format string to use in panic message for unknown option;
1580 must contain %s for option name
1581 if given as NULL, don't panic on unknown option
1583 Returns: TRUE if an option was read successfully,
1584 FALSE false for an unknown option if unknown_txt == NULL,
1585 otherwise panic and die on an unknown option
1589 readconf_handle_option(uschar
*buffer
, optionlist
*oltop
, int last
,
1590 void *data_block
, uschar
*unknown_txt
)
1594 int n
, count
, type
, value
;
1598 BOOL boolvalue
= TRUE
;
1599 BOOL freesptr
= TRUE
;
1600 optionlist
*ol
, *ol2
;
1604 uschar
*inttype
= US
"";
1607 uschar
**str_target
;
1611 /* There may be leading spaces; thereafter, we expect an option name starting
1614 while (isspace(*s
)) s
++;
1616 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "option setting expected: %s", s
);
1618 /* Read the name of the option, and skip any subsequent white space. If
1619 it turns out that what we read was "hide", set the flag indicating that
1620 this is a secure option, and loop to read the next word. */
1622 for (n
= 0; n
< 2; n
++)
1624 while (isalnum(*s
) || *s
== '_')
1626 if (ptr
< sizeof(name
)-1) name
[ptr
++] = *s
;
1630 while (isspace(*s
)) s
++;
1631 if (Ustrcmp(name
, "hide") != 0) break;
1632 issecure
= opt_secure
;
1636 /* Deal with "no_" or "not_" here for booleans */
1638 if (Ustrncmp(name
, "no_", 3) == 0)
1644 if (Ustrncmp(name
, "not_", 4) == 0)
1650 /* Search the list for the given name. A non-existent name, or an option that
1651 is set twice, is a disaster. */
1653 if (!(ol
= find_option(name
+ offset
, oltop
, last
)))
1655 if (unknown_txt
== NULL
) return FALSE
;
1656 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, CS unknown_txt
, name
);
1659 if ((ol
->type
& opt_set
) && !(ol
->type
& (opt_rep_con
| opt_rep_str
)))
1660 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1661 "\"%s\" option set for the second time", name
);
1663 ol
->type
|= opt_set
| issecure
;
1664 type
= ol
->type
& opt_mask
;
1666 /* Types with data values must be followed by '='; the "no[t]_" prefix
1667 applies only to boolean values. */
1669 if (type
< opt_bool
|| type
> opt_bool_last
)
1672 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1673 "negation prefix applied to a non-boolean option");
1675 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1676 "unexpected end of line (data missing) after %s", name
);
1678 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "missing \"=\" after %s", name
);
1681 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1682 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1683 ultimately expands to one of those values. */
1685 else if (*s
!= 0 && (offset
!= 0 || *s
!= '='))
1686 extra_chars_error(s
, US
"boolean option ", name
, US
"");
1688 /* Skip white space after = */
1690 if (*s
== '=') while (isspace((*(++s
))));
1692 /* If there is a data block and the opt_public flag is not set, change
1693 the data block pointer to the private options block. */
1695 if (data_block
!= NULL
&& (ol
->type
& opt_public
) == 0)
1696 data_block
= (void *)(((driver_instance
*)data_block
)->options_block
);
1698 /* Now get the data according to the type. */
1702 /* If a string value is not enclosed in quotes, it consists of
1703 the rest of the current line, verbatim. Otherwise, string escapes
1706 A transport is specified as a string, which is then looked up in the
1707 list of transports. A search type is specified as one of a number of
1710 A set or rewrite rules for a driver is specified as a string, which is
1711 then parsed into a suitable chain of control blocks.
1713 Uids and gids are specified as strings which are then looked up in the
1714 passwd file. Lists of uids and gids are similarly specified as colon-
1715 separated strings. */
1720 case opt_expand_uid
:
1721 case opt_expand_gid
:
1726 reset_point
= sptr
= read_string(s
, name
);
1728 /* Having read a string, we now have several different ways of using it,
1729 depending on the data type, so do another switch. If keeping the actual
1730 string is not required (because it is interpreted), freesptr is set TRUE,
1731 and at the end we reset the pool. */
1735 /* If this was a string, set the variable to point to the new string,
1736 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1737 rules, we still keep the string (for printing), and parse the rules into a
1738 control block and flags word. */
1741 str_target
= data_block ?
USS (US data_block
+ (long int)(ol
->value
))
1743 if (ol
->type
& opt_rep_con
)
1745 uschar
* saved_condition
;
1746 /* We already have a condition, we're conducting a crude hack to let
1747 multiple condition rules be chained together, despite storing them in
1749 *str_target
= string_copy_malloc( (saved_condition
= *str_target
)
1750 ?
string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1751 saved_condition
, sptr
)
1753 /* TODO(pdp): there is a memory leak here and just below
1754 when we set 3 or more conditions; I still don't
1755 understand the store mechanism enough to know
1756 what's the safe way to free content from an earlier store.
1757 AFAICT, stores stack, so freeing an early stored item also stores
1758 all data alloc'd after it. If we knew conditions were adjacent,
1759 we could survive that, but we don't. So I *think* we need to take
1760 another bit from opt_type to indicate "malloced"; this seems like
1761 quite a hack, especially for this one case. It also means that
1762 we can't ever reclaim the store from the *first* condition.
1764 Because we only do this once, near process start-up, I'm prepared to
1765 let this slide for the time being, even though it rankles. */
1767 else if (ol
->type
& opt_rep_str
)
1769 uschar sep_o
= Ustrncmp(name
, "headers_add", 11)==0 ?
'\n' : ':';
1770 int sep_i
= -(int)sep_o
;
1771 const uschar
* list
= sptr
;
1773 gstring
* list_o
= NULL
;
1777 list_o
= string_get(Ustrlen(*str_target
) + Ustrlen(sptr
));
1778 list_o
= string_cat(list_o
, *str_target
);
1781 while ((s
= string_nextinlist(&list
, &sep_i
, NULL
, 0)))
1782 list_o
= string_append_listele(list_o
, sep_o
, s
);
1785 *str_target
= string_copy_malloc(string_from_gstring(list_o
));
1796 *USS (US data_block
+ (long int)(ol
->value
)) = sptr
;
1798 *USS (ol
->value
) = sptr
;
1800 if (type
== opt_rewrite
)
1805 rewrite_rule
**chain
;
1808 sprintf(CS name2
, "*%.50s_rules", name
);
1809 ol2
= find_option(name2
, oltop
, last
);
1810 sprintf(CS name2
, "*%.50s_flags", name
);
1811 ol3
= find_option(name2
, oltop
, last
);
1813 if (ol2
== NULL
|| ol3
== NULL
)
1814 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1815 "rewrite rules not available for driver");
1817 if (data_block
== NULL
)
1819 chain
= (rewrite_rule
**)(ol2
->value
);
1820 flagptr
= (int *)(ol3
->value
);
1824 chain
= (rewrite_rule
**)(US data_block
+ (long int)(ol2
->value
));
1825 flagptr
= (int *)(US data_block
+ (long int)(ol3
->value
));
1828 while ((p
= string_nextinlist(CUSS
&sptr
, &sep
, big_buffer
, BIG_BUFFER_SIZE
)))
1830 rewrite_rule
*next
= readconf_one_rewrite(p
, flagptr
, FALSE
);
1832 chain
= &(next
->next
);
1835 if ((*flagptr
& (rewrite_all_envelope
| rewrite_smtp
)) != 0)
1836 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "rewrite rule specifies a "
1837 "non-header rewrite - not allowed at transport time -");
1841 /* If it was an expanded uid, see if there is any expansion to be
1842 done by checking for the presence of a $ character. If there is, save it
1843 in the corresponding *expand_user option field. Otherwise, fall through
1844 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1847 case opt_expand_uid
:
1848 sprintf(CS name2
, "*expand_%.50s", name
);
1849 ol2
= find_option(name2
, oltop
, last
);
1852 uschar
*ss
= (Ustrchr(sptr
, '$') != NULL
)? sptr
: NULL
;
1854 if (data_block
== NULL
)
1855 *((uschar
**)(ol2
->value
)) = ss
;
1857 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = ss
;
1861 *(get_set_flag(name
, oltop
, last
, data_block
)) = FALSE
;
1867 /* Look up a fixed uid, and also make use of the corresponding gid
1868 if a passwd entry is returned and the gid has not been set. */
1871 if (!route_finduser(sptr
, &pw
, &uid
))
1872 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "user %s was not found", sptr
);
1873 if (data_block
== NULL
)
1874 *((uid_t
*)(ol
->value
)) = uid
;
1876 *((uid_t
*)(US data_block
+ (long int)(ol
->value
))) = uid
;
1878 /* Set the flag indicating a fixed value is set */
1880 *(get_set_flag(name
, oltop
, last
, data_block
)) = TRUE
;
1882 /* Handle matching gid if we have a passwd entry: done by finding the
1883 same name with terminating "user" changed to "group"; if not found,
1884 ignore. Also ignore if the value is already set. */
1886 if (pw
== NULL
) break;
1887 Ustrcpy(name
+Ustrlen(name
)-4, "group");
1888 ol2
= find_option(name
, oltop
, last
);
1889 if (ol2
!= NULL
&& ((ol2
->type
& opt_mask
) == opt_gid
||
1890 (ol2
->type
& opt_mask
) == opt_expand_gid
))
1892 BOOL
*set_flag
= get_set_flag(name
, oltop
, last
, data_block
);
1895 if (data_block
== NULL
)
1896 *((gid_t
*)(ol2
->value
)) = pw
->pw_gid
;
1898 *((gid_t
*)(US data_block
+ (long int)(ol2
->value
))) = pw
->pw_gid
;
1904 /* If it was an expanded gid, see if there is any expansion to be
1905 done by checking for the presence of a $ character. If there is, save it
1906 in the corresponding *expand_user option field. Otherwise, fall through
1907 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1910 case opt_expand_gid
:
1911 sprintf(CS name2
, "*expand_%.50s", name
);
1912 ol2
= find_option(name2
, oltop
, last
);
1915 uschar
*ss
= (Ustrchr(sptr
, '$') != NULL
)? sptr
: NULL
;
1917 if (data_block
== NULL
)
1918 *((uschar
**)(ol2
->value
)) = ss
;
1920 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = ss
;
1924 *(get_set_flag(name
, oltop
, last
, data_block
)) = FALSE
;
1930 /* Handle freestanding gid */
1933 if (!route_findgroup(sptr
, &gid
))
1934 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "group %s was not found", sptr
);
1935 if (data_block
== NULL
)
1936 *((gid_t
*)(ol
->value
)) = gid
;
1938 *((gid_t
*)(US data_block
+ (long int)(ol
->value
))) = gid
;
1939 *(get_set_flag(name
, oltop
, last
, data_block
)) = TRUE
;
1942 /* If it was a uid list, look up each individual entry, and build
1943 a vector of uids, with a count in the first element. Put the vector
1944 in malloc store so we can free the string. (We are reading into
1945 permanent store already.) */
1953 const uschar
*op
= expand_string (sptr
);
1956 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to expand %s: %s",
1957 name
, expand_string_message
);
1960 if (*p
!= 0) count
++;
1961 while (*p
!= 0) if (*p
++ == ':' && *p
!= 0) count
++;
1962 list
= store_malloc(count
*sizeof(uid_t
));
1963 list
[ptr
++] = (uid_t
)(count
- 1);
1965 if (data_block
== NULL
)
1966 *((uid_t
**)(ol
->value
)) = list
;
1968 *((uid_t
**)(US data_block
+ (long int)(ol
->value
))) = list
;
1974 (void)string_nextinlist(&p
, &sep
, big_buffer
, BIG_BUFFER_SIZE
);
1975 if (!route_finduser(big_buffer
, NULL
, &uid
))
1976 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "user %s was not found",
1983 /* If it was a gid list, look up each individual entry, and build
1984 a vector of gids, with a count in the first element. Put the vector
1985 in malloc store so we can free the string. (We are reading into permanent
1994 const uschar
*op
= expand_string (sptr
);
1997 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to expand %s: %s",
1998 name
, expand_string_message
);
2001 if (*p
!= 0) count
++;
2002 while (*p
!= 0) if (*p
++ == ':' && *p
!= 0) count
++;
2003 list
= store_malloc(count
*sizeof(gid_t
));
2004 list
[ptr
++] = (gid_t
)(count
- 1);
2006 if (data_block
== NULL
)
2007 *((gid_t
**)(ol
->value
)) = list
;
2009 *((gid_t
**)(US data_block
+ (long int)(ol
->value
))) = list
;
2015 (void)string_nextinlist(&p
, &sep
, big_buffer
, BIG_BUFFER_SIZE
);
2016 if (!route_findgroup(big_buffer
, &gid
))
2017 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "group %s was not found",
2025 /* Release store if the value of the string doesn't need to be kept. */
2027 if (freesptr
) store_reset(reset_point
);
2030 /* Expanded boolean: if no characters follow, or if there are no dollar
2031 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2032 save the string for later expansion in the alternate place. */
2034 case opt_expand_bool
:
2035 if (*s
!= 0 && Ustrchr(s
, '$') != 0)
2037 sprintf(CS name2
, "*expand_%.50s", name
);
2038 ol2
= find_option(name2
, oltop
, last
);
2041 reset_point
= sptr
= read_string(s
, name
);
2042 if (data_block
== NULL
)
2043 *((uschar
**)(ol2
->value
)) = sptr
;
2045 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = sptr
;
2052 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2053 look for yes/not/true/false. Some booleans are stored in a single bit in
2054 a single int. There's a special fudge for verify settings; without a suffix
2055 they set both xx_sender and xx_recipient. The table points to the sender
2056 value; search subsequently for the recipient. There's another special case:
2057 opt_bool_set also notes when a boolean has been set. */
2061 case opt_bool_verify
:
2065 s
= readconf_readname(name2
, 64, s
);
2066 if (strcmpic(name2
, US
"true") == 0 || strcmpic(name2
, US
"yes") == 0)
2068 else if (strcmpic(name2
, US
"false") == 0 || strcmpic(name2
, US
"no") == 0)
2070 else log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2071 "\"%s\" is not a valid value for the \"%s\" option", name2
, name
);
2072 if (*s
!= 0) extra_chars_error(s
, string_sprintf("\"%s\" ", name2
),
2073 US
"for boolean option ", name
);
2076 /* Handle single-bit type. */
2078 if (type
== opt_bit
)
2080 int bit
= 1 << ((ol
->type
>> 16) & 31);
2081 int *ptr
= (data_block
== NULL
)?
2082 (int *)(ol
->value
) :
2083 (int *)(US data_block
+ (long int)ol
->value
);
2084 if (boolvalue
) *ptr
|= bit
; else *ptr
&= ~bit
;
2088 /* Handle full BOOL types */
2090 if (data_block
== NULL
)
2091 *((BOOL
*)(ol
->value
)) = boolvalue
;
2093 *((BOOL
*)(US data_block
+ (long int)(ol
->value
))) = boolvalue
;
2097 if (type
== opt_bool_verify
)
2099 sprintf(CS name2
, "%.50s_recipient", name
+ offset
);
2100 ol2
= find_option(name2
, oltop
, last
);
2103 if (data_block
== NULL
)
2104 *((BOOL
*)(ol2
->value
)) = boolvalue
;
2106 *((BOOL
*)(US data_block
+ (long int)(ol2
->value
))) = boolvalue
;
2110 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2112 else if (type
== opt_bool_set
)
2114 sprintf(CS name2
, "*set_%.50s", name
+ offset
);
2115 ol2
= find_option(name2
, oltop
, last
);
2118 if (data_block
== NULL
)
2119 *((BOOL
*)(ol2
->value
)) = TRUE
;
2121 *((BOOL
*)(US data_block
+ (long int)(ol2
->value
))) = TRUE
;
2130 inttype
= US
"octal ";
2132 /* Integer: a simple(ish) case; allow octal and hex formats, and
2133 suffixes K, M, G, and T. The different types affect output, not input. */
2142 lvalue
= strtol(CS s
, CSS
&endptr
, intbase
);
2145 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%sinteger expected for %s",
2148 if (errno
!= ERANGE
&& *endptr
)
2150 uschar
* mp
= US
"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2152 if ((mp
= Ustrchr(mp
, *endptr
)))
2157 if (lvalue
> INT_MAX
/1024 || lvalue
< INT_MIN
/1024)
2168 if (errno
== ERANGE
|| lvalue
> INT_MAX
|| lvalue
< INT_MIN
)
2169 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2170 "absolute value of integer \"%s\" is too large (overflow)", s
);
2172 while (isspace(*endptr
)) endptr
++;
2174 extra_chars_error(endptr
, inttype
, US
"integer value for ", name
);
2176 value
= (int)lvalue
;
2180 *(int *)(US data_block
+ (long int)ol
->value
) = value
;
2182 *(int *)ol
->value
= value
;
2185 /* Integer held in K: again, allow formats and suffixes as above. */
2191 int_eximarith_t lvalue
= strtol(CS s
, CSS
&endptr
, intbase
);
2194 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%sinteger expected for %s",
2197 if (errno
!= ERANGE
&& *endptr
)
2199 uschar
* mp
= US
"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2201 if ((mp
= Ustrchr(mp
, *endptr
)))
2206 if (lvalue
> EXIM_ARITH_MAX
/1024 || lvalue
< EXIM_ARITH_MIN
/1024)
2215 lvalue
= (lvalue
+ 512)/1024;
2218 if (errno
== ERANGE
) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2219 "absolute value of integer \"%s\" is too large (overflow)", s
);
2221 while (isspace(*endptr
)) endptr
++;
2223 extra_chars_error(endptr
, inttype
, US
"integer value for ", name
);
2226 *(int_eximarith_t
*)(US data_block
+ (long int)ol
->value
) = lvalue
;
2228 *(int_eximarith_t
*)ol
->value
= lvalue
;
2232 /* Fixed-point number: held to 3 decimal places. */
2235 if (sscanf(CS s
, "%d%n", &value
, &count
) != 1)
2236 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2237 "fixed-point number expected for %s", name
);
2239 if (value
< 0) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2240 "integer \"%s\" is too large (overflow)", s
);
2244 if (value
< 0) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2245 "integer \"%s\" is too large (overflow)", s
);
2247 /* We get a coverity error here for using count, as it derived
2248 from the tainted buffer pointed to by s, as parsed by sscanf().
2249 By the definition of sscanf we must be accessing between start
2250 and end of s (assuming it is nul-terminated...) so ignore the error. */
2251 /* coverity[tainted_data] */
2252 if (s
[count
] == '.')
2255 while (isdigit(s
[++count
]))
2257 value
+= (s
[count
] - '0') * d
;
2262 while (isspace(s
[count
])) count
++;
2265 extra_chars_error(s
+count
, US
"fixed-point value for ", name
, US
"");
2267 if (data_block
== NULL
)
2268 *((int *)(ol
->value
)) = value
;
2270 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2273 /* There's a special routine to read time values. */
2276 value
= readconf_readtime(s
, 0, FALSE
);
2278 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
2280 if (data_block
== NULL
)
2281 *((int *)(ol
->value
)) = value
;
2283 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2286 /* A time list is a list of colon-separated times, with the first
2287 element holding the size of the list and the second the number of
2293 int *list
= (data_block
== NULL
)?
2294 (int *)(ol
->value
) :
2295 (int *)(US data_block
+ (long int)(ol
->value
));
2297 if (*s
!= 0) for (count
= 1; count
<= list
[0] - 2; count
++)
2300 uschar
*snext
= Ustrchr(s
, ':');
2304 while (ss
> s
&& isspace(ss
[-1])) ss
--;
2307 value
= readconf_readtime(s
, terminator
, FALSE
);
2309 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
2311 if (count
> 1 && value
<= list
[count
])
2312 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2313 "time value out of order for %s", name
);
2314 list
[count
+1] = value
;
2315 if (snext
== NULL
) break;
2317 while (isspace(*s
)) s
++;
2320 if (count
> list
[0] - 2)
2321 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "too many time values for %s",
2323 if (count
> 0 && list
[2] == 0) count
= 0;
2330 void (*fn
)() = ol
->value
;
2341 /*************************************************
2342 * Print a time value *
2343 *************************************************/
2346 Argument: a time value in seconds
2347 Returns: pointer to a fixed buffer containing the time as a string,
2348 in readconf_readtime() format
2352 readconf_printtime(int t
)
2355 uschar
*p
= time_buffer
;
2372 if (w
> 0) p
+= sprintf(CS p
, "%dw", w
);
2373 if (d
> 0) p
+= sprintf(CS p
, "%dd", d
);
2374 if (h
> 0) p
+= sprintf(CS p
, "%dh", h
);
2375 if (m
> 0) p
+= sprintf(CS p
, "%dm", m
);
2376 if (s
> 0 || p
== time_buffer
) sprintf(CS p
, "%ds", s
);
2383 /*************************************************
2384 * Print an individual option value *
2385 *************************************************/
2387 /* This is used by the -bP option, so prints to the standard output.
2388 The entire options list is passed in as an argument, because some options come
2389 in pairs - typically uid/gid settings, which can either be explicit numerical
2390 values, or strings to be expanded later. If the numerical value is unset,
2391 search for "*expand_<name>" to see if there is a string equivalent.
2394 ol option entry, or NULL for an unknown option
2396 options_block NULL for main configuration options; otherwise points to
2397 a driver block; if the option doesn't have opt_public
2398 set, then options_block->options_block is where the item
2400 oltop points to the option list in which ol exists
2401 last one more than the offset of the last entry in optop
2402 no_labels do not show "foo = " at the start.
2404 Returns: boolean success
2408 print_ol(optionlist
*ol
, uschar
*name
, void *options_block
,
2409 optionlist
*oltop
, int last
, BOOL no_labels
)
2422 printf("%s is not a known option\n", name
);
2426 /* Non-admin callers cannot see options that have been flagged secure by the
2429 if (!f
.admin_user
&& ol
->type
& opt_secure
)
2432 printf("%s\n", hidden
);
2434 printf("%s = %s\n", name
, hidden
);
2438 /* Else show the value of the option */
2443 if (!(ol
->type
& opt_public
))
2444 options_block
= (void *)(((driver_instance
*)options_block
)->options_block
);
2445 value
= (void *)(US options_block
+ (long int)value
);
2448 switch(ol
->type
& opt_mask
)
2451 case opt_rewrite
: /* Show the text value */
2453 if (!no_labels
) printf("%s = ", name
);
2454 printf("%s\n", s ?
string_printing2(s
, FALSE
) : US
"");
2458 if (!no_labels
) printf("%s = ", name
);
2459 printf("%d\n", *((int *)value
));
2464 int x
= *((int *)value
);
2465 if (x
!= 0 && (x
& 1023) == 0)
2469 if ((x
& 1023) == 0)
2474 if (!no_labels
) printf("%s = ", name
);
2475 printf("%d%c\n", x
, c
);
2479 if (!no_labels
) printf("%s = ", name
);
2487 int_eximarith_t x
= *((int_eximarith_t
*)value
);
2488 if (!no_labels
) printf("%s = ", name
);
2489 if (x
== 0) printf("0\n");
2490 else if ((x
& ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH
"T\n", x
>> 30);
2491 else if ((x
& ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH
"G\n", x
>> 20);
2492 else if ((x
& ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH
"M\n", x
>> 10);
2493 else printf(PR_EXIM_ARITH
"K\n", x
);
2498 if (!no_labels
) printf("%s = ", name
);
2499 printf("%#o\n", *((int *)value
));
2502 /* Can be negative only when "unset", in which case integer */
2506 int x
= *((int *)value
);
2509 if (x
< 0) printf("%s =\n", name
); else
2511 if (!no_labels
) printf("%s = ", name
);
2512 printf("%d.", x
/1000);
2525 /* If the numerical value is unset, try for the string value */
2527 case opt_expand_uid
:
2528 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2530 sprintf(CS name2
, "*expand_%.50s", name
);
2531 if ((ol2
= find_option(name2
, oltop
, last
)))
2533 void *value2
= ol2
->value
;
2535 value2
= (void *)(US options_block
+ (long int)value2
);
2537 if (!no_labels
) printf("%s = ", name
);
2538 printf("%s\n", s ?
string_printing(s
) : US
"");
2543 /* Else fall through */
2546 if (!no_labels
) printf("%s = ", name
);
2547 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2550 if ((pw
= getpwuid(*((uid_t
*)value
))))
2551 printf("%s\n", pw
->pw_name
);
2553 printf("%ld\n", (long int)(*((uid_t
*)value
)));
2556 /* If the numerical value is unset, try for the string value */
2558 case opt_expand_gid
:
2559 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2561 sprintf(CS name2
, "*expand_%.50s", name
);
2562 if ( (ol2
= find_option(name2
, oltop
, last
))
2563 && (ol2
->type
& opt_mask
) == opt_stringptr
)
2565 void *value2
= ol2
->value
;
2567 value2
= (void *)(US options_block
+ (long int)value2
);
2569 if (!no_labels
) printf("%s = ", name
);
2570 printf("%s\n", s ?
string_printing(s
) : US
"");
2575 /* Else fall through */
2578 if (!no_labels
) printf("%s = ", name
);
2579 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2582 if ((gr
= getgrgid(*((int *)value
))))
2583 printf("%s\n", gr
->gr_name
);
2585 printf("%ld\n", (long int)(*((int *)value
)));
2589 uidlist
= *((uid_t
**)value
);
2590 if (!no_labels
) printf("%s =", name
);
2594 uschar sep
= no_labels ?
'\0' : ' ';
2595 for (i
= 1; i
<= (int)(uidlist
[0]); i
++)
2597 uschar
*name
= NULL
;
2598 if ((pw
= getpwuid(uidlist
[i
]))) name
= US pw
->pw_name
;
2599 if (sep
!= '\0') printf("%c", sep
);
2600 if (name
) printf("%s", name
);
2601 else printf("%ld", (long int)(uidlist
[i
]));
2609 gidlist
= *((gid_t
**)value
);
2610 if (!no_labels
) printf("%s =", name
);
2614 uschar sep
= no_labels ?
'\0' : ' ';
2615 for (i
= 1; i
<= (int)(gidlist
[0]); i
++)
2617 uschar
*name
= NULL
;
2618 if ((gr
= getgrgid(gidlist
[i
]))) name
= US gr
->gr_name
;
2619 if (sep
!= '\0') printf("%c", sep
);
2620 if (name
) printf("%s", name
);
2621 else printf("%ld", (long int)(gidlist
[i
]));
2629 if (!no_labels
) printf("%s = ", name
);
2630 printf("%s\n", readconf_printtime(*((int *)value
)));
2636 int *list
= (int *)value
;
2637 if (!no_labels
) printf("%s = ", name
);
2638 for (i
= 0; i
< list
[1]; i
++)
2639 printf("%s%s", i
== 0 ?
"" : ":", readconf_printtime(list
[i
+2]));
2645 printf("%s%s\n", ((*((int *)value
)) & (1 << ((ol
->type
>> 16) & 31)))?
2649 case opt_expand_bool
:
2650 sprintf(CS name2
, "*expand_%.50s", name
);
2651 if ((ol2
= find_option(name2
, oltop
, last
)) && ol2
->value
)
2653 void *value2
= ol2
->value
;
2655 value2
= (void *)(US options_block
+ (long int)value2
);
2659 if (!no_labels
) printf("%s = ", name
);
2660 printf("%s\n", string_printing(s
));
2663 /* s == NULL => string not set; fall through */
2669 case opt_bool_verify
:
2671 printf("%s%s\n", (*((BOOL
*)value
))?
"" : "no_", name
);
2679 /*************************************************
2680 * Print value from main configuration *
2681 *************************************************/
2683 /* This function, called as a result of encountering the -bP option,
2684 causes the value of any main configuration variable to be output if the
2685 second argument is NULL. There are some special values:
2687 all print all main configuration options
2688 config_file print the name of the configuration file
2689 (configure_file will still work, for backward
2691 routers print the routers' configurations
2692 transports print the transports' configuration
2693 authenticators print the authenticators' configuration
2694 macros print the macros' configuration
2695 router_list print a list of router names
2696 transport_list print a list of transport names
2697 authenticator_list print a list of authentication mechanism names
2698 macro_list print a list of macro names
2699 +name print a named list item
2700 local_scan print the local_scan options
2701 config print the configuration as it is parsed
2702 environment print the used execution environment
2704 If the second argument is not NULL, it must be one of "router", "transport",
2705 "authenticator" or "macro" in which case the first argument identifies the
2706 driver whose options are to be printed.
2709 name option name if type == NULL; else driver name
2710 type NULL or driver type name, as described above
2711 no_labels avoid the "foo = " at the start of an item
2713 Returns: Boolean success
2717 readconf_print(uschar
*name
, uschar
*type
, BOOL no_labels
)
2719 BOOL names_only
= FALSE
;
2721 optionlist
*ol2
= NULL
;
2722 driver_instance
*d
= NULL
;
2733 static uschar
*types
[] = { US
"address", US
"domain", US
"host",
2735 static tree_node
**anchors
[] = { &addresslist_anchor
, &domainlist_anchor
,
2736 &hostlist_anchor
, &localpartlist_anchor
};
2738 for (i
= 0; i
< 4; i
++)
2739 if ((t
= tree_search(*(anchors
[i
]), name
+1)))
2743 printf("%s\n", ((namedlist_block
*)(t
->data
.ptr
))->string
);
2745 printf("%slist %s = %s\n", types
[i
], name
+1,
2746 ((namedlist_block
*)(t
->data
.ptr
))->string
);
2750 printf("no address, domain, host, or local part list called \"%s\" "
2751 "exists\n", name
+1);
2756 if ( Ustrcmp(name
, "configure_file") == 0
2757 || Ustrcmp(name
, "config_file") == 0)
2759 printf("%s\n", CS config_main_filename
);
2763 if (Ustrcmp(name
, "all") == 0)
2765 for (ol
= optionlist_config
;
2766 ol
< optionlist_config
+ nelem(optionlist_config
); ol
++)
2767 if (!(ol
->type
& opt_hidden
))
2768 (void) print_ol(ol
, US ol
->name
, NULL
,
2769 optionlist_config
, nelem(optionlist_config
),
2774 if (Ustrcmp(name
, "local_scan") == 0)
2776 #ifndef LOCAL_SCAN_HAS_OPTIONS
2777 printf("local_scan() options are not supported\n");
2780 for (ol
= local_scan_options
;
2781 ol
< local_scan_options
+ local_scan_options_count
; ol
++)
2782 (void) print_ol(ol
, US ol
->name
, NULL
, local_scan_options
,
2783 local_scan_options_count
, no_labels
);
2788 if (Ustrcmp(name
, "config") == 0)
2790 print_config(f
.admin_user
, no_labels
);
2794 if (Ustrcmp(name
, "routers") == 0)
2799 else if (Ustrcmp(name
, "transports") == 0)
2801 type
= US
"transport";
2804 else if (Ustrcmp(name
, "authenticators") == 0)
2806 type
= US
"authenticator";
2809 else if (Ustrcmp(name
, "macros") == 0)
2814 else if (Ustrcmp(name
, "router_list") == 0)
2820 else if (Ustrcmp(name
, "transport_list") == 0)
2822 type
= US
"transport";
2826 else if (Ustrcmp(name
, "authenticator_list") == 0)
2828 type
= US
"authenticator";
2832 else if (Ustrcmp(name
, "macro_list") == 0)
2838 else if (Ustrcmp(name
, "environment") == 0)
2843 for (p
= USS environ
; *p
; p
++) ;
2844 qsort(environ
, p
- USS environ
, sizeof(*p
), string_compare_by_pointer
);
2846 for (p
= USS environ
; *p
; p
++)
2849 if (no_labels
&& (q
= Ustrchr(*p
, '='))) *q
= '\0';
2857 return print_ol(find_option(name
,
2858 optionlist_config
, nelem(optionlist_config
)),
2859 name
, NULL
, optionlist_config
, nelem(optionlist_config
), no_labels
);
2862 /* Handle the options for a router or transport. Skip options that are flagged
2863 as hidden. Some of these are options with names starting with '*', used for
2864 internal alternative representations of other options (which the printing
2865 function will sort out). Others are synonyms kept for backward compatibility.
2868 if (Ustrcmp(type
, "router") == 0)
2870 d
= (driver_instance
*)routers
;
2871 ol2
= optionlist_routers
;
2872 size
= optionlist_routers_size
;
2874 else if (Ustrcmp(type
, "transport") == 0)
2876 d
= (driver_instance
*)transports
;
2877 ol2
= optionlist_transports
;
2878 size
= optionlist_transports_size
;
2880 else if (Ustrcmp(type
, "authenticator") == 0)
2882 d
= (driver_instance
*)auths
;
2883 ol2
= optionlist_auths
;
2884 size
= optionlist_auths_size
;
2887 else if (Ustrcmp(type
, "macro") == 0)
2889 /* People store passwords in macros and they were previously not available
2890 for printing. So we have an admin_users restriction. */
2893 fprintf(stderr
, "exim: permission denied\n");
2896 for (m
= macros
; m
; m
= m
->next
)
2897 if (!name
|| Ustrcmp(name
, m
->name
) == 0)
2900 printf("%s\n", CS m
->name
);
2902 printf("%s\n", CS m
->replacement
);
2904 printf("%s=%s\n", CS m
->name
, CS m
->replacement
);
2908 if (!name
) return TRUE
;
2910 printf("%s %s not found\n", type
, name
);
2916 for (; d
; d
= d
->next
) printf("%s\n", CS d
->name
);
2920 /* Either search for a given driver, or print all of them */
2922 for (; d
; d
= d
->next
)
2926 printf("\n%s %s:\n", d
->name
, type
);
2927 else if (Ustrcmp(d
->name
, name
) != 0) continue;
2929 for (ol
= ol2
; ol
< ol2
+ size
; ol
++)
2930 if (!(ol
->type
& opt_hidden
))
2931 rc
|= print_ol(ol
, US ol
->name
, d
, ol2
, size
, no_labels
);
2933 for (ol
= d
->info
->options
;
2934 ol
< d
->info
->options
+ *(d
->info
->options_count
); ol
++)
2935 if (!(ol
->type
& opt_hidden
))
2936 rc
|= print_ol(ol
, US ol
->name
, d
, d
->info
->options
,
2937 *d
->info
->options_count
, no_labels
);
2939 if (name
) return rc
;
2941 if (!name
) return TRUE
;
2943 printf("%s %s not found\n", type
, name
);
2949 /*************************************************
2950 * Read a named list item *
2951 *************************************************/
2953 /* This function reads a name and a list (i.e. string). The name is used to
2954 save the list in a tree, sorted by its name. Each entry also has a number,
2955 which can be used for caching tests, but if the string contains any expansion
2956 items other than $key, the number is set negative to inhibit caching. This
2957 mechanism is used for domain, host, and address lists that are referenced by
2961 anchorp points to the tree anchor
2962 numberp points to the current number for this tree
2963 max the maximum number permitted
2964 s the text of the option line, starting immediately after the name
2966 tname the name of the list type, for messages
2972 read_named_list(tree_node
**anchorp
, int *numberp
, int max
, uschar
*s
,
2975 BOOL forcecache
= FALSE
;
2978 namedlist_block
*nb
= store_get(sizeof(namedlist_block
));
2980 if (Ustrncmp(s
, "_cache", 6) == 0)
2987 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "unrecognized configuration line");
2989 if (*numberp
>= max
)
2990 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "too many named %ss (max is %d)\n",
2993 while (isspace(*s
)) s
++;
2995 while (isalnum(*s
) || *s
== '_') s
++;
2996 t
= store_get(sizeof(tree_node
) + s
-ss
);
2997 Ustrncpy(t
->name
, ss
, s
-ss
);
2999 while (isspace(*s
)) s
++;
3001 if (!tree_insertnode(anchorp
, t
))
3002 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
3003 "duplicate name \"%s\" for a named %s", t
->name
, tname
);
3006 nb
->number
= *numberp
;
3009 if (*s
++ != '=') log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
3010 "missing '=' after \"%s\"", t
->name
);
3011 while (isspace(*s
)) s
++;
3012 nb
->string
= read_string(s
, t
->name
);
3013 nb
->cache_data
= NULL
;
3015 /* Check the string for any expansions; if any are found, mark this list
3016 uncacheable unless the user has explicited forced caching. */
3018 if (!forcecache
&& Ustrchr(nb
->string
, '$') != NULL
) nb
->number
= -1;
3024 /*************************************************
3025 * Unpick data for a rate limit *
3026 *************************************************/
3028 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3032 s string, in the form t,b,f,l
3033 where t is the threshold (integer)
3034 b is the initial delay (time)
3035 f is the multiplicative factor (fixed point)
3036 k is the maximum time (time)
3037 threshold where to store threshold
3038 base where to store base in milliseconds
3039 factor where to store factor in milliseconds
3040 limit where to store limit
3042 Returns: nothing (panics on error)
3046 unpick_ratelimit(uschar
*s
, int *threshold
, int *base
, double *factor
,
3049 uschar bstring
[16], lstring
[16];
3051 if (sscanf(CS s
, "%d, %15[0123456789smhdw.], %lf, %15s", threshold
, bstring
,
3052 factor
, lstring
) == 4)
3054 *base
= readconf_readtime(bstring
, 0, TRUE
);
3055 *limit
= readconf_readtime(lstring
, 0, TRUE
);
3056 if (*base
>= 0 && *limit
>= 0) return;
3058 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "malformed ratelimit data: %s", s
);
3064 /*************************************************
3065 * Drop privs for checking TLS config *
3066 *************************************************/
3068 /* We want to validate TLS options during readconf, but do not want to be
3069 root when we call into the TLS library, in case of library linkage errors
3070 which cause segfaults; before this check, those were always done as the Exim
3071 runtime user and it makes sense to continue with that.
3073 Assumes: tls_require_ciphers has been set, if it will be
3074 exim_user has been set, if it will be
3075 exim_group has been set, if it will be
3077 Returns: bool for "okay"; false will cause caller to immediately exit.
3082 tls_dropprivs_validate_require_cipher(BOOL nowarn
)
3084 const uschar
*errmsg
;
3087 void (*oldsignal
)(int);
3089 /* If TLS will never be used, no point checking ciphers */
3091 if ( !tls_advertise_hosts
3092 || !*tls_advertise_hosts
3093 || Ustrcmp(tls_advertise_hosts
, ":") == 0
3096 else if (!nowarn
&& !tls_certificate
)
3097 log_write(0, LOG_MAIN
,
3098 "Warning: No server certificate defined; will use a selfsigned one.\n"
3099 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3101 oldsignal
= signal(SIGCHLD
, SIG_DFL
);
3104 if ((pid
= fork()) < 0)
3105 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "fork failed for TLS check");
3109 /* in some modes, will have dropped privilege already */
3111 exim_setugid(exim_uid
, exim_gid
, FALSE
,
3112 US
"calling tls_validate_require_cipher");
3114 if ((errmsg
= tls_validate_require_cipher()))
3115 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3116 "tls_require_ciphers invalid: %s", errmsg
);
3122 rc
= waitpid(pid
, &status
, 0);
3123 } while (rc
< 0 && errno
== EINTR
);
3126 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3129 signal(SIGCHLD
, oldsignal
);
3133 #endif /* SUPPORT_TLS */
3138 /*************************************************
3139 * Read main configuration options *
3140 *************************************************/
3142 /* This function is the first to be called for configuration reading. It
3143 opens the configuration file and reads general configuration settings until
3144 it reaches the end of the configuration section. The file is then left open so
3145 that the remaining configuration data can subsequently be read if needed for
3148 The configuration file must be owned either by root or exim, and be writeable
3149 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3150 in the config file, so the test is done on the compiled in values. A slight
3151 anomaly, to be carefully documented.
3153 The name of the configuration file is taken from a list that is included in the
3154 binary of Exim. It can be altered from the command line, but if that is done,
3155 root privilege is immediately withdrawn unless the caller is root or exim.
3156 The first file on the list that exists is used.
3158 For use on multiple systems that share file systems, first look for a
3159 configuration file whose name has the current node name on the end. If that is
3160 not found, try the generic name. For really contorted configurations, that run
3161 multiple Exims with different uid settings, first try adding the effective uid
3162 before the node name. These complications are going to waste resources on most
3163 systems. Therefore they are available only when requested by compile-time
3167 readconf_main(BOOL nowarn
)
3170 struct stat statbuf
;
3171 uschar
*s
, *filename
;
3172 const uschar
*list
= config_main_filelist
;
3174 /* Loop through the possible file names */
3176 while((filename
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
)))
3179 /* Cut out all the fancy processing unless specifically wanted */
3181 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3182 uschar
*suffix
= filename
+ Ustrlen(filename
);
3184 /* Try for the node-specific file if a node name exists */
3186 #ifdef CONFIGURE_FILE_USE_NODE
3188 if (uname(&uts
) >= 0)
3190 #ifdef CONFIGURE_FILE_USE_EUID
3191 sprintf(CS suffix
, ".%ld.%.256s", (long int)original_euid
, uts
.nodename
);
3192 config_file
= Ufopen(filename
, "rb");
3193 if (config_file
== NULL
)
3194 #endif /* CONFIGURE_FILE_USE_EUID */
3196 sprintf(CS suffix
, ".%.256s", uts
.nodename
);
3197 config_file
= Ufopen(filename
, "rb");
3200 #endif /* CONFIGURE_FILE_USE_NODE */
3202 /* Otherwise, try the generic name, possibly with the euid added */
3204 #ifdef CONFIGURE_FILE_USE_EUID
3205 if (config_file
== NULL
)
3207 sprintf(CS suffix
, ".%ld", (long int)original_euid
);
3208 config_file
= Ufopen(filename
, "rb");
3210 #endif /* CONFIGURE_FILE_USE_EUID */
3212 /* Finally, try the unadorned name */
3214 if (config_file
== NULL
)
3217 config_file
= Ufopen(filename
, "rb");
3219 #else /* if neither defined */
3221 /* This is the common case when the fancy processing is not included. */
3223 config_file
= Ufopen(filename
, "rb");
3226 /* If the file does not exist, continue to try any others. For any other
3227 error, break out (and die). */
3229 if (config_file
!= NULL
|| errno
!= ENOENT
) break;
3232 /* On success, save the name for verification; config_filename is used when
3233 logging configuration errors (it changes for .included files) whereas
3234 config_main_filename is the name shown by -bP. Failure to open a configuration
3235 file is a serious disaster. */
3239 uschar
*last_slash
= Ustrrchr(filename
, '/');
3240 config_filename
= config_main_filename
= string_copy(filename
);
3242 /* The config_main_directory we need for the $config_dir expansion.
3243 config_main_filename we need for $config_file expansion.
3244 And config_dir is the directory of the current configuration, used for
3245 relative .includes. We do need to know it's name, as we change our working
3248 if (filename
[0] == '/')
3249 config_main_directory
= last_slash
== filename ? US
"/" : string_copyn(filename
, last_slash
- filename
);
3252 /* relative configuration file name: working dir + / + basename(filename) */
3254 uschar buf
[PATH_MAX
];
3257 if (os_getcwd(buf
, PATH_MAX
) == NULL
)
3259 perror("exim: getcwd");
3262 g
= string_cat(NULL
, buf
);
3264 /* If the dir does not end with a "/", append one */
3265 if (g
->s
[g
->ptr
-1] != '/')
3266 g
= string_catn(g
, US
"/", 1);
3268 /* If the config file contains a "/", extract the directory part */
3270 g
= string_catn(g
, filename
, last_slash
- filename
);
3272 config_main_directory
= string_from_gstring(g
);
3274 config_directory
= config_main_directory
;
3278 if (filename
== NULL
)
3279 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "non-existent configuration file(s): "