1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
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 static uschar
* syslog_facility_str
;
19 static void fn_smtp_receive_timeout(const uschar
*, const uschar
*);
21 /*************************************************
22 * Main configuration options *
23 *************************************************/
25 /* The list of options that can be set in the main configuration file. This
26 must be in alphabetic order because it is searched by binary chop. */
28 static optionlist optionlist_config
[] = {
29 { "*set_exim_group", opt_bool
|opt_hidden
, &exim_gid_set
},
30 { "*set_exim_user", opt_bool
|opt_hidden
, &exim_uid_set
},
31 { "*set_system_filter_group", opt_bool
|opt_hidden
, &system_filter_gid_set
},
32 { "*set_system_filter_user", opt_bool
|opt_hidden
, &system_filter_uid_set
},
33 { "accept_8bitmime", opt_bool
, &accept_8bitmime
},
34 { "acl_not_smtp", opt_stringptr
, &acl_not_smtp
},
35 #ifdef WITH_CONTENT_SCAN
36 { "acl_not_smtp_mime", opt_stringptr
, &acl_not_smtp_mime
},
38 { "acl_not_smtp_start", opt_stringptr
, &acl_not_smtp_start
},
39 { "acl_smtp_auth", opt_stringptr
, &acl_smtp_auth
},
40 { "acl_smtp_connect", opt_stringptr
, &acl_smtp_connect
},
41 { "acl_smtp_data", opt_stringptr
, &acl_smtp_data
},
43 { "acl_smtp_data_prdr", opt_stringptr
, &acl_smtp_data_prdr
},
46 { "acl_smtp_dkim", opt_stringptr
, &acl_smtp_dkim
},
48 { "acl_smtp_etrn", opt_stringptr
, &acl_smtp_etrn
},
49 { "acl_smtp_expn", opt_stringptr
, &acl_smtp_expn
},
50 { "acl_smtp_helo", opt_stringptr
, &acl_smtp_helo
},
51 { "acl_smtp_mail", opt_stringptr
, &acl_smtp_mail
},
52 { "acl_smtp_mailauth", opt_stringptr
, &acl_smtp_mailauth
},
53 #ifdef WITH_CONTENT_SCAN
54 { "acl_smtp_mime", opt_stringptr
, &acl_smtp_mime
},
56 { "acl_smtp_notquit", opt_stringptr
, &acl_smtp_notquit
},
57 { "acl_smtp_predata", opt_stringptr
, &acl_smtp_predata
},
58 { "acl_smtp_quit", opt_stringptr
, &acl_smtp_quit
},
59 { "acl_smtp_rcpt", opt_stringptr
, &acl_smtp_rcpt
},
61 { "acl_smtp_starttls", opt_stringptr
, &acl_smtp_starttls
},
63 { "acl_smtp_vrfy", opt_stringptr
, &acl_smtp_vrfy
},
64 { "add_environment", opt_stringptr
, &add_environment
},
65 { "admin_groups", opt_gidlist
, &admin_groups
},
66 { "allow_domain_literals", opt_bool
, &allow_domain_literals
},
67 { "allow_mx_to_ip", opt_bool
, &allow_mx_to_ip
},
68 { "allow_utf8_domains", opt_bool
, &allow_utf8_domains
},
69 { "auth_advertise_hosts", opt_stringptr
, &auth_advertise_hosts
},
70 { "auto_thaw", opt_time
, &auto_thaw
},
71 #ifdef WITH_CONTENT_SCAN
72 { "av_scanner", opt_stringptr
, &av_scanner
},
74 { "bi_command", opt_stringptr
, &bi_command
},
75 #ifdef EXPERIMENTAL_BRIGHTMAIL
76 { "bmi_config_file", opt_stringptr
, &bmi_config_file
},
78 { "bounce_message_file", opt_stringptr
, &bounce_message_file
},
79 { "bounce_message_text", opt_stringptr
, &bounce_message_text
},
80 { "bounce_return_body", opt_bool
, &bounce_return_body
},
81 { "bounce_return_linesize_limit", opt_mkint
, &bounce_return_linesize_limit
},
82 { "bounce_return_message", opt_bool
, &bounce_return_message
},
83 { "bounce_return_size_limit", opt_mkint
, &bounce_return_size_limit
},
84 { "bounce_sender_authentication",opt_stringptr
,&bounce_sender_authentication
},
85 { "callout_domain_negative_expire", opt_time
, &callout_cache_domain_negative_expire
},
86 { "callout_domain_positive_expire", opt_time
, &callout_cache_domain_positive_expire
},
87 { "callout_negative_expire", opt_time
, &callout_cache_negative_expire
},
88 { "callout_positive_expire", opt_time
, &callout_cache_positive_expire
},
89 { "callout_random_local_part",opt_stringptr
, &callout_random_local_part
},
90 { "check_log_inodes", opt_int
, &check_log_inodes
},
91 { "check_log_space", opt_Kint
, &check_log_space
},
92 { "check_rfc2047_length", opt_bool
, &check_rfc2047_length
},
93 { "check_spool_inodes", opt_int
, &check_spool_inodes
},
94 { "check_spool_space", opt_Kint
, &check_spool_space
},
95 { "chunking_advertise_hosts", opt_stringptr
, &chunking_advertise_hosts
},
96 { "commandline_checks_require_admin", opt_bool
,&commandline_checks_require_admin
},
97 { "daemon_smtp_port", opt_stringptr
|opt_hidden
, &daemon_smtp_port
},
98 { "daemon_smtp_ports", opt_stringptr
, &daemon_smtp_port
},
99 { "daemon_startup_retries", opt_int
, &daemon_startup_retries
},
100 { "daemon_startup_sleep", opt_time
, &daemon_startup_sleep
},
101 #ifdef EXPERIMENTAL_DCC
102 { "dcc_direct_add_header", opt_bool
, &dcc_direct_add_header
},
103 { "dccifd_address", opt_stringptr
, &dccifd_address
},
104 { "dccifd_options", opt_stringptr
, &dccifd_options
},
106 { "debug_store", opt_bool
, &debug_store
},
107 { "delay_warning", opt_timelist
, &delay_warning
},
108 { "delay_warning_condition", opt_stringptr
, &delay_warning_condition
},
109 { "deliver_drop_privilege", opt_bool
, &deliver_drop_privilege
},
110 { "deliver_queue_load_max", opt_fixed
, &deliver_queue_load_max
},
111 { "delivery_date_remove", opt_bool
, &delivery_date_remove
},
112 #ifdef ENABLE_DISABLE_FSYNC
113 { "disable_fsync", opt_bool
, &disable_fsync
},
115 { "disable_ipv6", opt_bool
, &disable_ipv6
},
117 { "dkim_verify_signers", opt_stringptr
, &dkim_verify_signers
},
119 #ifdef EXPERIMENTAL_DMARC
120 { "dmarc_forensic_sender", opt_stringptr
, &dmarc_forensic_sender
},
121 { "dmarc_history_file", opt_stringptr
, &dmarc_history_file
},
122 { "dmarc_tld_file", opt_stringptr
, &dmarc_tld_file
},
124 { "dns_again_means_nonexist", opt_stringptr
, &dns_again_means_nonexist
},
125 { "dns_check_names_pattern", opt_stringptr
, &check_dns_names_pattern
},
126 { "dns_csa_search_limit", opt_int
, &dns_csa_search_limit
},
127 { "dns_csa_use_reverse", opt_bool
, &dns_csa_use_reverse
},
128 { "dns_dnssec_ok", opt_int
, &dns_dnssec_ok
},
129 { "dns_ipv4_lookup", opt_stringptr
, &dns_ipv4_lookup
},
130 { "dns_retrans", opt_time
, &dns_retrans
},
131 { "dns_retry", opt_int
, &dns_retry
},
132 { "dns_trust_aa", opt_stringptr
, &dns_trust_aa
},
133 { "dns_use_edns0", opt_int
, &dns_use_edns0
},
134 /* This option is now a no-op, retained for compatibility */
135 { "drop_cr", opt_bool
, &drop_cr
},
136 /*********************************************************/
137 { "dsn_advertise_hosts", opt_stringptr
, &dsn_advertise_hosts
},
138 { "dsn_from", opt_stringptr
, &dsn_from
},
139 { "envelope_to_remove", opt_bool
, &envelope_to_remove
},
140 { "errors_copy", opt_stringptr
, &errors_copy
},
141 { "errors_reply_to", opt_stringptr
, &errors_reply_to
},
142 #ifndef DISABLE_EVENT
143 { "event_action", opt_stringptr
, &event_action
},
145 { "exim_group", opt_gid
, &exim_gid
},
146 { "exim_path", opt_stringptr
, &exim_path
},
147 { "exim_user", opt_uid
, &exim_uid
},
148 { "extra_local_interfaces", opt_stringptr
, &extra_local_interfaces
},
149 { "extract_addresses_remove_arguments", opt_bool
, &extract_addresses_remove_arguments
},
150 { "finduser_retries", opt_int
, &finduser_retries
},
151 { "freeze_tell", opt_stringptr
, &freeze_tell
},
152 { "gecos_name", opt_stringptr
, &gecos_name
},
153 { "gecos_pattern", opt_stringptr
, &gecos_pattern
},
155 { "gnutls_allow_auto_pkcs11", opt_bool
, &gnutls_allow_auto_pkcs11
},
156 { "gnutls_compat_mode", opt_bool
, &gnutls_compat_mode
},
158 { "header_line_maxsize", opt_int
, &header_line_maxsize
},
159 { "header_maxsize", opt_int
, &header_maxsize
},
160 { "headers_charset", opt_stringptr
, &headers_charset
},
161 { "helo_accept_junk_hosts", opt_stringptr
, &helo_accept_junk_hosts
},
162 { "helo_allow_chars", opt_stringptr
, &helo_allow_chars
},
163 { "helo_lookup_domains", opt_stringptr
, &helo_lookup_domains
},
164 { "helo_try_verify_hosts", opt_stringptr
, &helo_try_verify_hosts
},
165 { "helo_verify_hosts", opt_stringptr
, &helo_verify_hosts
},
166 { "hold_domains", opt_stringptr
, &hold_domains
},
167 { "host_lookup", opt_stringptr
, &host_lookup
},
168 { "host_lookup_order", opt_stringptr
, &host_lookup_order
},
169 { "host_reject_connection", opt_stringptr
, &host_reject_connection
},
170 { "hosts_connection_nolog", opt_stringptr
, &hosts_connection_nolog
},
172 { "hosts_proxy", opt_stringptr
, &hosts_proxy
},
174 { "hosts_treat_as_local", opt_stringptr
, &hosts_treat_as_local
},
176 { "ibase_servers", opt_stringptr
, &ibase_servers
},
178 { "ignore_bounce_errors_after", opt_time
, &ignore_bounce_errors_after
},
179 { "ignore_fromline_hosts", opt_stringptr
, &ignore_fromline_hosts
},
180 { "ignore_fromline_local", opt_bool
, &ignore_fromline_local
},
181 { "keep_environment", opt_stringptr
, &keep_environment
},
182 { "keep_malformed", opt_time
, &keep_malformed
},
184 { "ldap_ca_cert_dir", opt_stringptr
, &eldap_ca_cert_dir
},
185 { "ldap_ca_cert_file", opt_stringptr
, &eldap_ca_cert_file
},
186 { "ldap_cert_file", opt_stringptr
, &eldap_cert_file
},
187 { "ldap_cert_key", opt_stringptr
, &eldap_cert_key
},
188 { "ldap_cipher_suite", opt_stringptr
, &eldap_cipher_suite
},
189 { "ldap_default_servers", opt_stringptr
, &eldap_default_servers
},
190 { "ldap_require_cert", opt_stringptr
, &eldap_require_cert
},
191 { "ldap_start_tls", opt_bool
, &eldap_start_tls
},
192 { "ldap_version", opt_int
, &eldap_version
},
194 { "local_from_check", opt_bool
, &local_from_check
},
195 { "local_from_prefix", opt_stringptr
, &local_from_prefix
},
196 { "local_from_suffix", opt_stringptr
, &local_from_suffix
},
197 { "local_interfaces", opt_stringptr
, &local_interfaces
},
198 { "local_scan_timeout", opt_time
, &local_scan_timeout
},
199 { "local_sender_retain", opt_bool
, &local_sender_retain
},
200 { "localhost_number", opt_stringptr
, &host_number_string
},
201 { "log_file_path", opt_stringptr
, &log_file_path
},
202 { "log_selector", opt_stringptr
, &log_selector_string
},
203 { "log_timezone", opt_bool
, &log_timezone
},
204 { "lookup_open_max", opt_int
, &lookup_open_max
},
205 { "max_username_length", opt_int
, &max_username_length
},
206 { "message_body_newlines", opt_bool
, &message_body_newlines
},
207 { "message_body_visible", opt_mkint
, &message_body_visible
},
208 { "message_id_header_domain", opt_stringptr
, &message_id_domain
},
209 { "message_id_header_text", opt_stringptr
, &message_id_text
},
210 { "message_logs", opt_bool
, &message_logs
},
211 { "message_size_limit", opt_stringptr
, &message_size_limit
},
212 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
213 { "move_frozen_messages", opt_bool
, &move_frozen_messages
},
215 { "mua_wrapper", opt_bool
, &mua_wrapper
},
217 { "mysql_servers", opt_stringptr
, &mysql_servers
},
219 { "never_users", opt_uidlist
, &never_users
},
221 { "openssl_options", opt_stringptr
, &openssl_options
},
224 { "oracle_servers", opt_stringptr
, &oracle_servers
},
226 { "percent_hack_domains", opt_stringptr
, &percent_hack_domains
},
228 { "perl_at_start", opt_bool
, &opt_perl_at_start
},
229 { "perl_startup", opt_stringptr
, &opt_perl_startup
},
230 { "perl_taintmode", opt_bool
, &opt_perl_taintmode
},
233 { "pgsql_servers", opt_stringptr
, &pgsql_servers
},
235 { "pid_file_path", opt_stringptr
, &pid_file_path
},
236 { "pipelining_advertise_hosts", opt_stringptr
, &pipelining_advertise_hosts
},
238 { "prdr_enable", opt_bool
, &prdr_enable
},
240 { "preserve_message_logs", opt_bool
, &preserve_message_logs
},
241 { "primary_hostname", opt_stringptr
, &primary_hostname
},
242 { "print_topbitchars", opt_bool
, &print_topbitchars
},
243 { "process_log_path", opt_stringptr
, &process_log_path
},
244 { "prod_requires_admin", opt_bool
, &prod_requires_admin
},
245 { "qualify_domain", opt_stringptr
, &qualify_domain_sender
},
246 { "qualify_recipient", opt_stringptr
, &qualify_domain_recipient
},
247 { "queue_domains", opt_stringptr
, &queue_domains
},
248 { "queue_list_requires_admin",opt_bool
, &queue_list_requires_admin
},
249 { "queue_only", opt_bool
, &queue_only
},
250 { "queue_only_file", opt_stringptr
, &queue_only_file
},
251 { "queue_only_load", opt_fixed
, &queue_only_load
},
252 { "queue_only_load_latch", opt_bool
, &queue_only_load_latch
},
253 { "queue_only_override", opt_bool
, &queue_only_override
},
254 { "queue_run_in_order", opt_bool
, &queue_run_in_order
},
255 { "queue_run_max", opt_stringptr
, &queue_run_max
},
256 { "queue_smtp_domains", opt_stringptr
, &queue_smtp_domains
},
257 { "receive_timeout", opt_time
, &receive_timeout
},
258 { "received_header_text", opt_stringptr
, &received_header_text
},
259 { "received_headers_max", opt_int
, &received_headers_max
},
260 { "recipient_unqualified_hosts", opt_stringptr
, &recipient_unqualified_hosts
},
261 { "recipients_max", opt_int
, &recipients_max
},
262 { "recipients_max_reject", opt_bool
, &recipients_max_reject
},
264 { "redis_servers", opt_stringptr
, &redis_servers
},
266 { "remote_max_parallel", opt_int
, &remote_max_parallel
},
267 { "remote_sort_domains", opt_stringptr
, &remote_sort_domains
},
268 { "retry_data_expire", opt_time
, &retry_data_expire
},
269 { "retry_interval_max", opt_time
, &retry_interval_max
},
270 { "return_path_remove", opt_bool
, &return_path_remove
},
271 { "return_size_limit", opt_mkint
|opt_hidden
, &bounce_return_size_limit
},
272 { "rfc1413_hosts", opt_stringptr
, &rfc1413_hosts
},
273 { "rfc1413_query_timeout", opt_time
, &rfc1413_query_timeout
},
274 { "sender_unqualified_hosts", opt_stringptr
, &sender_unqualified_hosts
},
275 { "slow_lookup_log", opt_int
, &slow_lookup_log
},
276 { "smtp_accept_keepalive", opt_bool
, &smtp_accept_keepalive
},
277 { "smtp_accept_max", opt_int
, &smtp_accept_max
},
278 { "smtp_accept_max_nonmail", opt_int
, &smtp_accept_max_nonmail
},
279 { "smtp_accept_max_nonmail_hosts", opt_stringptr
, &smtp_accept_max_nonmail_hosts
},
280 { "smtp_accept_max_per_connection", opt_int
, &smtp_accept_max_per_connection
},
281 { "smtp_accept_max_per_host", opt_stringptr
, &smtp_accept_max_per_host
},
282 { "smtp_accept_queue", opt_int
, &smtp_accept_queue
},
283 { "smtp_accept_queue_per_connection", opt_int
, &smtp_accept_queue_per_connection
},
284 { "smtp_accept_reserve", opt_int
, &smtp_accept_reserve
},
285 { "smtp_active_hostname", opt_stringptr
, &raw_active_hostname
},
286 { "smtp_banner", opt_stringptr
, &smtp_banner
},
287 { "smtp_check_spool_space", opt_bool
, &smtp_check_spool_space
},
288 { "smtp_connect_backlog", opt_int
, &smtp_connect_backlog
},
289 { "smtp_enforce_sync", opt_bool
, &smtp_enforce_sync
},
290 { "smtp_etrn_command", opt_stringptr
, &smtp_etrn_command
},
291 { "smtp_etrn_serialize", opt_bool
, &smtp_etrn_serialize
},
292 { "smtp_load_reserve", opt_fixed
, &smtp_load_reserve
},
293 { "smtp_max_synprot_errors", opt_int
, &smtp_max_synprot_errors
},
294 { "smtp_max_unknown_commands",opt_int
, &smtp_max_unknown_commands
},
295 { "smtp_ratelimit_hosts", opt_stringptr
, &smtp_ratelimit_hosts
},
296 { "smtp_ratelimit_mail", opt_stringptr
, &smtp_ratelimit_mail
},
297 { "smtp_ratelimit_rcpt", opt_stringptr
, &smtp_ratelimit_rcpt
},
298 { "smtp_receive_timeout", opt_func
, &fn_smtp_receive_timeout
},
299 { "smtp_reserve_hosts", opt_stringptr
, &smtp_reserve_hosts
},
300 { "smtp_return_error_details",opt_bool
, &smtp_return_error_details
},
302 { "smtputf8_advertise_hosts", opt_stringptr
, &smtputf8_advertise_hosts
},
304 #ifdef WITH_CONTENT_SCAN
305 { "spamd_address", opt_stringptr
, &spamd_address
},
307 #ifdef EXPERIMENTAL_SPF
308 { "spf_guess", opt_stringptr
, &spf_guess
},
310 { "split_spool_directory", opt_bool
, &split_spool_directory
},
311 { "spool_directory", opt_stringptr
, &spool_directory
},
312 { "spool_wireformat", opt_bool
, &spool_wireformat
},
314 { "sqlite_lock_timeout", opt_int
, &sqlite_lock_timeout
},
316 #ifdef EXPERIMENTAL_SRS
317 { "srs_config", opt_stringptr
, &srs_config
},
318 { "srs_hashlength", opt_int
, &srs_hashlength
},
319 { "srs_hashmin", opt_int
, &srs_hashmin
},
320 { "srs_maxage", opt_int
, &srs_maxage
},
321 { "srs_secrets", opt_stringptr
, &srs_secrets
},
322 { "srs_usehash", opt_bool
, &srs_usehash
},
323 { "srs_usetimestamp", opt_bool
, &srs_usetimestamp
},
325 { "strict_acl_vars", opt_bool
, &strict_acl_vars
},
326 { "strip_excess_angle_brackets", opt_bool
, &strip_excess_angle_brackets
},
327 { "strip_trailing_dot", opt_bool
, &strip_trailing_dot
},
328 { "syslog_duplication", opt_bool
, &syslog_duplication
},
329 { "syslog_facility", opt_stringptr
, &syslog_facility_str
},
330 { "syslog_pid", opt_bool
, &syslog_pid
},
331 { "syslog_processname", opt_stringptr
, &syslog_processname
},
332 { "syslog_timestamp", opt_bool
, &syslog_timestamp
},
333 { "system_filter", opt_stringptr
, &system_filter
},
334 { "system_filter_directory_transport", opt_stringptr
,&system_filter_directory_transport
},
335 { "system_filter_file_transport",opt_stringptr
,&system_filter_file_transport
},
336 { "system_filter_group", opt_gid
, &system_filter_gid
},
337 { "system_filter_pipe_transport",opt_stringptr
,&system_filter_pipe_transport
},
338 { "system_filter_reply_transport",opt_stringptr
,&system_filter_reply_transport
},
339 { "system_filter_user", opt_uid
, &system_filter_uid
},
340 { "tcp_nodelay", opt_bool
, &tcp_nodelay
},
341 #ifdef USE_TCP_WRAPPERS
342 { "tcp_wrappers_daemon_name", opt_stringptr
, &tcp_wrappers_daemon_name
},
344 { "timeout_frozen_after", opt_time
, &timeout_frozen_after
},
345 { "timezone", opt_stringptr
, &timezone_string
},
346 { "tls_advertise_hosts", opt_stringptr
, &tls_advertise_hosts
},
348 { "tls_certificate", opt_stringptr
, &tls_certificate
},
349 { "tls_crl", opt_stringptr
, &tls_crl
},
350 { "tls_dh_max_bits", opt_int
, &tls_dh_max_bits
},
351 { "tls_dhparam", opt_stringptr
, &tls_dhparam
},
352 { "tls_eccurve", opt_stringptr
, &tls_eccurve
},
353 # ifndef DISABLE_OCSP
354 { "tls_ocsp_file", opt_stringptr
, &tls_ocsp_file
},
356 { "tls_on_connect_ports", opt_stringptr
, &tls_in
.on_connect_ports
},
357 { "tls_privatekey", opt_stringptr
, &tls_privatekey
},
358 { "tls_remember_esmtp", opt_bool
, &tls_remember_esmtp
},
359 { "tls_require_ciphers", opt_stringptr
, &tls_require_ciphers
},
360 { "tls_try_verify_hosts", opt_stringptr
, &tls_try_verify_hosts
},
361 { "tls_verify_certificates", opt_stringptr
, &tls_verify_certificates
},
362 { "tls_verify_hosts", opt_stringptr
, &tls_verify_hosts
},
364 { "trusted_groups", opt_gidlist
, &trusted_groups
},
365 { "trusted_users", opt_uidlist
, &trusted_users
},
366 { "unknown_login", opt_stringptr
, &unknown_login
},
367 { "unknown_username", opt_stringptr
, &unknown_username
},
368 { "untrusted_set_sender", opt_stringptr
, &untrusted_set_sender
},
369 { "uucp_from_pattern", opt_stringptr
, &uucp_from_pattern
},
370 { "uucp_from_sender", opt_stringptr
, &uucp_from_sender
},
371 { "warn_message_file", opt_stringptr
, &warn_message_file
},
372 { "write_rejectlog", opt_bool
, &write_rejectlog
}
376 static int optionlist_config_size
= nelem(optionlist_config
);
382 static void fn_smtp_receive_timeout(const uschar
* name
, const uschar
* str
) {/*Dummy*/}
387 options_from_list(optionlist_config
, nelem(optionlist_config
), US
"MAIN", NULL
);
393 struct auth_info
* ai
;
396 options_from_list(optionlist_auths
, optionlist_auths_size
, US
"AUTHENTICATORS", NULL
);
398 for (ai
= auths_available
; ai
->driver_name
[0]; ai
++)
400 spf(buf
, sizeof(buf
), US
"_DRIVER_AUTHENTICATOR_%T", ai
->driver_name
);
401 builtin_macro_create(buf
);
402 options_from_list(ai
->options
, (unsigned)*ai
->options_count
, US
"AUTHENTICATOR", ai
->driver_name
);
407 #else /*!MACRO_PREDEF*/
409 extern char **environ
;
411 static void save_config_line(const uschar
* line
);
412 static void save_config_position(const uschar
*file
, int line
);
413 static void print_config(BOOL admin
, BOOL terse
);
416 #define CSTATE_STACK_SIZE 10
418 const uschar
*config_directory
= NULL
;
421 /* Structure for chain (stack) of .included files */
423 typedef struct config_file_item
{
424 struct config_file_item
*next
;
425 const uschar
*filename
;
426 const uschar
*directory
;
431 /* Structure for chain of configuration lines (-bP config) */
433 typedef struct config_line_item
{
434 struct config_line_item
*next
;
438 static config_line_item
* config_lines
;
440 /* Structure of table of conditional words and their state transitions */
442 typedef struct cond_item
{
450 /* Structure of table of syslog facility names and values */
452 typedef struct syslog_fac_item
{
458 static const char * const hidden
= "<value not displayable>";
460 /* Static variables */
462 static config_file_item
*config_file_stack
= NULL
; /* For includes */
464 static uschar
*syslog_facility_str
= NULL
;
465 static uschar next_section
[24];
466 static uschar time_buffer
[24];
468 /* State variables for conditional loading (.ifdef / .else / .endif) */
470 static int cstate
= 0;
471 static int cstate_stack_ptr
= -1;
472 static int cstate_stack
[CSTATE_STACK_SIZE
];
474 /* Table of state transitions for handling conditional inclusions. There are
475 four possible state transitions:
479 .elifdef true (or .else)
482 .endif just causes the previous cstate to be popped off the stack */
484 static int next_cstate
[3][4] =
486 /* State 0: reading from file, or reading until next .else or .endif */
488 /* State 1: condition failed, skipping until next .else or .endif */
490 /* State 2: skipping until .endif */
494 /* Table of conditionals and the states to set. For each name, there are four
495 values: the length of the name (to save computing it each time), the state to
496 set if a macro was found in the line, the state to set if a macro was not found
497 in the line, and a stack manipulation setting which is:
499 -1 pull state value off the stack
500 0 don't alter the stack
501 +1 push value onto stack, before setting new state
504 static cond_item cond_list
[] = {
505 { US
"ifdef", 5, 0, 1, 1 },
506 { US
"ifndef", 6, 1, 0, 1 },
507 { US
"elifdef", 7, 2, 3, 0 },
508 { US
"elifndef", 8, 3, 2, 0 },
509 { US
"else", 4, 2, 2, 0 },
510 { US
"endif", 5, 0, 0, -1 }
513 static int cond_list_size
= sizeof(cond_list
)/sizeof(cond_item
);
515 /* Table of syslog facility names and their values */
517 static syslog_fac_item syslog_list
[] = {
518 { US
"mail", LOG_MAIL
},
519 { US
"user", LOG_USER
},
520 { US
"news", LOG_NEWS
},
521 { US
"uucp", LOG_UUCP
},
522 { US
"local0", LOG_LOCAL0
},
523 { US
"local1", LOG_LOCAL1
},
524 { US
"local2", LOG_LOCAL2
},
525 { US
"local3", LOG_LOCAL3
},
526 { US
"local4", LOG_LOCAL4
},
527 { US
"local5", LOG_LOCAL5
},
528 { US
"local6", LOG_LOCAL6
},
529 { US
"local7", LOG_LOCAL7
},
530 { US
"daemon", LOG_DAEMON
}
533 static int syslog_list_size
= sizeof(syslog_list
)/sizeof(syslog_fac_item
);
538 /*************************************************
539 * Find the name of an option *
540 *************************************************/
542 /* This function is to aid debugging. Various functions take arguments that are
543 pointer variables in the options table or in option tables for various drivers.
544 For debugging output, it is useful to be able to find the name of the option
545 which is currently being processed. This function finds it, if it exists, by
546 searching the table(s).
548 Arguments: a value that is presumed to be in the table above
549 Returns: the option name, or an empty string
553 readconf_find_option(void *p
)
557 transport_instance
*t
;
559 for (i
= 0; i
< nelem(optionlist_config
); i
++)
560 if (p
== optionlist_config
[i
].value
) return US optionlist_config
[i
].name
;
562 for (r
= routers
; r
; r
= r
->next
)
564 router_info
*ri
= r
->info
;
565 for (i
= 0; i
< *ri
->options_count
; i
++)
567 if ((ri
->options
[i
].type
& opt_mask
) != opt_stringptr
) continue;
568 if (p
== CS (r
->options_block
) + (long int)(ri
->options
[i
].value
))
569 return US ri
->options
[i
].name
;
573 for (t
= transports
; t
; t
= t
->next
)
575 transport_info
*ti
= t
->info
;
576 for (i
= 0; i
< *ti
->options_count
; i
++)
578 optionlist
* op
= &ti
->options
[i
];
579 if ((op
->type
& opt_mask
) != opt_stringptr
) continue;
580 if (p
== ( op
->type
& opt_public
582 : CS t
->options_block
584 + (long int)op
->value
)
595 /*************************************************
596 * Deal with an assignment to a macro *
597 *************************************************/
599 /* We have a new definition; append to the list.
602 name Name of the macro. Must be in storage persistent past the call
603 val Expansion result for the macro. Ditto persistence.
607 macro_create(const uschar
* name
, const uschar
* val
, BOOL command_line
)
609 macro_item
* m
= store_get(sizeof(macro_item
));
611 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val); */
613 m
->command_line
= command_line
;
614 m
->namelen
= Ustrlen(name
);
615 m
->replen
= Ustrlen(val
);
617 m
->replacement
= val
;
624 /* This function is called when a line that starts with an upper case letter is
625 encountered. The argument "line" should contain a complete logical line, and
626 start with the first letter of the macro name. The macro name and the
627 replacement text are extracted and stored. Redefinition of existing,
628 non-command line, macros is permitted using '==' instead of '='.
631 s points to the start of the logical line
637 read_macro_assignment(uschar
*s
)
644 while (isalnum(*s
) || *s
== '_')
646 if (namelen
>= sizeof(name
) - 1)
647 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
648 "macro name too long (maximum is " SIZE_T_FMT
" characters)", sizeof(name
) - 1);
649 name
[namelen
++] = *s
++;
653 while (isspace(*s
)) s
++;
655 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "malformed macro definition");
662 while (isspace(*s
)) s
++;
664 /* If an existing macro of the same name was defined on the command line, we
665 just skip this definition. It's an error to attempt to redefine a macro without
666 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
667 It is also an error to define a macro whose name begins with the name of a
668 previously defined macro. This is the requirement that make using a tree
669 for macros hard; we must check all macros for the substring. Perhaps a
670 sorted list, and a bsearch, would work?
671 Note: it is documented that the other way round works. */
673 for (m
= macros
; m
; m
= m
->next
)
675 if (Ustrcmp(m
->name
, name
) == 0)
677 if (!m
->command_line
&& !redef
)
678 log_write(0, LOG_CONFIG
|LOG_PANIC_DIE
, "macro \"%s\" is already "
679 "defined (use \"==\" if you want to redefine it", name
);
683 if (m
->namelen
< namelen
&& Ustrstr(name
, m
->name
) != NULL
)
684 log_write(0, LOG_CONFIG
|LOG_PANIC_DIE
, "\"%s\" cannot be defined as "
685 "a macro because previously defined macro \"%s\" is a substring",
688 /* We cannot have this test, because it is documented that a substring
689 macro is permitted (there is even an example).
691 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
692 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
693 * "a macro because it is a substring of previously defined macro \"%s\"",
698 /* Check for an overriding command-line definition. */
700 if (m
&& m
->command_line
) return;
702 /* Redefinition must refer to an existing macro. */
707 m
->replen
= Ustrlen(s
);
708 m
->replacement
= string_copy(s
);
711 log_write(0, LOG_CONFIG
|LOG_PANIC_DIE
, "can't redefine an undefined macro "
714 /* We have a new definition. */
716 (void) macro_create(string_copy(name
), string_copy(s
), FALSE
);
723 /*************************************************
724 * Read configuration line *
725 *************************************************/
727 /* A logical line of text is read from the configuration file into the big
728 buffer, taking account of macros, .includes, and continuations. The size of
729 big_buffer is increased if necessary. The count of configuration lines is
730 maintained. Physical input lines starting with # (ignoring leading white space,
731 and after macro replacement) and empty logical lines are always ignored.
732 Leading and trailing spaces are removed.
734 If we hit a line of the form "begin xxxx", the xxxx is placed in the
735 next_section vector, and the function returns NULL, indicating the end of a
736 configuration section. On end-of-file, NULL is returned with next_section
741 Returns: a pointer to the first non-blank in the line,
742 or NULL if eof or end of section is reached
746 get_config_line(void)
748 int startoffset
= 0; /* To first non-blank char in logical line */
749 int len
= 0; /* Of logical line so far */
755 /* Loop for handling continuation lines, skipping comments, and dealing with
760 if (Ufgets(big_buffer
+len
, big_buffer_size
-len
, config_file
) == NULL
)
762 if (config_file_stack
!= NULL
) /* EOF inside .include */
764 (void)fclose(config_file
);
765 config_file
= config_file_stack
->file
;
766 config_filename
= config_file_stack
->filename
;
767 config_directory
= config_file_stack
->directory
;
768 config_lineno
= config_file_stack
->lineno
;
769 config_file_stack
= config_file_stack
->next
;
771 save_config_position(config_filename
, config_lineno
);
775 /* EOF at top level */
777 if (cstate_stack_ptr
>= 0)
778 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
779 "Unexpected end of configuration file: .endif missing");
781 if (len
!= 0) break; /* EOF after continuation */
782 next_section
[0] = 0; /* EOF at start of logical line */
787 newlen
= len
+ Ustrlen(big_buffer
+ len
);
789 if (config_lines
&& config_lineno
== 1)
790 save_config_position(config_filename
, config_lineno
);
792 /* Handle pathologically long physical lines - yes, it did happen - by
793 extending big_buffer at this point. The code also copes with very long
796 while (newlen
== big_buffer_size
- 1 && big_buffer
[newlen
- 1] != '\n')
799 big_buffer_size
+= BIG_BUFFER_SIZE
;
800 newbuffer
= store_malloc(big_buffer_size
);
802 /* This use of strcpy is OK because we know that the string in the old
803 buffer is shorter than the new buffer. */
805 Ustrcpy(newbuffer
, big_buffer
);
806 store_free(big_buffer
);
807 big_buffer
= newbuffer
;
808 if (Ufgets(big_buffer
+newlen
, big_buffer_size
-newlen
, config_file
) == NULL
)
810 newlen
+= Ustrlen(big_buffer
+ newlen
);
813 /* Find the true start of the physical line - leading spaces are always
816 ss
= big_buffer
+ len
;
817 while (isspace(*ss
)) ss
++;
819 /* Process the physical line for macros. If this is the start of the logical
820 line, skip over initial text at the start of the line if it starts with an
821 upper case character followed by a sequence of name characters and an equals
822 sign, because that is the definition of a new macro, and we don't do
823 replacement therein. */
826 if (len
== 0 && isupper(*s
))
828 while (isalnum(*s
) || *s
== '_') s
++;
829 while (isspace(*s
)) s
++;
830 if (*s
!= '=') s
= ss
; /* Not a macro definition */
833 /* Skip leading chars which cannot start a macro name, to avoid multiple
834 pointless rescans in Ustrstr calls. */
836 while (*s
&& !isupper(*s
) && *s
!= '_') s
++;
838 /* For each defined macro, scan the line (from after XXX= if present),
839 replacing all occurrences of the macro. */
842 for (m
= macros
; m
; m
= m
->next
)
847 while ((p
= Ustrstr(t
, m
->name
)) != NULL
)
851 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, ss); */
852 /* Expand the buffer if necessary */
854 while (newlen
- m
->namelen
+ m
->replen
+ 1 > big_buffer_size
)
856 int newsize
= big_buffer_size
+ BIG_BUFFER_SIZE
;
857 uschar
*newbuffer
= store_malloc(newsize
);
858 memcpy(newbuffer
, big_buffer
, newlen
+ 1);
859 p
= newbuffer
+ (p
- big_buffer
);
860 s
= newbuffer
+ (s
- big_buffer
);
861 ss
= newbuffer
+ (ss
- big_buffer
);
862 t
= newbuffer
+ (t
- big_buffer
);
863 big_buffer_size
= newsize
;
864 store_free(big_buffer
);
865 big_buffer
= newbuffer
;
868 /* Shuffle the remaining characters up or down in the buffer before
869 copying in the replacement text. Don't rescan the replacement for this
873 if ((moveby
= m
->replen
- m
->namelen
) != 0)
875 memmove(p
+ m
->replen
, pp
, (big_buffer
+ newlen
) - pp
+ 1);
878 Ustrncpy(p
, m
->replacement
, m
->replen
);
880 while (*t
&& !isupper(*t
) && *t
!= '_') t
++;
885 /* An empty macro replacement at the start of a line could mean that ss no
886 longer points to the first non-blank character. */
888 while (isspace(*ss
)) ss
++;
890 /* Check for comment lines - these are physical lines. */
892 if (*ss
== '#') continue;
894 /* Handle conditionals, which are also applied to physical lines. Conditions
895 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
896 expansion occured on the rest of the line. A preliminary test for the leading
897 '.' saves effort on most lines. */
903 /* Search the list of conditional directives */
905 for (i
= 0; i
< cond_list_size
; i
++)
908 cond_item
*c
= cond_list
+i
;
909 if (Ustrncmp(ss
+1, c
->name
, c
->namelen
) != 0) continue;
911 /* The following character must be white space or end of string */
913 n
= ss
[1 + c
->namelen
];
914 if (n
!= ' ' && n
!= 't' && n
!= '\n' && n
!= 0) break;
916 /* .ifdef and .ifndef push the current state onto the stack, then set
917 a new one from the table. Stack overflow is an error */
921 if (cstate_stack_ptr
>= CSTATE_STACK_SIZE
- 1)
922 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
923 ".%s nested too deeply", c
->name
);
924 cstate_stack
[++cstate_stack_ptr
] = cstate
;
925 cstate
= next_cstate
[cstate
][macro_found
? c
->action1
: c
->action2
];
928 /* For any of the others, stack underflow is an error. The next state
929 comes either from the stack (.endif) or from the table. */
933 if (cstate_stack_ptr
< 0)
934 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
935 ".%s without matching .ifdef", c
->name
);
936 cstate
= (c
->pushpop
< 0)? cstate_stack
[cstate_stack_ptr
--] :
937 next_cstate
[cstate
][macro_found
? c
->action1
: c
->action2
];
940 /* Having dealt with a directive, break the loop */
945 /* If we have handled a conditional directive, continue with the next
946 physical line. Otherwise, fall through. */
948 if (i
< cond_list_size
) continue;
951 /* If the conditional state is not 0 (actively using these lines), ignore
954 if (cstate
!= 0) continue; /* Conditional skip */
956 /* Handle .include lines - these are also physical lines. */
958 if (Ustrncmp(ss
, ".include", 8) == 0 &&
960 (Ustrncmp(ss
+8, "_if_exists", 10) == 0 && isspace(ss
[18]))))
963 int include_if_exists
= isspace(ss
[8])? 0 : 10;
964 config_file_item
*save
;
967 ss
+= 9 + include_if_exists
;
968 while (isspace(*ss
)) ss
++;
969 t
= ss
+ Ustrlen(ss
);
970 while (t
> ss
&& isspace(t
[-1])) t
--;
971 if (*ss
== '\"' && t
[-1] == '\"')
978 /* We allow relative file names. For security reasons currently
979 relative names not allowed with .include_if_exists. For .include_if_exists
980 we need to check the permissions/ownership of the containing folder */
982 if (include_if_exists
) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, ".include specifies a non-"
983 "absolute path \"%s\"", ss
);
986 gstring
* g
= string_append(NULL
, 3, config_directory
, "/", ss
);
987 ss
= string_from_gstring(g
);
990 if (include_if_exists
!= 0 && (Ustat(ss
, &statbuf
) != 0)) continue;
993 save_config_position(config_filename
, config_lineno
);
994 save
= store_get(sizeof(config_file_item
));
995 save
->next
= config_file_stack
;
996 config_file_stack
= save
;
997 save
->file
= config_file
;
998 save
->filename
= config_filename
;
999 save
->directory
= config_directory
;
1000 save
->lineno
= config_lineno
;
1002 if (!(config_file
= Ufopen(ss
, "rb")))
1003 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to open included "
1004 "configuration file %s", ss
);
1006 config_filename
= string_copy(ss
);
1007 config_directory
= string_copyn(ss
, CUstrrchr(ss
, '/') - ss
);
1012 /* If this is the start of the logical line, remember where the non-blank
1013 data starts. Otherwise shuffle down continuation lines to remove leading
1017 startoffset
= ss
- big_buffer
;
1020 s
= big_buffer
+ len
;
1023 memmove(s
, ss
, (newlen
- len
) - (ss
- s
) + 1);
1028 /* Accept the new addition to the line. Remove trailing white space. */
1031 while (len
> 0 && isspace(big_buffer
[len
-1])) len
--;
1032 big_buffer
[len
] = 0;
1034 /* We are done if the line does not end in backslash and contains some data.
1035 Empty logical lines are ignored. For continuations, remove the backslash and
1036 go round the loop to read the continuation line. */
1040 if (big_buffer
[len
-1] != '\\') break; /* End of logical line */
1041 big_buffer
[--len
] = 0; /* Remove backslash */
1043 } /* Loop for reading multiple physical lines */
1045 /* We now have a logical line. Test for the end of a configuration section (or,
1046 more accurately, for the start of the next section). Place the name of the next
1047 section in next_section, and return NULL. If the name given is longer than
1048 next_section, truncate it. It will be unrecognized later, because all the known
1049 section names do fit. Leave space for pluralizing. */
1051 s
= big_buffer
+ startoffset
; /* First non-space character */
1054 save_config_line(s
);
1056 if (strncmpic(s
, US
"begin ", 6) == 0)
1059 while (isspace(*s
)) s
++;
1060 if (big_buffer
+ len
- s
> sizeof(next_section
) - 2)
1061 s
[sizeof(next_section
) - 2] = 0;
1062 Ustrcpy(next_section
, s
);
1066 /* Return the first non-blank character. */
1073 /*************************************************
1075 *************************************************/
1077 /* The yield is the pointer to the next uschar. Names longer than the
1078 output space are silently truncated. This function is also used from acl.c when
1082 name where to put the name
1086 Returns: new input pointer
1090 readconf_readname(uschar
*name
, int len
, uschar
*s
)
1093 while (isspace(*s
)) s
++;
1096 while (isalnum(*s
) || *s
== '_')
1098 if (p
< len
-1) name
[p
++] = *s
;
1103 while (isspace(*s
)) s
++;
1110 /*************************************************
1111 * Read a time value *
1112 *************************************************/
1114 /* This function is also called from outside, to read argument
1115 time values. The format of a time value is:
1117 [<n>w][<n>d][<n>h][<n>m][<n>s]
1119 as long as at least one is present. If a format error is encountered,
1120 return a negative value. The value must be terminated by the given
1125 terminator required terminating character
1126 return_msec if TRUE, allow fractional seconds and return milliseconds
1128 Returns: the time value, or -1 on syntax error
1129 value is seconds if return_msec is FALSE
1130 value is milliseconds if return_msec is TRUE
1134 readconf_readtime(const uschar
*s
, int terminator
, BOOL return_msec
)
1142 if (!isdigit(*s
)) return -1;
1143 (void)sscanf(CCS s
, "%d%n", &value
, &count
);
1148 case 'w': value
*= 7;
1149 case 'd': value
*= 24;
1150 case 'h': value
*= 60;
1151 case 'm': value
*= 60;
1156 if (!return_msec
) return -1;
1157 (void)sscanf(CCS s
, "%lf%n", &fraction
, &count
);
1159 if (*s
++ != 's') return -1;
1160 yield
+= (int)(fraction
* 1000.0);
1166 if (return_msec
) value
*= 1000;
1168 if (*s
== terminator
) return yield
;
1170 /* Control never reaches here. */
1175 /*************************************************
1176 * Read a fixed point value *
1177 *************************************************/
1179 /* The value is returned *1000
1183 terminator required terminator
1185 Returns: the value, or -1 on error
1189 readconf_readfixed(const uschar
*s
, int terminator
)
1193 if (!isdigit(*s
)) return -1;
1194 (void)sscanf(CS s
, "%d%n", &value
, &count
);
1196 yield
= value
* 1000;
1200 while (isdigit((*(++s
))))
1202 yield
+= (*s
- '0') * m
;
1207 return (*s
== terminator
)? yield
: (-1);
1212 /*************************************************
1213 * Find option in list *
1214 *************************************************/
1216 /* The lists are always in order, so binary chop can be used.
1219 name the option name to search for
1220 ol the first entry in the option list
1221 last one more than the offset of the last entry in the option list
1223 Returns: pointer to an option entry, or NULL if not found
1227 find_option(uschar
*name
, optionlist
*ol
, int last
)
1230 while (last
> first
)
1232 int middle
= (first
+ last
)/2;
1233 int c
= Ustrcmp(name
, ol
[middle
].name
);
1235 if (c
== 0) return ol
+ middle
;
1236 else if (c
> 0) first
= middle
+ 1;
1244 /*************************************************
1245 * Find a set flag in option list *
1246 *************************************************/
1248 /* Because some versions of Unix make no restrictions on the values of uids and
1249 gids (even negative ones), we cannot represent "unset" by a special value.
1250 There is therefore a separate boolean variable for each one indicating whether
1251 a value is set or not. This function returns a pointer to the boolean, given
1252 the original option name. It is a major disaster if the flag cannot be found.
1255 name the name of the uid or gid option
1256 oltop points to the start of the relevant option list
1257 last one more than the offset of the last item in the option list
1258 data_block NULL when reading main options => data values in the option
1259 list are absolute addresses; otherwise they are byte offsets
1260 in data_block (used for driver options)
1262 Returns: a pointer to the boolean flag.
1266 get_set_flag(uschar
*name
, optionlist
*oltop
, int last
, void *data_block
)
1270 sprintf(CS name2
, "*set_%.50s", name
);
1271 ol
= find_option(name2
, oltop
, last
);
1272 if (ol
== NULL
) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
1273 "Exim internal error: missing set flag for %s", name
);
1274 return (data_block
== NULL
)? (BOOL
*)(ol
->value
) :
1275 (BOOL
*)(US data_block
+ (long int)(ol
->value
));
1281 /*************************************************
1282 * Output extra characters message and die *
1283 *************************************************/
1285 /* Called when an option line has junk on the end. Sometimes this is because
1286 the sysadmin thinks comments are permitted.
1289 s points to the extra characters
1290 t1..t3 strings to insert in the log message
1292 Returns: doesn't return; dies
1296 extra_chars_error(const uschar
*s
, const uschar
*t1
, const uschar
*t2
, const uschar
*t3
)
1298 uschar
*comment
= US
"";
1299 if (*s
== '#') comment
= US
" (# is comment only at line start)";
1300 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1301 "extra characters follow %s%s%s%s", t1
, t2
, t3
, comment
);
1306 /*************************************************
1307 * Read rewrite information *
1308 *************************************************/
1310 /* Each line of rewrite information contains:
1312 . A complete address in the form user@domain, possibly with
1313 leading * for each part; or alternatively, a regex.
1315 . A replacement string (which will be expanded).
1317 . An optional sequence of one-letter flags, indicating which
1318 headers etc. to apply this rule to.
1320 All this is decoded and placed into a control block. The OR of the flags is
1321 maintained in a common word.
1324 p points to the string that makes up the rule
1325 existflags points to the overall flag word
1326 isglobal TRUE if reading global rewrite rules
1328 Returns: the control block for the parsed rule.
1331 static rewrite_rule
*
1332 readconf_one_rewrite(const uschar
*p
, int *existflags
, BOOL isglobal
)
1334 rewrite_rule
*next
= store_get(sizeof(rewrite_rule
));
1337 next
->key
= string_dequote(&p
);
1339 while (isspace(*p
)) p
++;
1341 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1342 "missing rewrite replacement string");
1345 next
->replacement
= string_dequote(&p
);
1347 while (*p
!= 0) switch (*p
++)
1349 case ' ': case '\t': break;
1351 case 'q': next
->flags
|= rewrite_quit
; break;
1352 case 'w': next
->flags
|= rewrite_whole
; break;
1354 case 'h': next
->flags
|= rewrite_all_headers
; break;
1355 case 's': next
->flags
|= rewrite_sender
; break;
1356 case 'f': next
->flags
|= rewrite_from
; break;
1357 case 't': next
->flags
|= rewrite_to
; break;
1358 case 'c': next
->flags
|= rewrite_cc
; break;
1359 case 'b': next
->flags
|= rewrite_bcc
; break;
1360 case 'r': next
->flags
|= rewrite_replyto
; break;
1362 case 'E': next
->flags
|= rewrite_all_envelope
; break;
1363 case 'F': next
->flags
|= rewrite_envfrom
; break;
1364 case 'T': next
->flags
|= rewrite_envto
; break;
1366 case 'Q': next
->flags
|= rewrite_qualify
; break;
1367 case 'R': next
->flags
|= rewrite_repeat
; break;
1370 next
->flags
|= rewrite_smtp
;
1371 if (next
->key
[0] != '^' && Ustrncmp(next
->key
, "\\N^", 3) != 0)
1372 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1373 "rewrite rule has the S flag but is not a regular expression");
1377 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1378 "unknown rewrite flag character '%c' "
1379 "(could be missing quotes round replacement item)", p
[-1]);
1383 /* If no action flags are set, set all the "normal" rewrites. */
1385 if ((next
->flags
& (rewrite_all
| rewrite_smtp
)) == 0)
1386 next
->flags
|= isglobal
? rewrite_all
: rewrite_all_headers
;
1388 /* Remember which exist, for optimization, and return the rule */
1390 *existflags
|= next
->flags
;
1397 /*************************************************
1398 * Read global rewrite information *
1399 *************************************************/
1401 /* Each line is a single rewrite rule; it is parsed into a control block
1402 by readconf_one_rewrite(), and its flags are ORed into the global flag
1403 word rewrite_existflags. */
1406 readconf_rewrites(void)
1408 rewrite_rule
**chain
= &global_rewrite_rules
;
1411 while ((p
= get_config_line()) != NULL
)
1413 rewrite_rule
*next
= readconf_one_rewrite(p
, &rewrite_existflags
, TRUE
);
1415 chain
= &(next
->next
);
1421 /*************************************************
1423 *************************************************/
1425 /* Strings are read into the normal store pool. As long we aren't too
1426 near the end of the current block, the string will just use what is necessary
1427 on the top of the stacking pool, because string_cat() uses the extension
1431 s the rest of the input line
1432 name the option name (for errors)
1434 Returns: pointer to the string
1438 read_string(const uschar
*s
, const uschar
*name
)
1443 if (*s
!= '\"') return string_copy(s
);
1446 yield
= string_dequote(&s
);
1448 if (s
== ss
+1 || s
[-1] != '\"')
1449 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1450 "missing quote at end of string value for %s", name
);
1452 if (*s
!= 0) extra_chars_error(s
, US
"string value for ", name
, US
"");
1458 /*************************************************
1459 * Custom-handler options *
1460 *************************************************/
1462 fn_smtp_receive_timeout(const uschar
* name
, const uschar
* str
)
1465 smtp_receive_timeout_s
= string_copy(str
);
1468 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1469 smtp_receive_timeout
= readconf_readtime(str
, 0, FALSE
);
1470 if (smtp_receive_timeout
< 0)
1471 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
1476 /*************************************************
1477 * Handle option line *
1478 *************************************************/
1480 /* This function is called from several places to process a line containing the
1481 setting of an option. The first argument is the line to be decoded; it has been
1482 checked not to be empty and not to start with '#'. Trailing newlines and white
1483 space have been removed. The second argument is a pointer to the list of
1484 variable names that are to be recognized, together with their types and
1485 locations, and the third argument gives the number of entries in the list.
1487 The fourth argument is a pointer to a data block. If it is NULL, then the data
1488 values in the options list are absolute addresses. Otherwise, they are byte
1489 offsets in the data block.
1491 String option data may continue onto several lines; this function reads further
1492 data from config_file if necessary.
1494 The yield of this function is normally zero. If a string continues onto
1495 multiple lines, then the data value is permitted to be followed by a comma
1496 or a semicolon (for use in drivers) and the yield is that character.
1499 buffer contains the configuration line to be handled
1500 oltop points to the start of the relevant option list
1501 last one more than the offset of the last item in the option list
1502 data_block NULL when reading main options => data values in the option
1503 list are absolute addresses; otherwise they are byte offsets
1504 in data_block when they have opt_public set; otherwise
1505 they are byte offsets in data_block->options_block.
1506 unknown_txt format string to use in panic message for unknown option;
1507 must contain %s for option name
1508 if given as NULL, don't panic on unknown option
1510 Returns: TRUE if an option was read successfully,
1511 FALSE false for an unknown option if unknown_txt == NULL,
1512 otherwise panic and die on an unknown option
1516 readconf_handle_option(uschar
*buffer
, optionlist
*oltop
, int last
,
1517 void *data_block
, uschar
*unknown_txt
)
1521 int n
, count
, type
, value
;
1525 BOOL boolvalue
= TRUE
;
1526 BOOL freesptr
= TRUE
;
1527 optionlist
*ol
, *ol2
;
1531 uschar
*inttype
= US
"";
1534 uschar
**str_target
;
1538 /* There may be leading spaces; thereafter, we expect an option name starting
1541 while (isspace(*s
)) s
++;
1543 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "option setting expected: %s", s
);
1545 /* Read the name of the option, and skip any subsequent white space. If
1546 it turns out that what we read was "hide", set the flag indicating that
1547 this is a secure option, and loop to read the next word. */
1549 for (n
= 0; n
< 2; n
++)
1551 while (isalnum(*s
) || *s
== '_')
1553 if (ptr
< sizeof(name
)-1) name
[ptr
++] = *s
;
1557 while (isspace(*s
)) s
++;
1558 if (Ustrcmp(name
, "hide") != 0) break;
1559 issecure
= opt_secure
;
1563 /* Deal with "no_" or "not_" here for booleans */
1565 if (Ustrncmp(name
, "no_", 3) == 0)
1571 if (Ustrncmp(name
, "not_", 4) == 0)
1577 /* Search the list for the given name. A non-existent name, or an option that
1578 is set twice, is a disaster. */
1580 if (!(ol
= find_option(name
+ offset
, oltop
, last
)))
1582 if (unknown_txt
== NULL
) return FALSE
;
1583 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, CS unknown_txt
, name
);
1586 if ((ol
->type
& opt_set
) && !(ol
->type
& (opt_rep_con
| opt_rep_str
)))
1587 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1588 "\"%s\" option set for the second time", name
);
1590 ol
->type
|= opt_set
| issecure
;
1591 type
= ol
->type
& opt_mask
;
1593 /* Types with data values must be followed by '='; the "no[t]_" prefix
1594 applies only to boolean values. */
1596 if (type
< opt_bool
|| type
> opt_bool_last
)
1599 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1600 "negation prefix applied to a non-boolean option");
1602 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1603 "unexpected end of line (data missing) after %s", name
);
1605 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "missing \"=\" after %s", name
);
1608 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1609 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1610 ultimately expands to one of those values. */
1612 else if (*s
!= 0 && (offset
!= 0 || *s
!= '='))
1613 extra_chars_error(s
, US
"boolean option ", name
, US
"");
1615 /* Skip white space after = */
1617 if (*s
== '=') while (isspace((*(++s
))));
1619 /* If there is a data block and the opt_public flag is not set, change
1620 the data block pointer to the private options block. */
1622 if (data_block
!= NULL
&& (ol
->type
& opt_public
) == 0)
1623 data_block
= (void *)(((driver_instance
*)data_block
)->options_block
);
1625 /* Now get the data according to the type. */
1629 /* If a string value is not enclosed in quotes, it consists of
1630 the rest of the current line, verbatim. Otherwise, string escapes
1633 A transport is specified as a string, which is then looked up in the
1634 list of transports. A search type is specified as one of a number of
1637 A set or rewrite rules for a driver is specified as a string, which is
1638 then parsed into a suitable chain of control blocks.
1640 Uids and gids are specified as strings which are then looked up in the
1641 passwd file. Lists of uids and gids are similarly specified as colon-
1642 separated strings. */
1647 case opt_expand_uid
:
1648 case opt_expand_gid
:
1653 reset_point
= sptr
= read_string(s
, name
);
1655 /* Having read a string, we now have several different ways of using it,
1656 depending on the data type, so do another switch. If keeping the actual
1657 string is not required (because it is interpreted), freesptr is set TRUE,
1658 and at the end we reset the pool. */
1662 /* If this was a string, set the variable to point to the new string,
1663 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1664 rules, we still keep the string (for printing), and parse the rules into a
1665 control block and flags word. */
1668 str_target
= data_block
? USS (US data_block
+ (long int)(ol
->value
))
1670 if (ol
->type
& opt_rep_con
)
1672 uschar
* saved_condition
;
1673 /* We already have a condition, we're conducting a crude hack to let
1674 multiple condition rules be chained together, despite storing them in
1676 *str_target
= string_copy_malloc( (saved_condition
= *str_target
)
1677 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1678 saved_condition
, sptr
)
1680 /* TODO(pdp): there is a memory leak here and just below
1681 when we set 3 or more conditions; I still don't
1682 understand the store mechanism enough to know
1683 what's the safe way to free content from an earlier store.
1684 AFAICT, stores stack, so freeing an early stored item also stores
1685 all data alloc'd after it. If we knew conditions were adjacent,
1686 we could survive that, but we don't. So I *think* we need to take
1687 another bit from opt_type to indicate "malloced"; this seems like
1688 quite a hack, especially for this one case. It also means that
1689 we can't ever reclaim the store from the *first* condition.
1691 Because we only do this once, near process start-up, I'm prepared to
1692 let this slide for the time being, even though it rankles. */
1694 else if (ol
->type
& opt_rep_str
)
1696 uschar sep_o
= Ustrncmp(name
, "headers_add", 11)==0 ? '\n' : ':';
1697 int sep_i
= -(int)sep_o
;
1698 const uschar
* list
= sptr
;
1700 gstring
* list_o
= NULL
;
1704 list_o
= string_get(Ustrlen(*str_target
) + Ustrlen(sptr
));
1705 list_o
= string_cat(list_o
, *str_target
);
1708 while ((s
= string_nextinlist(&list
, &sep_i
, NULL
, 0)))
1709 list_o
= string_append_listele(list_o
, sep_o
, s
);
1712 *str_target
= string_copy_malloc(string_from_gstring(list_o
));
1723 *USS (US data_block
+ (long int)(ol
->value
)) = sptr
;
1725 *USS (ol
->value
) = sptr
;
1727 if (type
== opt_rewrite
)
1732 rewrite_rule
**chain
;
1735 sprintf(CS name2
, "*%.50s_rules", name
);
1736 ol2
= find_option(name2
, oltop
, last
);
1737 sprintf(CS name2
, "*%.50s_flags", name
);
1738 ol3
= find_option(name2
, oltop
, last
);
1740 if (ol2
== NULL
|| ol3
== NULL
)
1741 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1742 "rewrite rules not available for driver");
1744 if (data_block
== NULL
)
1746 chain
= (rewrite_rule
**)(ol2
->value
);
1747 flagptr
= (int *)(ol3
->value
);
1751 chain
= (rewrite_rule
**)(US data_block
+ (long int)(ol2
->value
));
1752 flagptr
= (int *)(US data_block
+ (long int)(ol3
->value
));
1755 while ((p
= string_nextinlist(CUSS
&sptr
, &sep
, big_buffer
, BIG_BUFFER_SIZE
)))
1757 rewrite_rule
*next
= readconf_one_rewrite(p
, flagptr
, FALSE
);
1759 chain
= &(next
->next
);
1762 if ((*flagptr
& (rewrite_all_envelope
| rewrite_smtp
)) != 0)
1763 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "rewrite rule specifies a "
1764 "non-header rewrite - not allowed at transport time -");
1768 /* If it was an expanded uid, see if there is any expansion to be
1769 done by checking for the presence of a $ character. If there is, save it
1770 in the corresponding *expand_user option field. Otherwise, fall through
1771 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1774 case opt_expand_uid
:
1775 sprintf(CS name2
, "*expand_%.50s", name
);
1776 ol2
= find_option(name2
, oltop
, last
);
1779 uschar
*ss
= (Ustrchr(sptr
, '$') != NULL
)? sptr
: NULL
;
1781 if (data_block
== NULL
)
1782 *((uschar
**)(ol2
->value
)) = ss
;
1784 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = ss
;
1788 *(get_set_flag(name
, oltop
, last
, data_block
)) = FALSE
;
1794 /* Look up a fixed uid, and also make use of the corresponding gid
1795 if a passwd entry is returned and the gid has not been set. */
1798 if (!route_finduser(sptr
, &pw
, &uid
))
1799 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "user %s was not found", sptr
);
1800 if (data_block
== NULL
)
1801 *((uid_t
*)(ol
->value
)) = uid
;
1803 *((uid_t
*)(US data_block
+ (long int)(ol
->value
))) = uid
;
1805 /* Set the flag indicating a fixed value is set */
1807 *(get_set_flag(name
, oltop
, last
, data_block
)) = TRUE
;
1809 /* Handle matching gid if we have a passwd entry: done by finding the
1810 same name with terminating "user" changed to "group"; if not found,
1811 ignore. Also ignore if the value is already set. */
1813 if (pw
== NULL
) break;
1814 Ustrcpy(name
+Ustrlen(name
)-4, "group");
1815 ol2
= find_option(name
, oltop
, last
);
1816 if (ol2
!= NULL
&& ((ol2
->type
& opt_mask
) == opt_gid
||
1817 (ol2
->type
& opt_mask
) == opt_expand_gid
))
1819 BOOL
*set_flag
= get_set_flag(name
, oltop
, last
, data_block
);
1822 if (data_block
== NULL
)
1823 *((gid_t
*)(ol2
->value
)) = pw
->pw_gid
;
1825 *((gid_t
*)(US data_block
+ (long int)(ol2
->value
))) = pw
->pw_gid
;
1831 /* If it was an expanded gid, see if there is any expansion to be
1832 done by checking for the presence of a $ character. If there is, save it
1833 in the corresponding *expand_user option field. Otherwise, fall through
1834 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1837 case opt_expand_gid
:
1838 sprintf(CS name2
, "*expand_%.50s", name
);
1839 ol2
= find_option(name2
, oltop
, last
);
1842 uschar
*ss
= (Ustrchr(sptr
, '$') != NULL
)? sptr
: NULL
;
1844 if (data_block
== NULL
)
1845 *((uschar
**)(ol2
->value
)) = ss
;
1847 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = ss
;
1851 *(get_set_flag(name
, oltop
, last
, data_block
)) = FALSE
;
1857 /* Handle freestanding gid */
1860 if (!route_findgroup(sptr
, &gid
))
1861 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "group %s was not found", sptr
);
1862 if (data_block
== NULL
)
1863 *((gid_t
*)(ol
->value
)) = gid
;
1865 *((gid_t
*)(US data_block
+ (long int)(ol
->value
))) = gid
;
1866 *(get_set_flag(name
, oltop
, last
, data_block
)) = TRUE
;
1869 /* If it was a uid list, look up each individual entry, and build
1870 a vector of uids, with a count in the first element. Put the vector
1871 in malloc store so we can free the string. (We are reading into
1872 permanent store already.) */
1880 const uschar
*op
= expand_string (sptr
);
1883 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to expand %s: %s",
1884 name
, expand_string_message
);
1887 if (*p
!= 0) count
++;
1888 while (*p
!= 0) if (*p
++ == ':' && *p
!= 0) count
++;
1889 list
= store_malloc(count
*sizeof(uid_t
));
1890 list
[ptr
++] = (uid_t
)(count
- 1);
1892 if (data_block
== NULL
)
1893 *((uid_t
**)(ol
->value
)) = list
;
1895 *((uid_t
**)(US data_block
+ (long int)(ol
->value
))) = list
;
1901 (void)string_nextinlist(&p
, &sep
, big_buffer
, BIG_BUFFER_SIZE
);
1902 if (!route_finduser(big_buffer
, NULL
, &uid
))
1903 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "user %s was not found",
1910 /* If it was a gid list, look up each individual entry, and build
1911 a vector of gids, with a count in the first element. Put the vector
1912 in malloc store so we can free the string. (We are reading into permanent
1921 const uschar
*op
= expand_string (sptr
);
1924 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "failed to expand %s: %s",
1925 name
, expand_string_message
);
1928 if (*p
!= 0) count
++;
1929 while (*p
!= 0) if (*p
++ == ':' && *p
!= 0) count
++;
1930 list
= store_malloc(count
*sizeof(gid_t
));
1931 list
[ptr
++] = (gid_t
)(count
- 1);
1933 if (data_block
== NULL
)
1934 *((gid_t
**)(ol
->value
)) = list
;
1936 *((gid_t
**)(US data_block
+ (long int)(ol
->value
))) = list
;
1942 (void)string_nextinlist(&p
, &sep
, big_buffer
, BIG_BUFFER_SIZE
);
1943 if (!route_findgroup(big_buffer
, &gid
))
1944 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "group %s was not found",
1952 /* Release store if the value of the string doesn't need to be kept. */
1954 if (freesptr
) store_reset(reset_point
);
1957 /* Expanded boolean: if no characters follow, or if there are no dollar
1958 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1959 save the string for later expansion in the alternate place. */
1961 case opt_expand_bool
:
1962 if (*s
!= 0 && Ustrchr(s
, '$') != 0)
1964 sprintf(CS name2
, "*expand_%.50s", name
);
1965 ol2
= find_option(name2
, oltop
, last
);
1968 reset_point
= sptr
= read_string(s
, name
);
1969 if (data_block
== NULL
)
1970 *((uschar
**)(ol2
->value
)) = sptr
;
1972 *((uschar
**)(US data_block
+ (long int)(ol2
->value
))) = sptr
;
1979 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1980 look for yes/not/true/false. Some booleans are stored in a single bit in
1981 a single int. There's a special fudge for verify settings; without a suffix
1982 they set both xx_sender and xx_recipient. The table points to the sender
1983 value; search subsequently for the recipient. There's another special case:
1984 opt_bool_set also notes when a boolean has been set. */
1988 case opt_bool_verify
:
1992 s
= readconf_readname(name2
, 64, s
);
1993 if (strcmpic(name2
, US
"true") == 0 || strcmpic(name2
, US
"yes") == 0)
1995 else if (strcmpic(name2
, US
"false") == 0 || strcmpic(name2
, US
"no") == 0)
1997 else log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
1998 "\"%s\" is not a valid value for the \"%s\" option", name2
, name
);
1999 if (*s
!= 0) extra_chars_error(s
, string_sprintf("\"%s\" ", name2
),
2000 US
"for boolean option ", name
);
2003 /* Handle single-bit type. */
2005 if (type
== opt_bit
)
2007 int bit
= 1 << ((ol
->type
>> 16) & 31);
2008 int *ptr
= (data_block
== NULL
)?
2009 (int *)(ol
->value
) :
2010 (int *)(US data_block
+ (long int)ol
->value
);
2011 if (boolvalue
) *ptr
|= bit
; else *ptr
&= ~bit
;
2015 /* Handle full BOOL types */
2017 if (data_block
== NULL
)
2018 *((BOOL
*)(ol
->value
)) = boolvalue
;
2020 *((BOOL
*)(US data_block
+ (long int)(ol
->value
))) = boolvalue
;
2024 if (type
== opt_bool_verify
)
2026 sprintf(CS name2
, "%.50s_recipient", name
+ offset
);
2027 ol2
= find_option(name2
, oltop
, last
);
2030 if (data_block
== NULL
)
2031 *((BOOL
*)(ol2
->value
)) = boolvalue
;
2033 *((BOOL
*)(US data_block
+ (long int)(ol2
->value
))) = boolvalue
;
2037 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2039 else if (type
== opt_bool_set
)
2041 sprintf(CS name2
, "*set_%.50s", name
+ offset
);
2042 ol2
= find_option(name2
, oltop
, last
);
2045 if (data_block
== NULL
)
2046 *((BOOL
*)(ol2
->value
)) = TRUE
;
2048 *((BOOL
*)(US data_block
+ (long int)(ol2
->value
))) = TRUE
;
2057 inttype
= US
"octal ";
2059 /* Integer: a simple(ish) case; allow octal and hex formats, and
2060 suffixes K, M and G. The different types affect output, not input. */
2069 lvalue
= strtol(CS s
, CSS
&endptr
, intbase
);
2072 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%sinteger expected for %s",
2075 if (errno
!= ERANGE
)
2076 if (tolower(*endptr
) == 'k')
2078 if (lvalue
> INT_MAX
/1024 || lvalue
< INT_MIN
/1024) errno
= ERANGE
;
2079 else lvalue
*= 1024;
2082 else if (tolower(*endptr
) == 'm')
2084 if (lvalue
> INT_MAX
/(1024*1024) || lvalue
< INT_MIN
/(1024*1024))
2086 else lvalue
*= 1024*1024;
2089 else if (tolower(*endptr
) == 'g')
2091 if (lvalue
> INT_MAX
/(1024*1024*1024) || lvalue
< INT_MIN
/(1024*1024*1024))
2093 else lvalue
*= 1024*1024*1024;
2097 if (errno
== ERANGE
|| lvalue
> INT_MAX
|| lvalue
< INT_MIN
)
2098 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2099 "absolute value of integer \"%s\" is too large (overflow)", s
);
2101 while (isspace(*endptr
)) endptr
++;
2103 extra_chars_error(endptr
, inttype
, US
"integer value for ", name
);
2105 value
= (int)lvalue
;
2108 if (data_block
== NULL
)
2109 *((int *)(ol
->value
)) = value
;
2111 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2114 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2116 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2122 value
= strtol(CS s
, CSS
&endptr
, intbase
);
2125 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%sinteger expected for %s",
2128 if (errno
!= ERANGE
)
2129 if (tolower(*endptr
) == 'g')
2131 if (value
> INT_MAX
/(1024*1024) || value
< INT_MIN
/(1024*1024))
2137 else if (tolower(*endptr
) == 'm')
2139 if (value
> INT_MAX
/1024 || value
< INT_MIN
/1024)
2145 else if (tolower(*endptr
) == 'k')
2148 value
= (value
+ 512)/1024;
2150 if (errno
== ERANGE
) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2151 "absolute value of integer \"%s\" is too large (overflow)", s
);
2153 while (isspace(*endptr
)) endptr
++;
2155 extra_chars_error(endptr
, inttype
, US
"integer value for ", name
);
2158 if (data_block
== NULL
)
2159 *((int *)(ol
->value
)) = value
;
2161 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2164 /* Fixed-point number: held to 3 decimal places. */
2167 if (sscanf(CS s
, "%d%n", &value
, &count
) != 1)
2168 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2169 "fixed-point number expected for %s", name
);
2171 if (value
< 0) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2172 "integer \"%s\" is too large (overflow)", s
);
2176 if (value
< 0) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2177 "integer \"%s\" is too large (overflow)", s
);
2179 /* We get a coverity error here for using count, as it derived
2180 from the tainted buffer pointed to by s, as parsed by sscanf().
2181 By the definition of sscanf we must be accessing between start
2182 and end of s (assuming it is nul-terminated...) so ignore the error. */
2183 /* coverity[tainted_data] */
2184 if (s
[count
] == '.')
2187 while (isdigit(s
[++count
]))
2189 value
+= (s
[count
] - '0') * d
;
2194 while (isspace(s
[count
])) count
++;
2197 extra_chars_error(s
+count
, US
"fixed-point value for ", name
, US
"");
2199 if (data_block
== NULL
)
2200 *((int *)(ol
->value
)) = value
;
2202 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2205 /* There's a special routine to read time values. */
2208 value
= readconf_readtime(s
, 0, FALSE
);
2210 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
2212 if (data_block
== NULL
)
2213 *((int *)(ol
->value
)) = value
;
2215 *((int *)(US data_block
+ (long int)(ol
->value
))) = value
;
2218 /* A time list is a list of colon-separated times, with the first
2219 element holding the size of the list and the second the number of
2225 int *list
= (data_block
== NULL
)?
2226 (int *)(ol
->value
) :
2227 (int *)(US data_block
+ (long int)(ol
->value
));
2229 if (*s
!= 0) for (count
= 1; count
<= list
[0] - 2; count
++)
2232 uschar
*snext
= Ustrchr(s
, ':');
2236 while (ss
> s
&& isspace(ss
[-1])) ss
--;
2239 value
= readconf_readtime(s
, terminator
, FALSE
);
2241 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "invalid time value for %s",
2243 if (count
> 1 && value
<= list
[count
])
2244 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2245 "time value out of order for %s", name
);
2246 list
[count
+1] = value
;
2247 if (snext
== NULL
) break;
2249 while (isspace(*s
)) s
++;
2252 if (count
> list
[0] - 2)
2253 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "too many time values for %s",
2255 if (count
> 0 && list
[2] == 0) count
= 0;
2262 void (*fn
)() = ol
->value
;
2273 /*************************************************
2274 * Print a time value *
2275 *************************************************/
2278 Argument: a time value in seconds
2279 Returns: pointer to a fixed buffer containing the time as a string,
2280 in readconf_readtime() format
2284 readconf_printtime(int t
)
2287 uschar
*p
= time_buffer
;
2304 if (w
> 0) p
+= sprintf(CS p
, "%dw", w
);
2305 if (d
> 0) p
+= sprintf(CS p
, "%dd", d
);
2306 if (h
> 0) p
+= sprintf(CS p
, "%dh", h
);
2307 if (m
> 0) p
+= sprintf(CS p
, "%dm", m
);
2308 if (s
> 0 || p
== time_buffer
) sprintf(CS p
, "%ds", s
);
2315 /*************************************************
2316 * Print an individual option value *
2317 *************************************************/
2319 /* This is used by the -bP option, so prints to the standard output.
2320 The entire options list is passed in as an argument, because some options come
2321 in pairs - typically uid/gid settings, which can either be explicit numerical
2322 values, or strings to be expanded later. If the numerical value is unset,
2323 search for "*expand_<name>" to see if there is a string equivalent.
2326 ol option entry, or NULL for an unknown option
2328 options_block NULL for main configuration options; otherwise points to
2329 a driver block; if the option doesn't have opt_public
2330 set, then options_block->options_block is where the item
2332 oltop points to the option list in which ol exists
2333 last one more than the offset of the last entry in optop
2334 no_labels do not show "foo = " at the start.
2340 print_ol(optionlist
*ol
, uschar
*name
, void *options_block
,
2341 optionlist
*oltop
, int last
, BOOL no_labels
)
2354 printf("%s is not a known option\n", name
);
2358 /* Non-admin callers cannot see options that have been flagged secure by the
2361 if (!admin_user
&& (ol
->type
& opt_secure
) != 0)
2364 printf("%s\n", hidden
);
2366 printf("%s = %s\n", name
, hidden
);
2370 /* Else show the value of the option */
2373 if (options_block
!= NULL
)
2375 if ((ol
->type
& opt_public
) == 0)
2376 options_block
= (void *)(((driver_instance
*)options_block
)->options_block
);
2377 value
= (void *)(US options_block
+ (long int)value
);
2380 switch(ol
->type
& opt_mask
)
2383 case opt_rewrite
: /* Show the text value */
2384 s
= *((uschar
**)value
);
2385 if (!no_labels
) printf("%s = ", name
);
2386 printf("%s\n", (s
== NULL
)? US
"" : string_printing2(s
, FALSE
));
2390 if (!no_labels
) printf("%s = ", name
);
2391 printf("%d\n", *((int *)value
));
2396 int x
= *((int *)value
);
2397 if (x
!= 0 && (x
& 1023) == 0)
2401 if ((x
& 1023) == 0)
2406 if (!no_labels
) printf("%s = ", name
);
2407 printf("%d%c\n", x
, c
);
2411 if (!no_labels
) printf("%s = ", name
);
2419 int x
= *((int *)value
);
2420 if (!no_labels
) printf("%s = ", name
);
2421 if (x
== 0) printf("0\n");
2422 else if ((x
& 1023) == 0) printf("%dM\n", x
>> 10);
2423 else printf("%dK\n", x
);
2428 if (!no_labels
) printf("%s = ", name
);
2429 printf("%#o\n", *((int *)value
));
2432 /* Can be negative only when "unset", in which case integer */
2436 int x
= *((int *)value
);
2439 if (x
< 0) printf("%s =\n", name
); else
2441 if (!no_labels
) printf("%s = ", name
);
2442 printf("%d.", x
/1000);
2455 /* If the numerical value is unset, try for the string value */
2457 case opt_expand_uid
:
2458 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2460 sprintf(CS name2
, "*expand_%.50s", name
);
2461 ol2
= find_option(name2
, oltop
, last
);
2464 void *value2
= ol2
->value
;
2465 if (options_block
!= NULL
)
2466 value2
= (void *)(US options_block
+ (long int)value2
);
2467 s
= *((uschar
**)value2
);
2468 if (!no_labels
) printf("%s = ", name
);
2469 printf("%s\n", (s
== NULL
)? US
"" : string_printing(s
));
2474 /* Else fall through */
2477 if (!no_labels
) printf("%s = ", name
);
2478 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2482 pw
= getpwuid(*((uid_t
*)value
));
2484 printf("%ld\n", (long int)(*((uid_t
*)value
)));
2485 else printf("%s\n", pw
->pw_name
);
2489 /* If the numerical value is unset, try for the string value */
2491 case opt_expand_gid
:
2492 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2494 sprintf(CS name2
, "*expand_%.50s", name
);
2495 ol2
= find_option(name2
, oltop
, last
);
2496 if (ol2
!= NULL
&& (ol2
->type
& opt_mask
) == opt_stringptr
)
2498 void *value2
= ol2
->value
;
2499 if (options_block
!= NULL
)
2500 value2
= (void *)(US options_block
+ (long int)value2
);
2501 s
= *((uschar
**)value2
);
2502 if (!no_labels
) printf("%s = ", name
);
2503 printf("%s\n", (s
== NULL
)? US
"" : string_printing(s
));
2508 /* Else fall through */
2511 if (!no_labels
) printf("%s = ", name
);
2512 if (! *get_set_flag(name
, oltop
, last
, options_block
))
2516 gr
= getgrgid(*((int *)value
));
2518 printf("%ld\n", (long int)(*((int *)value
)));
2519 else printf("%s\n", gr
->gr_name
);
2524 uidlist
= *((uid_t
**)value
);
2525 if (!no_labels
) printf("%s =", name
);
2526 if (uidlist
!= NULL
)
2530 if (no_labels
) sep
= '\0';
2531 for (i
= 1; i
<= (int)(uidlist
[0]); i
++)
2533 uschar
*name
= NULL
;
2534 pw
= getpwuid(uidlist
[i
]);
2535 if (pw
!= NULL
) name
= US pw
->pw_name
;
2536 if (sep
!= '\0') printf("%c", sep
);
2537 if (name
!= NULL
) printf("%s", name
);
2538 else printf("%ld", (long int)(uidlist
[i
]));
2546 gidlist
= *((gid_t
**)value
);
2547 if (!no_labels
) printf("%s =", name
);
2548 if (gidlist
!= NULL
)
2552 if (no_labels
) sep
= '\0';
2553 for (i
= 1; i
<= (int)(gidlist
[0]); i
++)
2555 uschar
*name
= NULL
;
2556 gr
= getgrgid(gidlist
[i
]);
2557 if (gr
!= NULL
) name
= US gr
->gr_name
;
2558 if (sep
!= '\0') printf("%c", sep
);
2559 if (name
!= NULL
) printf("%s", name
);
2560 else printf("%ld", (long int)(gidlist
[i
]));
2568 if (!no_labels
) printf("%s = ", name
);
2569 printf("%s\n", readconf_printtime(*((int *)value
)));
2575 int *list
= (int *)value
;
2576 if (!no_labels
) printf("%s = ", name
);
2577 for (i
= 0; i
< list
[1]; i
++)
2578 printf("%s%s", (i
== 0)? "" : ":", readconf_printtime(list
[i
+2]));
2584 printf("%s%s\n", ((*((int *)value
)) & (1 << ((ol
->type
>> 16) & 31)))?
2588 case opt_expand_bool
:
2589 sprintf(CS name2
, "*expand_%.50s", name
);
2590 ol2
= find_option(name2
, oltop
, last
);
2591 if (ol2
!= NULL
&& ol2
->value
!= NULL
)
2593 void *value2
= ol2
->value
;
2594 if (options_block
!= NULL
)
2595 value2
= (void *)(US options_block
+ (long int)value2
);
2596 s
= *((uschar
**)value2
);
2599 if (!no_labels
) printf("%s = ", name
);
2600 printf("%s\n", string_printing(s
));
2603 /* s == NULL => string not set; fall through */
2609 case opt_bool_verify
:
2611 printf("%s%s\n", (*((BOOL
*)value
))? "" : "no_", name
);
2618 /*************************************************
2619 * Print value from main configuration *
2620 *************************************************/
2622 /* This function, called as a result of encountering the -bP option,
2623 causes the value of any main configuration variable to be output if the
2624 second argument is NULL. There are some special values:
2626 all print all main configuration options
2627 config_file print the name of the configuration file
2628 (configure_file will still work, for backward
2630 routers print the routers' configurations
2631 transports print the transports' configuration
2632 authenticators print the authenticators' configuration
2633 macros print the macros' configuration
2634 router_list print a list of router names
2635 transport_list print a list of transport names
2636 authenticator_list print a list of authentication mechanism names
2637 macro_list print a list of macro names
2638 +name print a named list item
2639 local_scan print the local_scan options
2640 config print the configuration as it is parsed
2641 environment print the used execution environment
2643 If the second argument is not NULL, it must be one of "router", "transport",
2644 "authenticator" or "macro" in which case the first argument identifies the
2645 driver whose options are to be printed.
2648 name option name if type == NULL; else driver name
2649 type NULL or driver type name, as described above
2650 no_labels avoid the "foo = " at the start of an item
2656 readconf_print(uschar
*name
, uschar
*type
, BOOL no_labels
)
2658 BOOL names_only
= FALSE
;
2660 optionlist
*ol2
= NULL
;
2661 driver_instance
*d
= NULL
;
2672 static uschar
*types
[] = { US
"address", US
"domain", US
"host",
2674 static tree_node
**anchors
[] = { &addresslist_anchor
, &domainlist_anchor
,
2675 &hostlist_anchor
, &localpartlist_anchor
};
2677 for (i
= 0; i
< 4; i
++)
2679 t
= tree_search(*(anchors
[i
]), name
+1);
2684 printf("%s\n", ((namedlist_block
*)(t
->data
.ptr
))->string
);
2686 printf("%slist %s = %s\n", types
[i
], name
+1,
2687 ((namedlist_block
*)(t
->data
.ptr
))->string
);
2692 printf("no address, domain, host, or local part list called \"%s\" "
2693 "exists\n", name
+1);
2698 if ( Ustrcmp(name
, "configure_file") == 0
2699 || Ustrcmp(name
, "config_file") == 0)
2701 printf("%s\n", CS config_main_filename
);
2705 if (Ustrcmp(name
, "all") == 0)
2707 for (ol
= optionlist_config
;
2708 ol
< optionlist_config
+ nelem(optionlist_config
); ol
++)
2710 if ((ol
->type
& opt_hidden
) == 0)
2711 print_ol(ol
, US ol
->name
, NULL
,
2712 optionlist_config
, nelem(optionlist_config
),
2718 if (Ustrcmp(name
, "local_scan") == 0)
2720 #ifndef LOCAL_SCAN_HAS_OPTIONS
2721 printf("local_scan() options are not supported\n");
2723 for (ol
= local_scan_options
;
2724 ol
< local_scan_options
+ local_scan_options_count
; ol
++)
2726 print_ol(ol
, US ol
->name
, NULL
, local_scan_options
,
2727 local_scan_options_count
, no_labels
);
2733 if (Ustrcmp(name
, "config") == 0)
2735 print_config(admin_user
, no_labels
);
2739 if (Ustrcmp(name
, "routers") == 0)
2744 else if (Ustrcmp(name
, "transports") == 0)
2746 type
= US
"transport";
2750 else if (Ustrcmp(name
, "authenticators") == 0)
2752 type
= US
"authenticator";
2756 else if (Ustrcmp(name
, "macros") == 0)
2762 else if (Ustrcmp(name
, "router_list") == 0)
2769 else if (Ustrcmp(name
, "transport_list") == 0)
2771 type
= US
"transport";
2776 else if (Ustrcmp(name
, "authenticator_list") == 0)
2778 type
= US
"authenticator";
2783 else if (Ustrcmp(name
, "macro_list") == 0)
2790 else if (Ustrcmp(name
, "environment") == 0)
2795 for (p
= USS environ
; *p
; p
++) ;
2796 qsort(environ
, p
- USS environ
, sizeof(*p
), string_compare_by_pointer
);
2798 for (p
= USS environ
; *p
; p
++)
2801 if (no_labels
&& (q
= Ustrchr(*p
, '='))) *q
= '\0';
2810 print_ol(find_option(name
, optionlist_config
, nelem(optionlist_config
)),
2811 name
, NULL
, optionlist_config
, nelem(optionlist_config
), no_labels
);
2816 /* Handle the options for a router or transport. Skip options that are flagged
2817 as hidden. Some of these are options with names starting with '*', used for
2818 internal alternative representations of other options (which the printing
2819 function will sort out). Others are synonyms kept for backward compatibility.
2822 if (Ustrcmp(type
, "router") == 0)
2824 d
= (driver_instance
*)routers
;
2825 ol2
= optionlist_routers
;
2826 size
= optionlist_routers_size
;
2828 else if (Ustrcmp(type
, "transport") == 0)
2830 d
= (driver_instance
*)transports
;
2831 ol2
= optionlist_transports
;
2832 size
= optionlist_transports_size
;
2834 else if (Ustrcmp(type
, "authenticator") == 0)
2836 d
= (driver_instance
*)auths
;
2837 ol2
= optionlist_auths
;
2838 size
= optionlist_auths_size
;
2841 else if (Ustrcmp(type
, "macro") == 0)
2843 /* People store passwords in macros and they were previously not available
2844 for printing. So we have an admin_users restriction. */
2847 fprintf(stderr
, "exim: permission denied\n");
2850 for (m
= macros
; m
; m
= m
->next
)
2851 if (!name
|| Ustrcmp(name
, m
->name
) == 0)
2854 printf("%s\n", CS m
->name
);
2856 printf("%s=%s\n", CS m
->name
, CS m
->replacement
);
2861 printf("%s %s not found\n", type
, name
);
2867 for (; d
!= NULL
; d
= d
->next
) printf("%s\n", CS d
->name
);
2871 /* Either search for a given driver, or print all of them */
2873 for (; d
!= NULL
; d
= d
->next
)
2876 printf("\n%s %s:\n", d
->name
, type
);
2877 else if (Ustrcmp(d
->name
, name
) != 0) continue;
2879 for (ol
= ol2
; ol
< ol2
+ size
; ol
++)
2881 if ((ol
->type
& opt_hidden
) == 0)
2882 print_ol(ol
, US ol
->name
, d
, ol2
, size
, no_labels
);
2885 for (ol
= d
->info
->options
;
2886 ol
< d
->info
->options
+ *(d
->info
->options_count
); ol
++)
2888 if ((ol
->type
& opt_hidden
) == 0)
2889 print_ol(ol
, US ol
->name
, d
, d
->info
->options
, *(d
->info
->options_count
), no_labels
);
2891 if (name
!= NULL
) return;
2893 if (name
!= NULL
) printf("%s %s not found\n", type
, name
);
2898 /*************************************************
2899 * Read a named list item *
2900 *************************************************/
2902 /* This function reads a name and a list (i.e. string). The name is used to
2903 save the list in a tree, sorted by its name. Each entry also has a number,
2904 which can be used for caching tests, but if the string contains any expansion
2905 items other than $key, the number is set negative to inhibit caching. This
2906 mechanism is used for domain, host, and address lists that are referenced by
2910 anchorp points to the tree anchor
2911 numberp points to the current number for this tree
2912 max the maximum number permitted
2913 s the text of the option line, starting immediately after the name
2915 tname the name of the list type, for messages
2921 read_named_list(tree_node
**anchorp
, int *numberp
, int max
, uschar
*s
,
2924 BOOL forcecache
= FALSE
;
2927 namedlist_block
*nb
= store_get(sizeof(namedlist_block
));
2929 if (Ustrncmp(s
, "_cache", 6) == 0)
2936 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "unrecognized configuration line");
2938 if (*numberp
>= max
)
2939 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "too many named %ss (max is %d)\n",
2942 while (isspace(*s
)) s
++;
2944 while (isalnum(*s
) || *s
== '_') s
++;
2945 t
= store_get(sizeof(tree_node
) + s
-ss
);
2946 Ustrncpy(t
->name
, ss
, s
-ss
);
2948 while (isspace(*s
)) s
++;
2950 if (!tree_insertnode(anchorp
, t
))
2951 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2952 "duplicate name \"%s\" for a named %s", t
->name
, tname
);
2955 nb
->number
= *numberp
;
2958 if (*s
++ != '=') log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
2959 "missing '=' after \"%s\"", t
->name
);
2960 while (isspace(*s
)) s
++;
2961 nb
->string
= read_string(s
, t
->name
);
2962 nb
->cache_data
= NULL
;
2964 /* Check the string for any expansions; if any are found, mark this list
2965 uncacheable unless the user has explicited forced caching. */
2967 if (!forcecache
&& Ustrchr(nb
->string
, '$') != NULL
) nb
->number
= -1;
2973 /*************************************************
2974 * Unpick data for a rate limit *
2975 *************************************************/
2977 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2981 s string, in the form t,b,f,l
2982 where t is the threshold (integer)
2983 b is the initial delay (time)
2984 f is the multiplicative factor (fixed point)
2985 k is the maximum time (time)
2986 threshold where to store threshold
2987 base where to store base in milliseconds
2988 factor where to store factor in milliseconds
2989 limit where to store limit
2991 Returns: nothing (panics on error)
2995 unpick_ratelimit(uschar
*s
, int *threshold
, int *base
, double *factor
,
2998 uschar bstring
[16], lstring
[16];
3000 if (sscanf(CS s
, "%d, %15[0123456789smhdw.], %lf, %15s", threshold
, bstring
,
3001 factor
, lstring
) == 4)
3003 *base
= readconf_readtime(bstring
, 0, TRUE
);
3004 *limit
= readconf_readtime(lstring
, 0, TRUE
);
3005 if (*base
>= 0 && *limit
>= 0) return;
3007 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "malformed ratelimit data: %s", s
);
3013 /*************************************************
3014 * Drop privs for checking TLS config *
3015 *************************************************/
3017 /* We want to validate TLS options during readconf, but do not want to be
3018 root when we call into the TLS library, in case of library linkage errors
3019 which cause segfaults; before this check, those were always done as the Exim
3020 runtime user and it makes sense to continue with that.
3022 Assumes: tls_require_ciphers has been set, if it will be
3023 exim_user has been set, if it will be
3024 exim_group has been set, if it will be
3026 Returns: bool for "okay"; false will cause caller to immediately exit.
3031 tls_dropprivs_validate_require_cipher(BOOL nowarn
)
3033 const uschar
*errmsg
;
3036 void (*oldsignal
)(int);
3038 /* If TLS will never be used, no point checking ciphers */
3040 if ( !tls_advertise_hosts
3041 || !*tls_advertise_hosts
3042 || Ustrcmp(tls_advertise_hosts
, ":") == 0
3045 else if (!nowarn
&& !tls_certificate
)
3046 log_write(0, LOG_MAIN
,
3047 "Warning: No server certificate defined; will use a selfsigned one.\n"
3048 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3050 oldsignal
= signal(SIGCHLD
, SIG_DFL
);
3053 if ((pid
= fork()) < 0)
3054 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "fork failed for TLS check");
3058 /* in some modes, will have dropped privilege already */
3060 exim_setugid(exim_uid
, exim_gid
, FALSE
,
3061 US
"calling tls_validate_require_cipher");
3063 if ((errmsg
= tls_validate_require_cipher()))
3064 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3065 "tls_require_ciphers invalid: %s", errmsg
);
3071 rc
= waitpid(pid
, &status
, 0);
3072 } while (rc
< 0 && errno
== EINTR
);
3075 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3078 signal(SIGCHLD
, oldsignal
);
3082 #endif /* SUPPORT_TLS */
3087 /*************************************************
3088 * Read main configuration options *
3089 *************************************************/
3091 /* This function is the first to be called for configuration reading. It
3092 opens the configuration file and reads general configuration settings until
3093 it reaches the end of the configuration section. The file is then left open so
3094 that the remaining configuration data can subsequently be read if needed for
3097 The configuration file must be owned either by root or exim, and be writeable
3098 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3099 in the config file, so the test is done on the compiled in values. A slight
3100 anomaly, to be carefully documented.
3102 The name of the configuration file is taken from a list that is included in the
3103 binary of Exim. It can be altered from the command line, but if that is done,
3104 root privilege is immediately withdrawn unless the caller is root or exim.
3105 The first file on the list that exists is used.
3107 For use on multiple systems that share file systems, first look for a
3108 configuration file whose name has the current node name on the end. If that is
3109 not found, try the generic name. For really contorted configurations, that run
3110 multiple Exims with different uid settings, first try adding the effective uid
3111 before the node name. These complications are going to waste resources on most
3112 systems. Therefore they are available only when requested by compile-time
3116 readconf_main(BOOL nowarn
)
3119 struct stat statbuf
;
3120 uschar
*s
, *filename
;
3121 const uschar
*list
= config_main_filelist
;
3123 /* Loop through the possible file names */
3125 while((filename
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
)))
3128 /* Cut out all the fancy processing unless specifically wanted */
3130 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3131 uschar
*suffix
= filename
+ Ustrlen(filename
);
3133 /* Try for the node-specific file if a node name exists */
3135 #ifdef CONFIGURE_FILE_USE_NODE
3137 if (uname(&uts
) >= 0)
3139 #ifdef CONFIGURE_FILE_USE_EUID
3140 sprintf(CS suffix
, ".%ld.%.256s", (long int)original_euid
, uts
.nodename
);
3141 config_file
= Ufopen(filename
, "rb");
3142 if (config_file
== NULL
)
3143 #endif /* CONFIGURE_FILE_USE_EUID */
3145 sprintf(CS suffix
, ".%.256s", uts
.nodename
);
3146 config_file
= Ufopen(filename
, "rb");
3149 #endif /* CONFIGURE_FILE_USE_NODE */
3151 /* Otherwise, try the generic name, possibly with the euid added */
3153 #ifdef CONFIGURE_FILE_USE_EUID
3154 if (config_file
== NULL
)
3156 sprintf(CS suffix
, ".%ld", (long int)original_euid
);
3157 config_file
= Ufopen(filename
, "rb");
3159 #endif /* CONFIGURE_FILE_USE_EUID */
3161 /* Finally, try the unadorned name */
3163 if (config_file
== NULL
)
3166 config_file
= Ufopen(filename
, "rb");
3168 #else /* if neither defined */
3170 /* This is the common case when the fancy processing is not included. */
3172 config_file
= Ufopen(filename
, "rb");
3175 /* If the file does not exist, continue to try any others. For any other
3176 error, break out (and die). */
3178 if (config_file
!= NULL
|| errno
!= ENOENT
) break;
3181 /* On success, save the name for verification; config_filename is used when
3182 logging configuration errors (it changes for .included files) whereas
3183 config_main_filename is the name shown by -bP. Failure to open a configuration
3184 file is a serious disaster. */
3188 uschar
*last_slash
= Ustrrchr(filename
, '/');
3189 config_filename
= config_main_filename
= string_copy(filename
);
3191 /* The config_main_directory we need for the $config_dir expansion.
3192 config_main_filename we need for $config_file expansion.
3193 And config_dir is the directory of the current configuration, used for
3194 relative .includes. We do need to know it's name, as we change our working
3197 if (filename
[0] == '/')
3198 config_main_directory
= last_slash
== filename
? US
"/" : string_copyn(filename
, last_slash
- filename
);
3201 /* relative configuration file name: working dir + / + basename(filename) */
3203 uschar buf
[PATH_MAX
];
3206 if (os_getcwd(buf
, PATH_MAX
) == NULL
)
3208 perror("exim: getcwd");
3211 g
= string_cat(NULL
, buf
);
3213 /* If the dir does not end with a "/", append one */
3214 if (g
->s
[g
->ptr
-1] != '/')
3215 g
= string_catn(g
, US
"/", 1);
3217 /* If the config file contains a "/", extract the directory part */
3219 g
= string_catn(g
, filename
, last_slash
- filename
);
3221 config_main_directory
= string_from_gstring(g
);
3223 config_directory
= config_main_directory
;
3227 if (filename
== NULL
)
3228 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "non-existent configuration file(s): "
3229 "%s", config_main_filelist
);
3231 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s", string_open_failed(errno
,
3232 "configuration file %s", filename
));
3235 /* Now, once we found and opened our configuration file, we change the directory
3236 to a safe place. Later we change to $spool_directory. */
3238 if (Uchdir("/") < 0)
3240 perror("exim: chdir `/': ");
3244 /* Check the status of the file we have opened, if we have retained root
3245 privileges and the file isn't /dev/null (which *should* be 0666). */
3247 if (trusted_config
&& Ustrcmp(filename
, US
"/dev/null"))
3249 if (fstat(fileno(config_file
), &statbuf
) != 0)
3250 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "failed to stat configuration file %s",
3253 if ((statbuf
.st_uid
!= root_uid
/* owner not root */
3254 #ifdef CONFIGURE_OWNER
3255 && statbuf
.st_uid
!= config_uid
/* owner not the special one */
3258 (statbuf
.st_gid
!= root_gid
/* group not root & */
3259 #ifdef CONFIGURE_GROUP
3260 && statbuf
.st_gid
!= config_gid
/* group not the special one */
3262 && (statbuf
.st_mode
& 020) != 0) || /* group writeable */
3264 ((statbuf
.st_mode
& 2) != 0)) /* world writeable */
3266 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Exim configuration file %s has the "
3267 "wrong owner, group, or mode", big_buffer
);
3270 /* Process the main configuration settings. They all begin with a lower case
3271 letter. If we see something starting with an upper case letter, it is taken as
3272 a macro definition. */
3274 while ((s
= get_config_line()))
3276 if (config_lineno
== 1 && Ustrstr(s
, "\xef\xbb\xbf") == s
)
3277 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
3278 "found unexpected BOM (Byte Order Mark)");
3280 if (isupper(s
[0])) read_macro_assignment(s
);
3282 else if (Ustrncmp(s
, "domainlist", 10) == 0)
3283 read_named_list(&domainlist_anchor
, &domainlist_count
,
3284 MAX_NAMED_LIST
, s
+10, US
"domain list");
3286 else if (Ustrncmp(s
, "hostlist", 8) == 0)
3287 read_named_list(&hostlist_anchor
, &hostlist_count
,
3288 MAX_NAMED_LIST
, s
+8, US
"host list");
3290 else if (Ustrncmp(s
, US
"addresslist", 11) == 0)
3291 read_named_list(&addresslist_anchor
, &addresslist_count
,
3292 MAX_NAMED_LIST
, s
+11, US
"address list");
3294 else if (Ustrncmp(s
, US
"localpartlist", 13) == 0)
3295 read_named_list(&localpartlist_anchor
, &localpartlist_count
,
3296 MAX_NAMED_LIST
, s
+13, US
"local part list");
3299 (void) readconf_handle_option(s
, optionlist_config
, optionlist_config_size
,
3300 NULL
, US
"main option \"%s\" unknown");
3304 /* If local_sender_retain is set, local_from_check must be unset. */
3306 if (local_sender_retain
&& local_from_check
)
3307 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "both local_from_check and "
3308 "local_sender_retain are set; this combination is not allowed");
3310 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3313 if (timezone_string
!= NULL
&& *timezone_string
== 0) timezone_string
= NULL
;
3315 /* The max retry interval must not be greater than 24 hours. */
3317 if (retry_interval_max
> 24*60*60) retry_interval_max
= 24*60*60;
3319 /* remote_max_parallel must be > 0 */
3321 if (remote_max_parallel
<= 0) remote_max_parallel
= 1;
3323 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3324 start of a new SMTP message. */
3326 freeze_tell_config
= freeze_tell
;
3328 /* The primary host name may be required for expansion of spool_directory
3329 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3330 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3331 canonize it. Some people like upper case letters in their host names, so we
3332 don't force the case. */
3334 if (primary_hostname
== NULL
)
3336 const uschar
*hostname
;
3338 if (uname(&uts
) < 0)
3339 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "uname() failed to yield host name");
3340 hostname
= US uts
.nodename
;
3342 if (Ustrchr(hostname
, '.') == NULL
)
3345 struct hostent
*hostdata
;
3348 if (!disable_ipv6
&& (dns_ipv4_lookup
== NULL
||
3349 match_isinlist(hostname
, CUSS
&dns_ipv4_lookup
, 0, NULL
, NULL
,
3350 MCL_DOMAIN
, TRUE
, NULL
) != OK
))
3359 #if HAVE_GETIPNODEBYNAME
3361 hostdata
= getipnodebyname(CS hostname
, af
, 0, &error_num
);
3363 hostdata
= gethostbyname2(CS hostname
, af
);
3366 hostdata
= gethostbyname(CS hostname
);
3369 if (hostdata
!= NULL
)
3371 hostname
= US hostdata
->h_name
;
3375 if (af
== AF_INET
) break;
3380 primary_hostname
= string_copy(hostname
);
3383 /* Set up default value for smtp_active_hostname */
3385 smtp_active_hostname
= primary_hostname
;
3387 /* If spool_directory wasn't set in the build-time configuration, it must have
3388 got set above. Of course, writing to the log may not work if log_file_path is
3389 not set, but it will at least get to syslog or somewhere, with any luck. */
3391 if (*spool_directory
== 0)
3392 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "spool_directory undefined: cannot "
3395 /* Expand the spool directory name; it may, for example, contain the primary
3396 host name. Same comment about failure. */
3398 s
= expand_string(spool_directory
);
3400 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "failed to expand spool_directory "
3401 "\"%s\": %s", spool_directory
, expand_string_message
);
3402 spool_directory
= s
;
3404 /* Expand log_file_path, which must contain "%s" in any component that isn't
3405 the null string or "syslog". It is also allowed to contain one instance of %D
3406 or %M. However, it must NOT contain % followed by anything else. */
3408 if (*log_file_path
!= 0)
3410 const uschar
*ss
, *sss
;
3411 int sep
= ':'; /* Fixed for log file path */
3412 s
= expand_string(log_file_path
);
3414 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "failed to expand log_file_path "
3415 "\"%s\": %s", log_file_path
, expand_string_message
);
3418 while ((sss
= string_nextinlist(&ss
,&sep
,big_buffer
,big_buffer_size
)) != NULL
)
3421 if (sss
[0] == 0 || Ustrcmp(sss
, "syslog") == 0) continue;
3422 t
= Ustrstr(sss
, "%s");
3424 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "log_file_path \"%s\" does not "
3425 "contain \"%%s\"", sss
);
3427 t
= Ustrchr(sss
, '%');
3430 if ((t
[1] != 'D' && t
[1] != 'M') || Ustrchr(t
+2, '%') != NULL
)
3431 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "log_file_path \"%s\" contains "
3432 "unexpected \"%%\" character", s
);
3439 /* Interpret syslog_facility into an integer argument for 'ident' param to
3440 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3443 if (syslog_facility_str
)
3446 uschar
*s
= syslog_facility_str
;
3448 if ((Ustrlen(syslog_facility_str
) >= 4) &&
3449 (strncmpic(syslog_facility_str
, US
"log_", 4) == 0))
3452 for (i
= 0; i
< syslog_list_size
; i
++)
3453 if (strcmpic(s
, syslog_list
[i
].name
) == 0)
3455 syslog_facility
= syslog_list
[i
].value
;
3459 if (i
>= syslog_list_size
)
3460 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3461 "failed to interpret syslog_facility \"%s\"", syslog_facility_str
);
3464 /* Expand pid_file_path */
3466 if (*pid_file_path
!= 0)
3468 if (!(s
= expand_string(pid_file_path
)))
3469 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "failed to expand pid_file_path "
3470 "\"%s\": %s", pid_file_path
, expand_string_message
);
3474 /* Set default value of process_log_path */
3476 if (!process_log_path
|| *process_log_path
=='\0')
3477 process_log_path
= string_sprintf("%s/exim-process.info", spool_directory
);
3479 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3482 regex_From
= regex_must_compile(uucp_from_pattern
, FALSE
, TRUE
);
3484 /* Unpick the SMTP rate limiting options, if set */
3486 if (smtp_ratelimit_mail
)
3487 unpick_ratelimit(smtp_ratelimit_mail
, &smtp_rlm_threshold
,
3488 &smtp_rlm_base
, &smtp_rlm_factor
, &smtp_rlm_limit
);
3490 if (smtp_ratelimit_rcpt
)
3491 unpick_ratelimit(smtp_ratelimit_rcpt
, &smtp_rlr_threshold
,
3492 &smtp_rlr_base
, &smtp_rlr_factor
, &smtp_rlr_limit
);
3494 /* The qualify domains default to the primary host name */
3496 if (!qualify_domain_sender
)
3497 qualify_domain_sender
= primary_hostname
;
3498 if (!qualify_domain_recipient
)
3499 qualify_domain_recipient
= qualify_domain_sender
;
3501 /* Setting system_filter_user in the configuration sets the gid as well if a
3502 name is given, but a numerical value does not. */
3504 if (system_filter_uid_set
&& !system_filter_gid_set
)
3506 struct passwd
*pw
= getpwuid(system_filter_uid
);
3508 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Failed to look up uid %ld",
3509 (long int)system_filter_uid
);
3510 system_filter_gid
= pw
->pw_gid
;
3511 system_filter_gid_set
= TRUE
;
3514 /* If the errors_reply_to field is set, check that it is syntactically valid
3515 and ensure it contains a domain. */
3517 if (errors_reply_to
)
3520 int start
, end
, domain
;
3521 uschar
*recipient
= parse_extract_address(errors_reply_to
, &errmess
,
3522 &start
, &end
, &domain
, FALSE
);
3525 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3526 "error in errors_reply_to (%s): %s", errors_reply_to
, errmess
);
3529 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3530 "errors_reply_to (%s) does not contain a domain", errors_reply_to
);
3533 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3534 smtp_accept_max must also be set. */
3536 if (smtp_accept_max
== 0 &&
3537 (smtp_accept_queue
> 0 || smtp_accept_max_per_host
!= NULL
))
3538 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3539 "smtp_accept_max must be set if smtp_accept_queue or "
3540 "smtp_accept_max_per_host is set");
3542 /* Set up the host number if anything is specified. It is an expanded string
3543 so that it can be computed from the host name, for example. We do this last
3544 so as to ensure that everything else is set up before the expansion. */
3546 if (host_number_string
)
3550 uschar
*s
= expand_string(host_number_string
);
3553 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
3554 "failed to expand localhost_number \"%s\": %s",
3555 host_number_string
, expand_string_message
);
3556 n
= Ustrtol(s
, &end
, 0);
3557 while (isspace(*end
)) end
++;
3559 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3560 "localhost_number value is not a number: %s", s
);
3561 if (n
> LOCALHOST_MAX
)
3562 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3563 "localhost_number is greater than the maximum allowed value (%d)",
3569 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3571 if ((tls_verify_hosts
|| tls_try_verify_hosts
) && !tls_verify_certificates
)
3572 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3573 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3574 tls_verify_hosts
? "" : "try_");
3576 /* This also checks that the library linkage is working and we can call
3577 routines in it, so call even if tls_require_ciphers is unset */
3578 if (!tls_dropprivs_validate_require_cipher(nowarn
))
3581 /* Magic number: at time of writing, 1024 has been the long-standing value
3582 used by so many clients, and what Exim used to use always, that it makes
3583 sense to just min-clamp this max-clamp at that. */
3584 if (tls_dh_max_bits
< 1024)
3585 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3586 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3588 /* If openssl_options is set, validate it */
3589 if (openssl_options
)
3592 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3593 "openssl_options is set but we're using GnuTLS");
3596 if (!tls_openssl_options_parse(openssl_options
, &dummy
))
3597 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3598 "openssl_options parse error: %s", openssl_options
);
3601 #endif /*SUPPORT_TLS*/
3603 if (!nowarn
&& !keep_environment
&& environ
&& *environ
)
3604 log_write(0, LOG_MAIN
,
3605 "Warning: purging the environment.\n"
3606 " Suggested action: use keep_environment.");
3611 /*************************************************
3612 * Initialize one driver *
3613 *************************************************/
3615 /* This is called once the driver's generic options, if any, have been read.
3616 We can now find the driver, set up defaults for the private options, and
3617 unset any "set" bits in the private options table (which might have been
3618 set by another incarnation of the same driver).
3621 d pointer to driver instance block, with generic
3623 drivers_available vector of available drivers
3624 size_of_info size of each block in drivers_available
3625 class class of driver, for error message
3627 Returns: pointer to the driver info block
3630 static driver_info
*
3631 init_driver(driver_instance
*d
, driver_info
*drivers_available
,
3632 int size_of_info
, uschar
*class)
3636 for (dd
= drivers_available
; dd
->driver_name
[0] != 0;
3637 dd
= (driver_info
*)((US dd
) + size_of_info
))
3639 if (Ustrcmp(d
->driver_name
, dd
->driver_name
) == 0)
3642 int len
= dd
->options_len
;
3644 d
->options_block
= store_get(len
);
3645 memcpy(d
->options_block
, dd
->options_block
, len
);
3646 for (i
= 0; i
< *(dd
->options_count
); i
++)
3647 dd
->options
[i
].type
&= ~opt_set
;
3652 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
3653 "%s %s: cannot find %s driver \"%s\"", class, d
->name
, class, d
->driver_name
);
3655 return NULL
; /* never obeyed */
3661 /*************************************************
3662 * Initialize driver list *
3663 *************************************************/
3665 /* This function is called for routers, transports, and authentication
3666 mechanisms. It reads the data from the current point in the configuration file
3667 up to the end of the section, and sets up a chain of instance blocks according
3668 to the file's contents. The file will already have been opened by a call to
3669 readconf_main, and must be left open for subsequent reading of further data.
3671 Any errors cause a panic crash. Note that the blocks with names driver_info and
3672 driver_instance must map the first portions of all the _info and _instance
3673 blocks for this shared code to work.
3676 class "router", "transport", or "authenticator"
3677 anchor &routers, &transports, &auths
3678 drivers_available available drivers
3679 size_of_info size of each info block
3680 instance_default points to default data for an instance
3681 instance_size size of instance block
3682 driver_optionlist generic option list
3683 driver_optionlist_count count of generic option list
3689 readconf_driver_init(
3691 driver_instance
**anchor
,
3692 driver_info
*drivers_available
,
3694 void *instance_default
,
3696 optionlist
*driver_optionlist
,
3697 int driver_optionlist_count
)
3699 driver_instance
**p
= anchor
;
3700 driver_instance
*d
= NULL
;
3703 while ((buffer
= get_config_line()) != NULL
)
3708 /* Read the first name on the line and test for the start of a new driver. A
3709 macro definition indicates the end of the previous driver. If this isn't the
3710 start of a new driver, the line will be re-read. */
3712 s
= readconf_readname(name
, sizeof(name
), buffer
);
3714 /* Handle macro definition, first finishing off the initialization of the
3715 previous driver, if any. */
3717 if (isupper(*name
) && *s
== '=')
3721 if (!d
->driver_name
)
3722 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3723 "no driver defined for %s \"%s\"", class, d
->name
);
3727 read_macro_assignment(buffer
);
3731 /* If the line starts with a name terminated by a colon, we are at the
3732 start of the definition of a new driver. The rest of the line must be
3739 /* Finish off initializing the previous driver. */
3743 if (!d
->driver_name
)
3744 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3745 "no driver defined for %s \"%s\"", class, d
->name
);
3749 /* Check that we haven't already got a driver of this name */
3751 for (d
= *anchor
; d
; d
= d
->next
)
3752 if (Ustrcmp(name
, d
->name
) == 0)
3753 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3754 "there are two %ss called \"%s\"", class, name
);
3756 /* Set up a new driver instance data block on the chain, with
3757 its default values installed. */
3759 d
= store_get(instance_size
);
3760 memcpy(d
, instance_default
, instance_size
);
3763 d
->name
= string_copy(name
);
3765 /* Clear out the "set" bits in the generic options */
3767 for (i
= 0; i
< driver_optionlist_count
; i
++)
3768 driver_optionlist
[i
].type
&= ~opt_set
;
3770 /* Check nothing more on this line, then do the next loop iteration. */
3772 while (isspace(*s
)) s
++;
3773 if (*s
!= 0) extra_chars_error(s
, US
"driver name ", name
, US
"");
3777 /* Not the start of a new driver. Give an error if we have not set up a
3778 current driver yet. */
3781 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%s name missing", class);
3783 /* First look to see if this is a generic option; if it is "driver",
3784 initialize the driver. If is it not a generic option, we can look for a
3785 private option provided that the driver has been previously set up. */
3787 if (readconf_handle_option(buffer
, driver_optionlist
,
3788 driver_optionlist_count
, d
, NULL
))
3790 if (!d
->info
&& d
->driver_name
)
3791 init_driver(d
, drivers_available
, size_of_info
, class);
3794 /* Handle private options - pass the generic block because some may
3795 live therein. A flag with each option indicates if it is in the public
3799 readconf_handle_option(buffer
, d
->info
->options
,
3800 *(d
->info
->options_count
), d
, US
"option \"%s\" unknown");
3802 /* The option is not generic and the driver name has not yet been given. */
3804 else log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "option \"%s\" unknown "
3805 "(\"driver\" must be specified before any private options)", name
);
3808 /* Run the initialization function for the final driver. */
3812 if (!d
->driver_name
)
3813 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
3814 "no driver defined for %s \"%s\"", class, d
->name
);
3821 /*************************************************
3822 * Check driver dependency *
3823 *************************************************/
3825 /* This function is passed a driver instance and a string. It checks whether
3826 any of the string options for the driver contains the given string as an
3830 d points to a driver instance block
3831 s the string to search for
3833 Returns: TRUE if a dependency is found
3837 readconf_depends(driver_instance
*d
, uschar
*s
)
3839 int count
= *(d
->info
->options_count
);
3843 for (ol
= d
->info
->options
; ol
< d
->info
->options
+ count
; ol
++)
3845 void *options_block
;
3847 int type
= ol
->type
& opt_mask
;
3848 if (type
!= opt_stringptr
) continue;
3849 options_block
= ((ol
->type
& opt_public
) == 0)? d
->options_block
: (void *)d
;
3850 value
= *(uschar
**)(US options_block
+ (long int)(ol
->value
));
3851 if (value
!= NULL
&& (ss
= Ustrstr(value
, s
)) != NULL
)
3853 if (ss
<= value
|| (ss
[-1] != '$' && ss
[-1] != '{') ||
3854 isalnum(ss
[Ustrlen(s
)])) continue;
3855 DEBUG(D_transport
) debug_printf("driver %s: \"%s\" option depends on %s\n",
3856 d
->name
, ol
->name
, s
);
3861 DEBUG(D_transport
) debug_printf("driver %s does not depend on %s\n", d
->name
, s
);
3868 /*************************************************
3869 * Decode an error type for retries *
3870 *************************************************/
3872 /* This function is global because it is also called from the main
3873 program when testing retry information. It decodes strings such as "quota_7d"
3874 into numerical error codes.
3877 pp points to start of text
3878 p points past end of text
3879 basic_errno points to an int to receive the main error number
3880 more_errno points to an int to receive the secondary error data
3882 Returns: NULL if decoded correctly; else points to error text
3886 readconf_retry_error(const uschar
*pp
, const uschar
*p
,
3887 int *basic_errno
, int *more_errno
)
3890 const uschar
*q
= pp
;
3891 while (q
< p
&& *q
!= '_') q
++;
3894 if (len
== 5 && strncmpic(pp
, US
"quota", len
) == 0)
3896 *basic_errno
= ERRNO_EXIMQUOTA
;
3897 if (q
!= p
&& (*more_errno
= readconf_readtime(q
+1, *p
, FALSE
)) < 0)
3898 return US
"bad time value";
3901 else if (len
== 7 && strncmpic(pp
, US
"refused", len
) == 0)
3903 *basic_errno
= ECONNREFUSED
;
3906 if (strncmpic(q
+1, US
"MX", p
-q
-1) == 0) *more_errno
= 'M';
3907 else if (strncmpic(q
+1, US
"A", p
-q
-1) == 0) *more_errno
= 'A';
3908 else return US
"A or MX expected after \"refused\"";
3912 else if (len
== 7 && strncmpic(pp
, US
"timeout", len
) == 0)
3914 *basic_errno
= ETIMEDOUT
;
3918 int xlen
= p
- q
- 1;
3919 const uschar
*x
= q
+ 1;
3921 static uschar
*extras
[] =
3922 { US
"A", US
"MX", US
"connect", US
"connect_A", US
"connect_MX" };
3923 static int values
[] =
3924 { 'A', 'M', RTEF_CTOUT
, RTEF_CTOUT
|'A', RTEF_CTOUT
|'M' };
3926 for (i
= 0; i
< nelem(extras
); i
++)
3927 if (strncmpic(x
, extras
[i
], xlen
) == 0)
3929 *more_errno
= values
[i
];
3933 if (i
>= nelem(extras
))
3934 if (strncmpic(x
, US
"DNS", xlen
) == 0)
3935 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"timeout_dns\" is no longer "
3936 "available in retry rules (it has never worked) - treated as "
3939 return US
"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3943 else if (strncmpic(pp
, US
"mail_4", 6) == 0 ||
3944 strncmpic(pp
, US
"rcpt_4", 6) == 0 ||
3945 strncmpic(pp
, US
"data_4", 6) == 0)
3948 int x
= 255; /* means "any 4xx code" */
3949 if (p
!= pp
+ 8) bad
= TRUE
; else
3951 int a
= pp
[6], b
= pp
[7];
3955 if (isdigit(b
)) x
+= b
- '0';
3956 else if (b
== 'x') x
+= 100;
3959 else if (a
!= 'x' || b
!= 'x') bad
= TRUE
;
3963 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3964 "x is literal and d is any digit", pp
);
3966 *basic_errno
= *pp
== 'm' ? ERRNO_MAIL4XX
:
3967 *pp
== 'r' ? ERRNO_RCPT4XX
: ERRNO_DATA4XX
;
3968 *more_errno
= x
<< 8;
3971 else if (len
== 4 && strncmpic(pp
, US
"auth", len
) == 0 &&
3972 strncmpic(q
+1, US
"failed", p
-q
-1) == 0)
3973 *basic_errno
= ERRNO_AUTHFAIL
;
3975 else if (strncmpic(pp
, US
"lost_connection", p
- pp
) == 0)
3976 *basic_errno
= ERRNO_SMTPCLOSED
;
3978 else if (strncmpic(pp
, US
"tls_required", p
- pp
) == 0)
3979 *basic_errno
= ERRNO_TLSREQUIRED
;
3981 else if (strncmpic(pp
, US
"lookup", p
- pp
) == 0)
3982 *basic_errno
= ERRNO_UNKNOWNHOST
;
3984 else if (len
!= 1 || Ustrncmp(pp
, "*", 1) != 0)
3985 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p
-pp
), pp
);
3993 /*************************************************
3994 * Read retry information *
3995 *************************************************/
3997 /* Each line of retry information contains:
3999 . A domain name pattern or an address pattern;
4001 . An error name, possibly with additional data, or *;
4003 . An optional sequence of retry items, each consisting of an identifying
4004 letter, a cutoff time, and optional parameters.
4006 All this is decoded and placed into a control block. */
4009 /* Subroutine to read an argument, preceded by a comma and terminated
4010 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4011 1 = fixed point number (returned *1000).
4014 paddr pointer to pointer to current character; updated
4015 type 0 => read a time; 1 => read a fixed point number
4017 Returns: time in seconds or fixed point number * 1000
4021 retry_arg(const uschar
**paddr
, int type
)
4023 const uschar
*p
= *paddr
;
4026 if (*p
++ != ',') log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "comma expected");
4028 while (isspace(*p
)) p
++;
4030 while (isalnum(*p
) || (type
== 1 && *p
== '.')) p
++;
4032 if (*p
!= 0 && !isspace(*p
) && *p
!= ',' && *p
!= ';')
4033 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "comma or semicolon expected");
4038 case 0: return readconf_readtime(pp
, *p
, FALSE
);
4039 case 1: return readconf_readfixed(pp
, *p
);
4041 return 0; /* Keep picky compilers happy */
4044 /* The function proper */
4047 readconf_retries(void)
4049 retry_config
**chain
= &retries
;
4053 while ((p
= get_config_line()))
4055 retry_rule
**rchain
;
4059 next
= store_get(sizeof(retry_config
));
4062 chain
= &(next
->next
);
4063 next
->basic_errno
= next
->more_errno
= 0;
4064 next
->senders
= NULL
;
4066 rchain
= &(next
->rules
);
4068 next
->pattern
= string_dequote(&p
);
4069 while (isspace(*p
)) p
++;
4071 while (mac_isgraph(*p
)) p
++;
4072 if (p
- pp
<= 0) log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4073 "missing error type in retry rule");
4075 /* Test error names for things we understand. */
4077 if ((error
= readconf_retry_error(pp
, p
, &next
->basic_errno
,
4078 &next
->more_errno
)))
4079 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "%s", error
);
4081 /* There may be an optional address list of senders to be used as another
4082 constraint on the rule. This was added later, so the syntax is a bit of a
4083 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4086 while (isspace(*p
)) p
++;
4087 if (Ustrncmp(p
, "senders", 7) == 0)
4090 while (isspace(*p
)) p
++;
4091 if (*p
++ != '=') log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4092 "\"=\" expected after \"senders\" in retry rule");
4093 while (isspace(*p
)) p
++;
4094 next
->senders
= string_dequote(&p
);
4097 /* Now the retry rules. Keep the maximum timeout encountered. */
4099 while (isspace(*p
)) p
++;
4103 retry_rule
*rule
= store_get(sizeof(retry_rule
));
4105 rchain
= &(rule
->next
);
4107 rule
->rule
= toupper(*p
++);
4108 rule
->timeout
= retry_arg(&p
, 0);
4109 if (rule
->timeout
> retry_maximum_timeout
)
4110 retry_maximum_timeout
= rule
->timeout
;
4114 case 'F': /* Fixed interval */
4115 rule
->p1
= retry_arg(&p
, 0);
4118 case 'G': /* Geometrically increasing intervals */
4119 case 'H': /* Ditto, but with randomness */
4120 rule
->p1
= retry_arg(&p
, 0);
4121 rule
->p2
= retry_arg(&p
, 1);
4125 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "unknown retry rule letter");
4129 if (rule
->timeout
<= 0 || rule
->p1
<= 0 ||
4130 (rule
->rule
!= 'F' && rule
->p2
< 1000))
4131 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4132 "bad parameters for retry rule");
4134 while (isspace(*p
)) p
++;
4138 while (isspace(*p
)) p
++;
4141 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "semicolon expected");
4148 /*************************************************
4149 * Initialize authenticators *
4150 *************************************************/
4152 /* Read the authenticators section of the configuration file.
4161 auth_instance
*au
, *bu
;
4163 readconf_driver_init(US
"authenticator",
4164 (driver_instance
**)(&auths
), /* chain anchor */
4165 (driver_info
*)auths_available
, /* available drivers */
4166 sizeof(auth_info
), /* size of info block */
4167 &auth_defaults
, /* default values for generic options */
4168 sizeof(auth_instance
), /* size of instance block */
4169 optionlist_auths
, /* generic options */
4170 optionlist_auths_size
);
4172 for (au
= auths
; au
; au
= au
->next
)
4174 if (!au
->public_name
)
4175 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
, "no public name specified for "
4176 "the %s authenticator", au
->name
);
4178 for (bu
= au
->next
; bu
; bu
= bu
->next
)
4179 if (strcmpic(au
->public_name
, bu
->public_name
) == 0)
4180 if ((au
->client
&& bu
->client
) || (au
->server
&& bu
->server
))
4181 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
, "two %s authenticators "
4182 "(%s and %s) have the same public name (%s)",
4183 au
->client
? US
"client" : US
"server", au
->name
, bu
->name
,
4191 /*************************************************
4192 * Read ACL information *
4193 *************************************************/
4195 /* If this run of Exim is not doing something that involves receiving a
4196 message, we can just skip over the ACL information. No need to parse it.
4198 First, we have a function for acl_read() to call back to get the next line. We
4199 need to remember the line we passed, because at the end it will contain the
4200 name of the next ACL. */
4202 static uschar
*acl_line
;
4207 acl_line
= get_config_line();
4212 /* Now the main function:
4223 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4226 acl_line
= get_config_line();
4228 while(acl_line
!= NULL
)
4234 p
= readconf_readname(name
, sizeof(name
), acl_line
);
4235 if (isupper(*name
) && *p
== '=')
4237 read_macro_assignment(acl_line
);
4238 acl_line
= get_config_line();
4242 if (*p
!= ':' || name
[0] == 0)
4243 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "missing or malformed ACL name");
4245 node
= store_get(sizeof(tree_node
) + Ustrlen(name
));
4246 Ustrcpy(node
->name
, name
);
4247 if (!tree_insertnode(&acl_anchor
, node
))
4248 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4249 "there are two ACLs called \"%s\"", name
);
4251 node
->data
.ptr
= acl_read(acl_callback
, &error
);
4253 if (node
->data
.ptr
== NULL
&& error
!= NULL
)
4254 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "error in ACL: %s", error
);
4260 /*************************************************
4261 * Read configuration for local_scan() *
4262 *************************************************/
4264 /* This function is called after "begin local_scan" is encountered in the
4265 configuration file. If the local_scan() function allows for configuration
4266 options, we can process them. Otherwise, we expire in a panic.
4273 local_scan_init(void)
4275 #ifndef LOCAL_SCAN_HAS_OPTIONS
4276 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
, "local_scan() options not supported: "
4277 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4281 while ((p
= get_config_line()) != NULL
)
4283 (void) readconf_handle_option(p
, local_scan_options
, local_scan_options_count
,
4284 NULL
, US
"local_scan option \"%s\" unknown");
4291 /*************************************************
4292 * Read rest of configuration (after main) *
4293 *************************************************/
4295 /* This function reads the rest of the runtime configuration, after the main
4296 configuration. It is called only when actually needed. Each subsequent section
4297 of the configuration starts with a line of the form
4301 where the name is "routers", "transports", etc. A section is terminated by
4302 hitting the next "begin" line, and the next name is left in next_section.
4303 Because it may confuse people as to whether the names are singular or plural,
4304 we add "s" if it's missing. There is always enough room in next_section for
4305 this. This function is basically just a switch.
4311 static uschar
*section_list
[] = {
4325 while(next_section
[0] != 0)
4329 int last
= nelem(section_list
);
4331 int n
= Ustrlen(next_section
);
4333 if (tolower(next_section
[n
-1]) != 's') Ustrcpy(next_section
+n
, "s");
4337 int c
= strcmpic(next_section
, section_list
[mid
]);
4339 if (c
> 0) first
= mid
+ 1; else last
= mid
;
4341 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4342 "\"%.*s\" is not a known configuration section name", n
, next_section
);
4343 mid
= (last
+ first
)/2;
4347 if (((had
^= bit
) & bit
) == 0)
4348 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG_IN
,
4349 "\"%.*s\" section is repeated in the configuration file", n
,
4354 case 0: readconf_acl(); break;
4355 case 1: auths_init(); break;
4356 case 2: local_scan_init(); break;
4357 case 3: readconf_retries(); break;
4358 case 4: readconf_rewrites(); break;
4359 case 5: route_init(); break;
4360 case 6: transport_init(); break;
4364 (void)fclose(config_file
);
4367 /* Init the storage for the pre-parsed config lines */
4369 readconf_save_config(const uschar
*s
)
4371 save_config_line(string_sprintf("# Exim Configuration (%s)",
4372 running_in_test_harness
? US
"X" : s
));
4376 save_config_position(const uschar
*file
, int line
)
4378 save_config_line(string_sprintf("# %d \"%s\"", line
, file
));
4381 /* Append a pre-parsed logical line to the config lines store,
4382 this operates on a global (static) list that holds all the pre-parsed
4383 config lines, we do no further processing here, output formatting and
4384 honouring of <hide> or macros will be done during output */
4387 save_config_line(const uschar
* line
)
4389 static config_line_item
*current
;
4390 config_line_item
*next
;
4392 next
= (config_line_item
*) store_get(sizeof(config_line_item
));
4393 next
->line
= string_copy(line
);
4396 if (!config_lines
) config_lines
= next
;
4397 else current
->next
= next
;
4402 /* List the parsed config lines, care about nice formatting and
4403 hide the <hide> values unless we're the admin user */
4405 print_config(BOOL admin
, BOOL terse
)
4407 config_line_item
*i
;
4408 const int TS
= terse
? 0 : 2;
4411 for (i
= config_lines
; i
; i
= i
->next
)
4416 /* skip over to the first non-space */
4417 for (current
= i
->line
; *current
&& isspace(*current
); ++current
)
4420 if (*current
== '\0')
4423 /* Collapse runs of spaces. We stop this if we encounter one of the
4424 * following characters: "'$, as this may indicate careful formatting */
4425 for (p
= current
; *p
; ++p
)
4428 if (!isspace(*p
)) continue;
4429 if (*p
!= ' ') *p
= ' ';
4431 for (next
= p
; isspace(*next
); ++next
)
4435 memmove(p
+1, next
, Ustrlen(next
)+1);
4437 if (*next
== '"' || *next
== '\'' || *next
== '$')
4442 if (current
[0] == '#')
4445 /* begin lines are left aligned */
4446 else if (Ustrncmp(current
, "begin", 5) == 0 && isspace(current
[5]))
4448 if (!terse
) puts("");
4453 /* router/acl/transport block names */
4454 else if (current
[Ustrlen(current
)-1] == ':' && !Ustrchr(current
, '='))
4456 if (!terse
) puts("");
4457 printf("%*s%s\n", TS
, "", current
);
4461 /* hidden lines (all MACROS or lines prefixed with "hide") */
4463 && ( isupper(*current
)
4464 || Ustrncmp(current
, "hide", 4) == 0 && isspace(current
[4])
4468 if ((p
= Ustrchr(current
, '=')))
4471 printf("%*s%s= %s\n", indent
, "", current
, hidden
);
4473 /* e.g.: hide split_spool_directory */
4475 printf("%*s\n", indent
, hidden
);
4479 /* rest is public */
4480 printf("%*s%s\n", indent
, "", current
);
4484 #endif /*!MACRO_PREDEF*/
4487 /* End of readconf.c */