1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar * syslog_facility_str;
22 static void fn_smtp_receive_timeout(const uschar *, const uschar *);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config[] = {
32 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
33 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
34 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
35 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
36 { "accept_8bitmime", opt_bool, &accept_8bitmime },
37 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
41 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
42 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
43 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
44 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
46 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
49 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
51 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
52 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
53 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
54 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
55 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
59 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
60 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
61 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
62 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
64 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
66 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
67 { "add_environment", opt_stringptr, &add_environment },
68 { "admin_groups", opt_gidlist, &admin_groups },
69 { "allow_domain_literals", opt_bool, &allow_domain_literals },
70 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
71 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
72 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
73 { "auto_thaw", opt_time, &auto_thaw },
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr, &av_scanner },
77 { "bi_command", opt_stringptr, &bi_command },
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr, &bmi_config_file },
81 { "bounce_message_file", opt_stringptr, &bounce_message_file },
82 { "bounce_message_text", opt_stringptr, &bounce_message_text },
83 { "bounce_return_body", opt_bool, &bounce_return_body },
84 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
85 { "bounce_return_message", opt_bool, &bounce_return_message },
86 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
87 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
88 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
89 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
90 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
91 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
92 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
93 { "check_log_inodes", opt_int, &check_log_inodes },
94 { "check_log_space", opt_Kint, &check_log_space },
95 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
96 { "check_spool_inodes", opt_int, &check_spool_inodes },
97 { "check_spool_space", opt_Kint, &check_spool_space },
98 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
99 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
100 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
101 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
102 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
103 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
106 { "dccifd_address", opt_stringptr, &dccifd_address },
107 { "dccifd_options", opt_stringptr, &dccifd_options },
109 { "debug_store", opt_bool, &debug_store },
110 { "delay_warning", opt_timelist, &delay_warning },
111 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
112 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
113 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
114 { "delivery_date_remove", opt_bool, &delivery_date_remove },
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool, &disable_fsync },
118 { "disable_ipv6", opt_bool, &disable_ipv6 },
120 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
122 #ifdef EXPERIMENTAL_DMARC
123 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
124 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
125 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
127 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
128 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
129 { "dns_cname_loops", opt_int, &dns_cname_loops },
130 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
131 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
132 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
133 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
134 { "dns_retrans", opt_time, &dns_retrans },
135 { "dns_retry", opt_int, &dns_retry },
136 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
137 { "dns_use_edns0", opt_int, &dns_use_edns0 },
138 /* This option is now a no-op, retained for compatibility */
139 { "drop_cr", opt_bool, &drop_cr },
140 /*********************************************************/
141 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
142 { "dsn_from", opt_stringptr, &dsn_from },
143 { "envelope_to_remove", opt_bool, &envelope_to_remove },
144 { "errors_copy", opt_stringptr, &errors_copy },
145 { "errors_reply_to", opt_stringptr, &errors_reply_to },
146 #ifndef DISABLE_EVENT
147 { "event_action", opt_stringptr, &event_action },
149 { "exim_group", opt_gid, &exim_gid },
150 { "exim_path", opt_stringptr, &exim_path },
151 { "exim_user", opt_uid, &exim_uid },
152 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
153 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
154 { "finduser_retries", opt_int, &finduser_retries },
155 { "freeze_tell", opt_stringptr, &freeze_tell },
156 { "gecos_name", opt_stringptr, &gecos_name },
157 { "gecos_pattern", opt_stringptr, &gecos_pattern },
159 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
160 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
162 { "header_line_maxsize", opt_int, &header_line_maxsize },
163 { "header_maxsize", opt_int, &header_maxsize },
164 { "headers_charset", opt_stringptr, &headers_charset },
165 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
166 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
167 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
168 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
169 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
170 { "hold_domains", opt_stringptr, &hold_domains },
171 { "host_lookup", opt_stringptr, &host_lookup },
172 { "host_lookup_order", opt_stringptr, &host_lookup_order },
173 { "host_reject_connection", opt_stringptr, &host_reject_connection },
174 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
176 { "hosts_proxy", opt_stringptr, &hosts_proxy },
178 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
180 { "ibase_servers", opt_stringptr, &ibase_servers },
182 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
183 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
184 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
185 { "keep_environment", opt_stringptr, &keep_environment },
186 { "keep_malformed", opt_time, &keep_malformed },
188 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
189 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
190 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
191 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
192 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
193 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
194 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
195 { "ldap_start_tls", opt_bool, &eldap_start_tls },
196 { "ldap_version", opt_int, &eldap_version },
198 { "local_from_check", opt_bool, &local_from_check },
199 { "local_from_prefix", opt_stringptr, &local_from_prefix },
200 { "local_from_suffix", opt_stringptr, &local_from_suffix },
201 { "local_interfaces", opt_stringptr, &local_interfaces },
202 #ifdef HAVE_LOCAL_SCAN
203 { "local_scan_timeout", opt_time, &local_scan_timeout },
205 { "local_sender_retain", opt_bool, &local_sender_retain },
206 { "localhost_number", opt_stringptr, &host_number_string },
207 { "log_file_path", opt_stringptr, &log_file_path },
208 { "log_selector", opt_stringptr, &log_selector_string },
209 { "log_timezone", opt_bool, &log_timezone },
210 { "lookup_open_max", opt_int, &lookup_open_max },
211 { "max_username_length", opt_int, &max_username_length },
212 { "message_body_newlines", opt_bool, &message_body_newlines },
213 { "message_body_visible", opt_mkint, &message_body_visible },
214 { "message_id_header_domain", opt_stringptr, &message_id_domain },
215 { "message_id_header_text", opt_stringptr, &message_id_text },
216 { "message_logs", opt_bool, &message_logs },
217 { "message_size_limit", opt_stringptr, &message_size_limit },
218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
219 { "move_frozen_messages", opt_bool, &move_frozen_messages },
221 { "mua_wrapper", opt_bool, &mua_wrapper },
223 { "mysql_servers", opt_stringptr, &mysql_servers },
225 { "never_users", opt_uidlist, &never_users },
227 { "openssl_options", opt_stringptr, &openssl_options },
230 { "oracle_servers", opt_stringptr, &oracle_servers },
232 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
234 { "perl_at_start", opt_bool, &opt_perl_at_start },
235 { "perl_startup", opt_stringptr, &opt_perl_startup },
236 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
239 { "pgsql_servers", opt_stringptr, &pgsql_servers },
241 { "pid_file_path", opt_stringptr, &pid_file_path },
242 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
244 { "prdr_enable", opt_bool, &prdr_enable },
246 { "preserve_message_logs", opt_bool, &preserve_message_logs },
247 { "primary_hostname", opt_stringptr, &primary_hostname },
248 { "print_topbitchars", opt_bool, &print_topbitchars },
249 { "process_log_path", opt_stringptr, &process_log_path },
250 { "prod_requires_admin", opt_bool, &prod_requires_admin },
251 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
252 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
253 { "queue_domains", opt_stringptr, &queue_domains },
254 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
255 { "queue_only", opt_bool, &queue_only },
256 { "queue_only_file", opt_stringptr, &queue_only_file },
257 { "queue_only_load", opt_fixed, &queue_only_load },
258 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
259 { "queue_only_override", opt_bool, &queue_only_override },
260 { "queue_run_in_order", opt_bool, &queue_run_in_order },
261 { "queue_run_max", opt_stringptr, &queue_run_max },
262 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
263 { "receive_timeout", opt_time, &receive_timeout },
264 { "received_header_text", opt_stringptr, &received_header_text },
265 { "received_headers_max", opt_int, &received_headers_max },
266 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
267 { "recipients_max", opt_int, &recipients_max },
268 { "recipients_max_reject", opt_bool, &recipients_max_reject },
270 { "redis_servers", opt_stringptr, &redis_servers },
272 { "remote_max_parallel", opt_int, &remote_max_parallel },
273 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
274 { "retry_data_expire", opt_time, &retry_data_expire },
275 { "retry_interval_max", opt_time, &retry_interval_max },
276 { "return_path_remove", opt_bool, &return_path_remove },
277 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
278 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
279 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
280 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
281 { "slow_lookup_log", opt_int, &slow_lookup_log },
282 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
283 { "smtp_accept_max", opt_int, &smtp_accept_max },
284 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
285 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
286 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
287 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
288 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
289 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
290 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
291 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
292 { "smtp_banner", opt_stringptr, &smtp_banner },
293 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
294 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
295 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
296 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
297 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
298 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
299 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
300 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
301 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
302 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
303 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
304 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
305 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
306 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
308 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
310 #ifdef WITH_CONTENT_SCAN
311 { "spamd_address", opt_stringptr, &spamd_address },
314 { "spf_guess", opt_stringptr, &spf_guess },
316 { "split_spool_directory", opt_bool, &split_spool_directory },
317 { "spool_directory", opt_stringptr, &spool_directory },
318 { "spool_wireformat", opt_bool, &spool_wireformat },
320 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
322 #ifdef EXPERIMENTAL_SRS
323 { "srs_config", opt_stringptr, &srs_config },
324 { "srs_hashlength", opt_int, &srs_hashlength },
325 { "srs_hashmin", opt_int, &srs_hashmin },
326 { "srs_maxage", opt_int, &srs_maxage },
327 { "srs_secrets", opt_stringptr, &srs_secrets },
328 { "srs_usehash", opt_bool, &srs_usehash },
329 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
331 { "strict_acl_vars", opt_bool, &strict_acl_vars },
332 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
333 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
334 { "syslog_duplication", opt_bool, &syslog_duplication },
335 { "syslog_facility", opt_stringptr, &syslog_facility_str },
336 { "syslog_pid", opt_bool, &syslog_pid },
337 { "syslog_processname", opt_stringptr, &syslog_processname },
338 { "syslog_timestamp", opt_bool, &syslog_timestamp },
339 { "system_filter", opt_stringptr, &system_filter },
340 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
341 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
342 { "system_filter_group", opt_gid, &system_filter_gid },
343 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
344 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
345 { "system_filter_user", opt_uid, &system_filter_uid },
346 { "tcp_nodelay", opt_bool, &tcp_nodelay },
347 #ifdef USE_TCP_WRAPPERS
348 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
350 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
351 { "timezone", opt_stringptr, &timezone_string },
352 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
354 # ifdef EXPERIMENTAL_REQUIRETLS
355 { "tls_advertise_requiretls", opt_stringptr, &tls_advertise_requiretls },
357 { "tls_certificate", opt_stringptr, &tls_certificate },
358 { "tls_crl", opt_stringptr, &tls_crl },
359 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
360 { "tls_dhparam", opt_stringptr, &tls_dhparam },
361 { "tls_eccurve", opt_stringptr, &tls_eccurve },
362 # ifndef DISABLE_OCSP
363 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
365 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
366 { "tls_privatekey", opt_stringptr, &tls_privatekey },
367 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
368 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
369 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
370 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
371 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
373 { "trusted_groups", opt_gidlist, &trusted_groups },
374 { "trusted_users", opt_uidlist, &trusted_users },
375 { "unknown_login", opt_stringptr, &unknown_login },
376 { "unknown_username", opt_stringptr, &unknown_username },
377 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
378 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
379 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
380 { "warn_message_file", opt_stringptr, &warn_message_file },
381 { "write_rejectlog", opt_bool, &write_rejectlog }
385 static int optionlist_config_size = nelem(optionlist_config);
391 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
396 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
402 struct auth_info * ai;
405 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
407 for (ai = auths_available; ai->driver_name[0]; ai++)
409 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
410 builtin_macro_create(buf);
411 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
416 options_logging(void)
421 for (bp = log_options; bp < log_options + log_options_count; bp++)
423 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
424 builtin_macro_create(buf);
429 #else /*!MACRO_PREDEF*/
431 extern char **environ;
433 static void save_config_line(const uschar* line);
434 static void save_config_position(const uschar *file, int line);
435 static void print_config(BOOL admin, BOOL terse);
438 #define CSTATE_STACK_SIZE 10
440 const uschar *config_directory = NULL;
443 /* Structure for chain (stack) of .included files */
445 typedef struct config_file_item {
446 struct config_file_item *next;
447 const uschar *filename;
448 const uschar *directory;
453 /* Structure for chain of configuration lines (-bP config) */
455 typedef struct config_line_item {
456 struct config_line_item *next;
460 static config_line_item* config_lines;
462 /* Structure of table of conditional words and their state transitions */
464 typedef struct cond_item {
472 /* Structure of table of syslog facility names and values */
474 typedef struct syslog_fac_item {
480 static const char * const hidden = "<value not displayable>";
482 /* Static variables */
484 static config_file_item *config_file_stack = NULL; /* For includes */
486 static uschar *syslog_facility_str = NULL;
487 static uschar next_section[24];
488 static uschar time_buffer[24];
490 /* State variables for conditional loading (.ifdef / .else / .endif) */
492 static int cstate = 0;
493 static int cstate_stack_ptr = -1;
494 static int cstate_stack[CSTATE_STACK_SIZE];
496 /* Table of state transitions for handling conditional inclusions. There are
497 four possible state transitions:
501 .elifdef true (or .else)
504 .endif just causes the previous cstate to be popped off the stack */
506 static int next_cstate[3][4] =
508 /* State 0: reading from file, or reading until next .else or .endif */
510 /* State 1: condition failed, skipping until next .else or .endif */
512 /* State 2: skipping until .endif */
516 /* Table of conditionals and the states to set. For each name, there are four
517 values: the length of the name (to save computing it each time), the state to
518 set if a macro was found in the line, the state to set if a macro was not found
519 in the line, and a stack manipulation setting which is:
521 -1 pull state value off the stack
522 0 don't alter the stack
523 +1 push value onto stack, before setting new state
526 static cond_item cond_list[] = {
527 { US"ifdef", 5, 0, 1, 1 },
528 { US"ifndef", 6, 1, 0, 1 },
529 { US"elifdef", 7, 2, 3, 0 },
530 { US"elifndef", 8, 3, 2, 0 },
531 { US"else", 4, 2, 2, 0 },
532 { US"endif", 5, 0, 0, -1 }
535 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
537 /* Table of syslog facility names and their values */
539 static syslog_fac_item syslog_list[] = {
540 { US"mail", LOG_MAIL },
541 { US"user", LOG_USER },
542 { US"news", LOG_NEWS },
543 { US"uucp", LOG_UUCP },
544 { US"local0", LOG_LOCAL0 },
545 { US"local1", LOG_LOCAL1 },
546 { US"local2", LOG_LOCAL2 },
547 { US"local3", LOG_LOCAL3 },
548 { US"local4", LOG_LOCAL4 },
549 { US"local5", LOG_LOCAL5 },
550 { US"local6", LOG_LOCAL6 },
551 { US"local7", LOG_LOCAL7 },
552 { US"daemon", LOG_DAEMON }
555 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
560 /*************************************************
561 * Find the name of an option *
562 *************************************************/
564 /* This function is to aid debugging. Various functions take arguments that are
565 pointer variables in the options table or in option tables for various drivers.
566 For debugging output, it is useful to be able to find the name of the option
567 which is currently being processed. This function finds it, if it exists, by
568 searching the table(s).
570 Arguments: a value that is presumed to be in the table above
571 Returns: the option name, or an empty string
575 readconf_find_option(void *p)
579 transport_instance *t;
581 for (i = 0; i < nelem(optionlist_config); i++)
582 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
584 for (r = routers; r; r = r->next)
586 router_info *ri = r->info;
587 for (i = 0; i < *ri->options_count; i++)
589 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
590 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
591 return US ri->options[i].name;
595 for (t = transports; t; t = t->next)
597 transport_info *ti = t->info;
598 for (i = 0; i < *ti->options_count; i++)
600 optionlist * op = &ti->options[i];
601 if ((op->type & opt_mask) != opt_stringptr) continue;
602 if (p == ( op->type & opt_public
604 : CS t->options_block
606 + (long int)op->value)
617 /*************************************************
618 * Deal with an assignment to a macro *
619 *************************************************/
621 /* We have a new definition; append to the list.
624 name Name of the macro; will be copied
625 val Expansion result for the macro; will be copied
629 macro_create(const uschar * name, const uschar * val, BOOL command_line)
631 macro_item * m = store_get(sizeof(macro_item));
633 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
635 m->command_line = command_line;
636 m->namelen = Ustrlen(name);
637 m->replen = Ustrlen(val);
638 m->name = string_copy(name);
639 m->replacement = string_copy(val);
651 /* This function is called when a line that starts with an upper case letter is
652 encountered. The argument "line" should contain a complete logical line, and
653 start with the first letter of the macro name. The macro name and the
654 replacement text are extracted and stored. Redefinition of existing,
655 non-command line, macros is permitted using '==' instead of '='.
658 s points to the start of the logical line
660 Returns: FALSE iff fatal error
664 macro_read_assignment(uschar *s)
671 while (isalnum(*s) || *s == '_')
673 if (namelen >= sizeof(name) - 1)
675 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
676 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
679 name[namelen++] = *s++;
683 while (isspace(*s)) s++;
686 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
695 while (isspace(*s)) s++;
697 /* If an existing macro of the same name was defined on the command line, we
698 just skip this definition. It's an error to attempt to redefine a macro without
699 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
700 It is also an error to define a macro whose name begins with the name of a
701 previously defined macro. This is the requirement that make using a tree
702 for macros hard; we must check all macros for the substring. Perhaps a
703 sorted list, and a bsearch, would work?
704 Note: it is documented that the other way round works. */
706 for (m = macros; m; m = m->next)
708 if (Ustrcmp(m->name, name) == 0)
710 if (!m->command_line && !redef)
712 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
713 "defined (use \"==\" if you want to redefine it)", name);
719 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
721 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
722 "a macro because previously defined macro \"%s\" is a substring",
727 /* We cannot have this test, because it is documented that a substring
728 macro is permitted (there is even an example).
730 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
731 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
732 * "a macro because it is a substring of previously defined macro \"%s\"",
737 /* Check for an overriding command-line definition. */
739 if (m && m->command_line) return TRUE;
741 /* Redefinition must refer to an existing macro. */
746 m->replen = Ustrlen(s);
747 m->replacement = string_copy(s);
751 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
756 /* We have a new definition. */
758 (void) macro_create(name, s, FALSE);
766 /* Process line for macros. The line is in big_buffer starting at offset len.
767 Expand big_buffer if needed. Handle definitions of new macros, and
768 macro expansions, rewriting the line in the buffer.
771 len Offset in buffer of start of line
772 newlen Pointer to offset of end of line, updated on return
773 macro_found Pointer to return that a macro was expanded
775 Return: pointer to first nonblank char in line
779 macros_expand(int len, int * newlen, BOOL * macro_found)
781 uschar * ss = big_buffer + len;
785 /* Find the true start of the physical line - leading spaces are always
788 while (isspace(*ss)) ss++;
790 /* Process the physical line for macros. If this is the start of the logical
791 line, skip over initial text at the start of the line if it starts with an
792 upper case character followed by a sequence of name characters and an equals
793 sign, because that is the definition of a new macro, and we don't do
794 replacement therein. */
797 if (len == 0 && isupper(*s))
799 while (isalnum(*s) || *s == '_') s++;
800 while (isspace(*s)) s++;
801 if (*s != '=') s = ss; /* Not a macro definition */
804 /* Skip leading chars which cannot start a macro name, to avoid multiple
805 pointless rescans in Ustrstr calls. */
807 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
809 /* For each defined macro, scan the line (from after XXX= if present),
810 replacing all occurrences of the macro. */
812 *macro_found = FALSE;
813 if (*s) for (m = *s == '_' ? macros : macros_user; m; m = m->next)
818 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
822 while ((p = Ustrstr(t, m->name)) != NULL)
826 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
827 m->name, (int) Ustrlen(ss)-1, ss);
828 /* Expand the buffer if necessary */
830 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
832 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
833 uschar *newbuffer = store_malloc(newsize);
834 memcpy(newbuffer, big_buffer, *newlen + 1);
835 p = newbuffer + (p - big_buffer);
836 s = newbuffer + (s - big_buffer);
837 ss = newbuffer + (ss - big_buffer);
838 t = newbuffer + (t - big_buffer);
839 big_buffer_size = newsize;
840 store_free(big_buffer);
841 big_buffer = newbuffer;
844 /* Shuffle the remaining characters up or down in the buffer before
845 copying in the replacement text. Don't rescan the replacement for this
849 if ((moveby = m->replen - m->namelen) != 0)
851 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
854 Ustrncpy(p, m->replacement, m->replen);
856 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
861 /* An empty macro replacement at the start of a line could mean that ss no
862 longer points to the first non-blank character. */
864 while (isspace(*ss)) ss++;
868 /*************************************************
869 * Read configuration line *
870 *************************************************/
872 /* A logical line of text is read from the configuration file into the big
873 buffer, taking account of macros, .includes, and continuations. The size of
874 big_buffer is increased if necessary. The count of configuration lines is
875 maintained. Physical input lines starting with # (ignoring leading white space,
876 and after macro replacement) and empty logical lines are always ignored.
877 Leading and trailing spaces are removed.
879 If we hit a line of the form "begin xxxx", the xxxx is placed in the
880 next_section vector, and the function returns NULL, indicating the end of a
881 configuration section. On end-of-file, NULL is returned with next_section
886 Returns: a pointer to the first non-blank in the line,
887 or NULL if eof or end of section is reached
891 get_config_line(void)
893 int startoffset = 0; /* To first non-blank char in logical line */
894 int len = 0; /* Of logical line so far */
899 /* Loop for handling continuation lines, skipping comments, and dealing with
904 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
906 if (config_file_stack != NULL) /* EOF inside .include */
908 (void)fclose(config_file);
909 config_file = config_file_stack->file;
910 config_filename = config_file_stack->filename;
911 config_directory = config_file_stack->directory;
912 config_lineno = config_file_stack->lineno;
913 config_file_stack = config_file_stack->next;
915 save_config_position(config_filename, config_lineno);
919 /* EOF at top level */
921 if (cstate_stack_ptr >= 0)
922 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
923 "Unexpected end of configuration file: .endif missing");
925 if (len != 0) break; /* EOF after continuation */
926 next_section[0] = 0; /* EOF at start of logical line */
931 newlen = len + Ustrlen(big_buffer + len);
933 if (config_lines && config_lineno == 1)
934 save_config_position(config_filename, config_lineno);
936 /* Handle pathologically long physical lines - yes, it did happen - by
937 extending big_buffer at this point. The code also copes with very long
940 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
943 big_buffer_size += BIG_BUFFER_SIZE;
944 newbuffer = store_malloc(big_buffer_size);
946 /* This use of strcpy is OK because we know that the string in the old
947 buffer is shorter than the new buffer. */
949 Ustrcpy(newbuffer, big_buffer);
950 store_free(big_buffer);
951 big_buffer = newbuffer;
952 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
954 newlen += Ustrlen(big_buffer + newlen);
957 ss = macros_expand(len, &newlen, ¯o_found);
959 /* Check for comment lines - these are physical lines. */
961 if (*ss == '#') continue;
963 /* Handle conditionals, which are also applied to physical lines. Conditions
964 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
965 expansion occured on the rest of the line. A preliminary test for the leading
966 '.' saves effort on most lines. */
972 /* Search the list of conditional directives */
974 for (i = 0; i < cond_list_size; i++)
977 cond_item *c = cond_list+i;
978 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
980 /* The following character must be white space or end of string */
982 n = ss[1 + c->namelen];
983 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
985 /* .ifdef and .ifndef push the current state onto the stack, then set
986 a new one from the table. Stack overflow is an error */
990 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
992 ".%s nested too deeply", c->name);
993 cstate_stack[++cstate_stack_ptr] = cstate;
994 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
997 /* For any of the others, stack underflow is an error. The next state
998 comes either from the stack (.endif) or from the table. */
1002 if (cstate_stack_ptr < 0)
1003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1004 ".%s without matching .ifdef", c->name);
1005 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1006 next_cstate[cstate][macro_found? c->action1 : c->action2];
1009 /* Having dealt with a directive, break the loop */
1014 /* If we have handled a conditional directive, continue with the next
1015 physical line. Otherwise, fall through. */
1017 if (i < cond_list_size) continue;
1020 /* If the conditional state is not 0 (actively using these lines), ignore
1023 if (cstate != 0) continue; /* Conditional skip */
1025 /* Handle .include lines - these are also physical lines. */
1027 if (Ustrncmp(ss, ".include", 8) == 0 &&
1029 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1032 int include_if_exists = isspace(ss[8])? 0 : 10;
1033 config_file_item *save;
1034 struct stat statbuf;
1036 ss += 9 + include_if_exists;
1037 while (isspace(*ss)) ss++;
1038 t = ss + Ustrlen(ss);
1039 while (t > ss && isspace(t[-1])) t--;
1040 if (*ss == '\"' && t[-1] == '\"')
1047 /* We allow relative file names. For security reasons currently
1048 relative names not allowed with .include_if_exists. For .include_if_exists
1049 we need to check the permissions/ownership of the containing folder */
1051 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1052 "absolute path \"%s\"", ss);
1055 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1056 ss = string_from_gstring(g);
1059 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1062 save_config_position(config_filename, config_lineno);
1063 save = store_get(sizeof(config_file_item));
1064 save->next = config_file_stack;
1065 config_file_stack = save;
1066 save->file = config_file;
1067 save->filename = config_filename;
1068 save->directory = config_directory;
1069 save->lineno = config_lineno;
1071 if (!(config_file = Ufopen(ss, "rb")))
1072 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1073 "configuration file %s", ss);
1075 config_filename = string_copy(ss);
1076 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1081 /* If this is the start of the logical line, remember where the non-blank
1082 data starts. Otherwise shuffle down continuation lines to remove leading
1086 startoffset = ss - big_buffer;
1089 s = big_buffer + len;
1092 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1097 /* Accept the new addition to the line. Remove trailing white space. */
1100 while (len > 0 && isspace(big_buffer[len-1])) len--;
1101 big_buffer[len] = 0;
1103 /* We are done if the line does not end in backslash and contains some data.
1104 Empty logical lines are ignored. For continuations, remove the backslash and
1105 go round the loop to read the continuation line. */
1109 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1110 big_buffer[--len] = 0; /* Remove backslash */
1112 } /* Loop for reading multiple physical lines */
1114 /* We now have a logical line. Test for the end of a configuration section (or,
1115 more accurately, for the start of the next section). Place the name of the next
1116 section in next_section, and return NULL. If the name given is longer than
1117 next_section, truncate it. It will be unrecognized later, because all the known
1118 section names do fit. Leave space for pluralizing. */
1120 s = big_buffer + startoffset; /* First non-space character */
1123 save_config_line(s);
1125 if (strncmpic(s, US"begin ", 6) == 0)
1128 while (isspace(*s)) s++;
1129 if (big_buffer + len - s > sizeof(next_section) - 2)
1130 s[sizeof(next_section) - 2] = 0;
1131 Ustrcpy(next_section, s);
1135 /* Return the first non-blank character. */
1142 /*************************************************
1144 *************************************************/
1146 /* The yield is the pointer to the next uschar. Names longer than the
1147 output space are silently truncated. This function is also used from acl.c when
1151 name where to put the name
1155 Returns: new input pointer
1159 readconf_readname(uschar *name, int len, uschar *s)
1162 while (isspace(*s)) s++;
1165 while (isalnum(*s) || *s == '_')
1167 if (p < len-1) name[p++] = *s;
1172 while (isspace(*s)) s++;
1179 /*************************************************
1180 * Read a time value *
1181 *************************************************/
1183 /* This function is also called from outside, to read argument
1184 time values. The format of a time value is:
1186 [<n>w][<n>d][<n>h][<n>m][<n>s]
1188 as long as at least one is present. If a format error is encountered,
1189 return a negative value. The value must be terminated by the given
1194 terminator required terminating character
1195 return_msec if TRUE, allow fractional seconds and return milliseconds
1197 Returns: the time value, or -1 on syntax error
1198 value is seconds if return_msec is FALSE
1199 value is milliseconds if return_msec is TRUE
1203 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1211 if (!isdigit(*s)) return -1;
1212 (void)sscanf(CCS s, "%d%n", &value, &count);
1217 case 'w': value *= 7;
1218 case 'd': value *= 24;
1219 case 'h': value *= 60;
1220 case 'm': value *= 60;
1225 if (!return_msec) return -1;
1226 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1228 if (*s++ != 's') return -1;
1229 yield += (int)(fraction * 1000.0);
1235 if (return_msec) value *= 1000;
1237 if (*s == terminator) return yield;
1239 /* Control never reaches here. */
1244 /*************************************************
1245 * Read a fixed point value *
1246 *************************************************/
1248 /* The value is returned *1000
1252 terminator required terminator
1254 Returns: the value, or -1 on error
1258 readconf_readfixed(const uschar *s, int terminator)
1262 if (!isdigit(*s)) return -1;
1263 (void)sscanf(CS s, "%d%n", &value, &count);
1265 yield = value * 1000;
1269 while (isdigit((*(++s))))
1271 yield += (*s - '0') * m;
1276 return (*s == terminator)? yield : (-1);
1281 /*************************************************
1282 * Find option in list *
1283 *************************************************/
1285 /* The lists are always in order, so binary chop can be used.
1288 name the option name to search for
1289 ol the first entry in the option list
1290 last one more than the offset of the last entry in the option list
1292 Returns: pointer to an option entry, or NULL if not found
1296 find_option(uschar *name, optionlist *ol, int last)
1299 while (last > first)
1301 int middle = (first + last)/2;
1302 int c = Ustrcmp(name, ol[middle].name);
1304 if (c == 0) return ol + middle;
1305 else if (c > 0) first = middle + 1;
1313 /*************************************************
1314 * Find a set flag in option list *
1315 *************************************************/
1317 /* Because some versions of Unix make no restrictions on the values of uids and
1318 gids (even negative ones), we cannot represent "unset" by a special value.
1319 There is therefore a separate boolean variable for each one indicating whether
1320 a value is set or not. This function returns a pointer to the boolean, given
1321 the original option name. It is a major disaster if the flag cannot be found.
1324 name the name of the uid or gid option
1325 oltop points to the start of the relevant option list
1326 last one more than the offset of the last item in the option list
1327 data_block NULL when reading main options => data values in the option
1328 list are absolute addresses; otherwise they are byte offsets
1329 in data_block (used for driver options)
1331 Returns: a pointer to the boolean flag.
1335 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1339 sprintf(CS name2, "*set_%.50s", name);
1340 ol = find_option(name2, oltop, last);
1341 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1342 "Exim internal error: missing set flag for %s", name);
1343 return (data_block == NULL)? (BOOL *)(ol->value) :
1344 (BOOL *)(US data_block + (long int)(ol->value));
1350 /*************************************************
1351 * Output extra characters message and die *
1352 *************************************************/
1354 /* Called when an option line has junk on the end. Sometimes this is because
1355 the sysadmin thinks comments are permitted.
1358 s points to the extra characters
1359 t1..t3 strings to insert in the log message
1361 Returns: doesn't return; dies
1365 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1367 uschar *comment = US"";
1368 if (*s == '#') comment = US" (# is comment only at line start)";
1369 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1370 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1375 /*************************************************
1376 * Read rewrite information *
1377 *************************************************/
1379 /* Each line of rewrite information contains:
1381 . A complete address in the form user@domain, possibly with
1382 leading * for each part; or alternatively, a regex.
1384 . A replacement string (which will be expanded).
1386 . An optional sequence of one-letter flags, indicating which
1387 headers etc. to apply this rule to.
1389 All this is decoded and placed into a control block. The OR of the flags is
1390 maintained in a common word.
1393 p points to the string that makes up the rule
1394 existflags points to the overall flag word
1395 isglobal TRUE if reading global rewrite rules
1397 Returns: the control block for the parsed rule.
1400 static rewrite_rule *
1401 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1403 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1406 next->key = string_dequote(&p);
1408 while (isspace(*p)) p++;
1410 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1411 "missing rewrite replacement string");
1414 next->replacement = string_dequote(&p);
1416 while (*p != 0) switch (*p++)
1418 case ' ': case '\t': break;
1420 case 'q': next->flags |= rewrite_quit; break;
1421 case 'w': next->flags |= rewrite_whole; break;
1423 case 'h': next->flags |= rewrite_all_headers; break;
1424 case 's': next->flags |= rewrite_sender; break;
1425 case 'f': next->flags |= rewrite_from; break;
1426 case 't': next->flags |= rewrite_to; break;
1427 case 'c': next->flags |= rewrite_cc; break;
1428 case 'b': next->flags |= rewrite_bcc; break;
1429 case 'r': next->flags |= rewrite_replyto; break;
1431 case 'E': next->flags |= rewrite_all_envelope; break;
1432 case 'F': next->flags |= rewrite_envfrom; break;
1433 case 'T': next->flags |= rewrite_envto; break;
1435 case 'Q': next->flags |= rewrite_qualify; break;
1436 case 'R': next->flags |= rewrite_repeat; break;
1439 next->flags |= rewrite_smtp;
1440 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1441 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1442 "rewrite rule has the S flag but is not a regular expression");
1446 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1447 "unknown rewrite flag character '%c' "
1448 "(could be missing quotes round replacement item)", p[-1]);
1452 /* If no action flags are set, set all the "normal" rewrites. */
1454 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1455 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1457 /* Remember which exist, for optimization, and return the rule */
1459 *existflags |= next->flags;
1466 /*************************************************
1467 * Read global rewrite information *
1468 *************************************************/
1470 /* Each line is a single rewrite rule; it is parsed into a control block
1471 by readconf_one_rewrite(), and its flags are ORed into the global flag
1472 word rewrite_existflags. */
1475 readconf_rewrites(void)
1477 rewrite_rule **chain = &global_rewrite_rules;
1480 while ((p = get_config_line()) != NULL)
1482 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1484 chain = &(next->next);
1490 /*************************************************
1492 *************************************************/
1494 /* Strings are read into the normal store pool. As long we aren't too
1495 near the end of the current block, the string will just use what is necessary
1496 on the top of the stacking pool, because string_cat() uses the extension
1500 s the rest of the input line
1501 name the option name (for errors)
1503 Returns: pointer to the string
1507 read_string(const uschar *s, const uschar *name)
1512 if (*s != '\"') return string_copy(s);
1515 yield = string_dequote(&s);
1517 if (s == ss+1 || s[-1] != '\"')
1518 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1519 "missing quote at end of string value for %s", name);
1521 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1527 /*************************************************
1528 * Custom-handler options *
1529 *************************************************/
1531 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1534 smtp_receive_timeout_s = string_copy(str);
1537 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1538 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1539 if (smtp_receive_timeout < 0)
1540 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1545 /*************************************************
1546 * Handle option line *
1547 *************************************************/
1549 /* This function is called from several places to process a line containing the
1550 setting of an option. The first argument is the line to be decoded; it has been
1551 checked not to be empty and not to start with '#'. Trailing newlines and white
1552 space have been removed. The second argument is a pointer to the list of
1553 variable names that are to be recognized, together with their types and
1554 locations, and the third argument gives the number of entries in the list.
1556 The fourth argument is a pointer to a data block. If it is NULL, then the data
1557 values in the options list are absolute addresses. Otherwise, they are byte
1558 offsets in the data block.
1560 String option data may continue onto several lines; this function reads further
1561 data from config_file if necessary.
1563 The yield of this function is normally zero. If a string continues onto
1564 multiple lines, then the data value is permitted to be followed by a comma
1565 or a semicolon (for use in drivers) and the yield is that character.
1568 buffer contains the configuration line to be handled
1569 oltop points to the start of the relevant option list
1570 last one more than the offset of the last item in the option list
1571 data_block NULL when reading main options => data values in the option
1572 list are absolute addresses; otherwise they are byte offsets
1573 in data_block when they have opt_public set; otherwise
1574 they are byte offsets in data_block->options_block.
1575 unknown_txt format string to use in panic message for unknown option;
1576 must contain %s for option name
1577 if given as NULL, don't panic on unknown option
1579 Returns: TRUE if an option was read successfully,
1580 FALSE false for an unknown option if unknown_txt == NULL,
1581 otherwise panic and die on an unknown option
1585 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1586 void *data_block, uschar *unknown_txt)
1590 int n, count, type, value;
1594 BOOL boolvalue = TRUE;
1595 BOOL freesptr = TRUE;
1596 optionlist *ol, *ol2;
1600 uschar *inttype = US"";
1603 uschar **str_target;
1607 /* There may be leading spaces; thereafter, we expect an option name starting
1610 while (isspace(*s)) s++;
1612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1614 /* Read the name of the option, and skip any subsequent white space. If
1615 it turns out that what we read was "hide", set the flag indicating that
1616 this is a secure option, and loop to read the next word. */
1618 for (n = 0; n < 2; n++)
1620 while (isalnum(*s) || *s == '_')
1622 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1626 while (isspace(*s)) s++;
1627 if (Ustrcmp(name, "hide") != 0) break;
1628 issecure = opt_secure;
1632 /* Deal with "no_" or "not_" here for booleans */
1634 if (Ustrncmp(name, "no_", 3) == 0)
1640 if (Ustrncmp(name, "not_", 4) == 0)
1646 /* Search the list for the given name. A non-existent name, or an option that
1647 is set twice, is a disaster. */
1649 if (!(ol = find_option(name + offset, oltop, last)))
1651 if (unknown_txt == NULL) return FALSE;
1652 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1655 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1656 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1657 "\"%s\" option set for the second time", name);
1659 ol->type |= opt_set | issecure;
1660 type = ol->type & opt_mask;
1662 /* Types with data values must be followed by '='; the "no[t]_" prefix
1663 applies only to boolean values. */
1665 if (type < opt_bool || type > opt_bool_last)
1668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1669 "negation prefix applied to a non-boolean option");
1671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1672 "unexpected end of line (data missing) after %s", name);
1674 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1677 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1678 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1679 ultimately expands to one of those values. */
1681 else if (*s != 0 && (offset != 0 || *s != '='))
1682 extra_chars_error(s, US"boolean option ", name, US"");
1684 /* Skip white space after = */
1686 if (*s == '=') while (isspace((*(++s))));
1688 /* If there is a data block and the opt_public flag is not set, change
1689 the data block pointer to the private options block. */
1691 if (data_block != NULL && (ol->type & opt_public) == 0)
1692 data_block = (void *)(((driver_instance *)data_block)->options_block);
1694 /* Now get the data according to the type. */
1698 /* If a string value is not enclosed in quotes, it consists of
1699 the rest of the current line, verbatim. Otherwise, string escapes
1702 A transport is specified as a string, which is then looked up in the
1703 list of transports. A search type is specified as one of a number of
1706 A set or rewrite rules for a driver is specified as a string, which is
1707 then parsed into a suitable chain of control blocks.
1709 Uids and gids are specified as strings which are then looked up in the
1710 passwd file. Lists of uids and gids are similarly specified as colon-
1711 separated strings. */
1716 case opt_expand_uid:
1717 case opt_expand_gid:
1722 reset_point = sptr = read_string(s, name);
1724 /* Having read a string, we now have several different ways of using it,
1725 depending on the data type, so do another switch. If keeping the actual
1726 string is not required (because it is interpreted), freesptr is set TRUE,
1727 and at the end we reset the pool. */
1731 /* If this was a string, set the variable to point to the new string,
1732 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1733 rules, we still keep the string (for printing), and parse the rules into a
1734 control block and flags word. */
1737 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1739 if (ol->type & opt_rep_con)
1741 uschar * saved_condition;
1742 /* We already have a condition, we're conducting a crude hack to let
1743 multiple condition rules be chained together, despite storing them in
1745 *str_target = string_copy_malloc( (saved_condition = *str_target)
1746 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1747 saved_condition, sptr)
1749 /* TODO(pdp): there is a memory leak here and just below
1750 when we set 3 or more conditions; I still don't
1751 understand the store mechanism enough to know
1752 what's the safe way to free content from an earlier store.
1753 AFAICT, stores stack, so freeing an early stored item also stores
1754 all data alloc'd after it. If we knew conditions were adjacent,
1755 we could survive that, but we don't. So I *think* we need to take
1756 another bit from opt_type to indicate "malloced"; this seems like
1757 quite a hack, especially for this one case. It also means that
1758 we can't ever reclaim the store from the *first* condition.
1760 Because we only do this once, near process start-up, I'm prepared to
1761 let this slide for the time being, even though it rankles. */
1763 else if (ol->type & opt_rep_str)
1765 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1766 int sep_i = -(int)sep_o;
1767 const uschar * list = sptr;
1769 gstring * list_o = NULL;
1773 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1774 list_o = string_cat(list_o, *str_target);
1777 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1778 list_o = string_append_listele(list_o, sep_o, s);
1781 *str_target = string_copy_malloc(string_from_gstring(list_o));
1792 *USS (US data_block + (long int)(ol->value)) = sptr;
1794 *USS (ol->value) = sptr;
1796 if (type == opt_rewrite)
1801 rewrite_rule **chain;
1804 sprintf(CS name2, "*%.50s_rules", name);
1805 ol2 = find_option(name2, oltop, last);
1806 sprintf(CS name2, "*%.50s_flags", name);
1807 ol3 = find_option(name2, oltop, last);
1809 if (ol2 == NULL || ol3 == NULL)
1810 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1811 "rewrite rules not available for driver");
1813 if (data_block == NULL)
1815 chain = (rewrite_rule **)(ol2->value);
1816 flagptr = (int *)(ol3->value);
1820 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1821 flagptr = (int *)(US data_block + (long int)(ol3->value));
1824 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1826 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1828 chain = &(next->next);
1831 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1832 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1833 "non-header rewrite - not allowed at transport time -");
1837 /* If it was an expanded uid, see if there is any expansion to be
1838 done by checking for the presence of a $ character. If there is, save it
1839 in the corresponding *expand_user option field. Otherwise, fall through
1840 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1843 case opt_expand_uid:
1844 sprintf(CS name2, "*expand_%.50s", name);
1845 ol2 = find_option(name2, oltop, last);
1848 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1850 if (data_block == NULL)
1851 *((uschar **)(ol2->value)) = ss;
1853 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1857 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1863 /* Look up a fixed uid, and also make use of the corresponding gid
1864 if a passwd entry is returned and the gid has not been set. */
1867 if (!route_finduser(sptr, &pw, &uid))
1868 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1869 if (data_block == NULL)
1870 *((uid_t *)(ol->value)) = uid;
1872 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1874 /* Set the flag indicating a fixed value is set */
1876 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1878 /* Handle matching gid if we have a passwd entry: done by finding the
1879 same name with terminating "user" changed to "group"; if not found,
1880 ignore. Also ignore if the value is already set. */
1882 if (pw == NULL) break;
1883 Ustrcpy(name+Ustrlen(name)-4, "group");
1884 ol2 = find_option(name, oltop, last);
1885 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1886 (ol2->type & opt_mask) == opt_expand_gid))
1888 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1891 if (data_block == NULL)
1892 *((gid_t *)(ol2->value)) = pw->pw_gid;
1894 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1900 /* If it was an expanded gid, see if there is any expansion to be
1901 done by checking for the presence of a $ character. If there is, save it
1902 in the corresponding *expand_user option field. Otherwise, fall through
1903 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1906 case opt_expand_gid:
1907 sprintf(CS name2, "*expand_%.50s", name);
1908 ol2 = find_option(name2, oltop, last);
1911 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1913 if (data_block == NULL)
1914 *((uschar **)(ol2->value)) = ss;
1916 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1920 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1926 /* Handle freestanding gid */
1929 if (!route_findgroup(sptr, &gid))
1930 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1931 if (data_block == NULL)
1932 *((gid_t *)(ol->value)) = gid;
1934 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1935 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1938 /* If it was a uid list, look up each individual entry, and build
1939 a vector of uids, with a count in the first element. Put the vector
1940 in malloc store so we can free the string. (We are reading into
1941 permanent store already.) */
1949 const uschar *op = expand_string (sptr);
1952 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1953 name, expand_string_message);
1956 if (*p != 0) count++;
1957 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1958 list = store_malloc(count*sizeof(uid_t));
1959 list[ptr++] = (uid_t)(count - 1);
1961 if (data_block == NULL)
1962 *((uid_t **)(ol->value)) = list;
1964 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1970 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1971 if (!route_finduser(big_buffer, NULL, &uid))
1972 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1979 /* If it was a gid list, look up each individual entry, and build
1980 a vector of gids, with a count in the first element. Put the vector
1981 in malloc store so we can free the string. (We are reading into permanent
1990 const uschar *op = expand_string (sptr);
1993 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1994 name, expand_string_message);
1997 if (*p != 0) count++;
1998 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1999 list = store_malloc(count*sizeof(gid_t));
2000 list[ptr++] = (gid_t)(count - 1);
2002 if (data_block == NULL)
2003 *((gid_t **)(ol->value)) = list;
2005 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2011 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2012 if (!route_findgroup(big_buffer, &gid))
2013 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2021 /* Release store if the value of the string doesn't need to be kept. */
2023 if (freesptr) store_reset(reset_point);
2026 /* Expanded boolean: if no characters follow, or if there are no dollar
2027 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2028 save the string for later expansion in the alternate place. */
2030 case opt_expand_bool:
2031 if (*s != 0 && Ustrchr(s, '$') != 0)
2033 sprintf(CS name2, "*expand_%.50s", name);
2034 ol2 = find_option(name2, oltop, last);
2037 reset_point = sptr = read_string(s, name);
2038 if (data_block == NULL)
2039 *((uschar **)(ol2->value)) = sptr;
2041 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2048 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2049 look for yes/not/true/false. Some booleans are stored in a single bit in
2050 a single int. There's a special fudge for verify settings; without a suffix
2051 they set both xx_sender and xx_recipient. The table points to the sender
2052 value; search subsequently for the recipient. There's another special case:
2053 opt_bool_set also notes when a boolean has been set. */
2057 case opt_bool_verify:
2061 s = readconf_readname(name2, 64, s);
2062 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2064 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2066 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2067 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2068 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2069 US"for boolean option ", name);
2072 /* Handle single-bit type. */
2074 if (type == opt_bit)
2076 int bit = 1 << ((ol->type >> 16) & 31);
2077 int *ptr = (data_block == NULL)?
2078 (int *)(ol->value) :
2079 (int *)(US data_block + (long int)ol->value);
2080 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2084 /* Handle full BOOL types */
2086 if (data_block == NULL)
2087 *((BOOL *)(ol->value)) = boolvalue;
2089 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2093 if (type == opt_bool_verify)
2095 sprintf(CS name2, "%.50s_recipient", name + offset);
2096 ol2 = find_option(name2, oltop, last);
2099 if (data_block == NULL)
2100 *((BOOL *)(ol2->value)) = boolvalue;
2102 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2106 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2108 else if (type == opt_bool_set)
2110 sprintf(CS name2, "*set_%.50s", name + offset);
2111 ol2 = find_option(name2, oltop, last);
2114 if (data_block == NULL)
2115 *((BOOL *)(ol2->value)) = TRUE;
2117 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2126 inttype = US"octal ";
2128 /* Integer: a simple(ish) case; allow octal and hex formats, and
2129 suffixes K, M and G. The different types affect output, not input. */
2138 lvalue = strtol(CS s, CSS &endptr, intbase);
2141 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2144 if (errno != ERANGE && *endptr)
2146 uschar * mp = US"GgMmKk\0"; /* YyZzEePpTtGgMmKk */
2148 if ((mp = Ustrchr(mp, *endptr)))
2153 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2164 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2165 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2166 "absolute value of integer \"%s\" is too large (overflow)", s);
2168 while (isspace(*endptr)) endptr++;
2170 extra_chars_error(endptr, inttype, US"integer value for ", name);
2172 value = (int)lvalue;
2176 *(int *)(US data_block + (long int)ol->value) = value;
2178 *(int *)ol->value = value;
2181 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M,
2188 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2191 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2194 if (errno != ERANGE && *endptr)
2196 uschar * mp = US"EePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2198 if ((mp = Ustrchr(mp, *endptr)))
2203 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2213 lvalue = (lvalue + 512)/1024;
2216 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2217 "absolute value of integer \"%s\" is too large (overflow)", s);
2219 while (isspace(*endptr)) endptr++;
2221 extra_chars_error(endptr, inttype, US"integer value for ", name);
2224 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2226 *(int_eximarith_t *)ol->value = lvalue;
2230 /* Fixed-point number: held to 3 decimal places. */
2233 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2234 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2235 "fixed-point number expected for %s", name);
2237 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2238 "integer \"%s\" is too large (overflow)", s);
2242 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2243 "integer \"%s\" is too large (overflow)", s);
2245 /* We get a coverity error here for using count, as it derived
2246 from the tainted buffer pointed to by s, as parsed by sscanf().
2247 By the definition of sscanf we must be accessing between start
2248 and end of s (assuming it is nul-terminated...) so ignore the error. */
2249 /* coverity[tainted_data] */
2250 if (s[count] == '.')
2253 while (isdigit(s[++count]))
2255 value += (s[count] - '0') * d;
2260 while (isspace(s[count])) count++;
2263 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2265 if (data_block == NULL)
2266 *((int *)(ol->value)) = value;
2268 *((int *)(US data_block + (long int)(ol->value))) = value;
2271 /* There's a special routine to read time values. */
2274 value = readconf_readtime(s, 0, FALSE);
2276 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2278 if (data_block == NULL)
2279 *((int *)(ol->value)) = value;
2281 *((int *)(US data_block + (long int)(ol->value))) = value;
2284 /* A time list is a list of colon-separated times, with the first
2285 element holding the size of the list and the second the number of
2291 int *list = (data_block == NULL)?
2292 (int *)(ol->value) :
2293 (int *)(US data_block + (long int)(ol->value));
2295 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2298 uschar *snext = Ustrchr(s, ':');
2302 while (ss > s && isspace(ss[-1])) ss--;
2305 value = readconf_readtime(s, terminator, FALSE);
2307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2309 if (count > 1 && value <= list[count])
2310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2311 "time value out of order for %s", name);
2312 list[count+1] = value;
2313 if (snext == NULL) break;
2315 while (isspace(*s)) s++;
2318 if (count > list[0] - 2)
2319 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2321 if (count > 0 && list[2] == 0) count = 0;
2328 void (*fn)() = ol->value;
2339 /*************************************************
2340 * Print a time value *
2341 *************************************************/
2344 Argument: a time value in seconds
2345 Returns: pointer to a fixed buffer containing the time as a string,
2346 in readconf_readtime() format
2350 readconf_printtime(int t)
2353 uschar *p = time_buffer;
2370 if (w > 0) p += sprintf(CS p, "%dw", w);
2371 if (d > 0) p += sprintf(CS p, "%dd", d);
2372 if (h > 0) p += sprintf(CS p, "%dh", h);
2373 if (m > 0) p += sprintf(CS p, "%dm", m);
2374 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2381 /*************************************************
2382 * Print an individual option value *
2383 *************************************************/
2385 /* This is used by the -bP option, so prints to the standard output.
2386 The entire options list is passed in as an argument, because some options come
2387 in pairs - typically uid/gid settings, which can either be explicit numerical
2388 values, or strings to be expanded later. If the numerical value is unset,
2389 search for "*expand_<name>" to see if there is a string equivalent.
2392 ol option entry, or NULL for an unknown option
2394 options_block NULL for main configuration options; otherwise points to
2395 a driver block; if the option doesn't have opt_public
2396 set, then options_block->options_block is where the item
2398 oltop points to the option list in which ol exists
2399 last one more than the offset of the last entry in optop
2400 no_labels do not show "foo = " at the start.
2402 Returns: boolean success
2406 print_ol(optionlist *ol, uschar *name, void *options_block,
2407 optionlist *oltop, int last, BOOL no_labels)
2420 printf("%s is not a known option\n", name);
2424 /* Non-admin callers cannot see options that have been flagged secure by the
2427 if (!f.admin_user && ol->type & opt_secure)
2430 printf("%s\n", hidden);
2432 printf("%s = %s\n", name, hidden);
2436 /* Else show the value of the option */
2441 if (!(ol->type & opt_public))
2442 options_block = (void *)(((driver_instance *)options_block)->options_block);
2443 value = (void *)(US options_block + (long int)value);
2446 switch(ol->type & opt_mask)
2449 case opt_rewrite: /* Show the text value */
2451 if (!no_labels) printf("%s = ", name);
2452 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2456 if (!no_labels) printf("%s = ", name);
2457 printf("%d\n", *((int *)value));
2462 int x = *((int *)value);
2463 if (x != 0 && (x & 1023) == 0)
2467 if ((x & 1023) == 0)
2472 if (!no_labels) printf("%s = ", name);
2473 printf("%d%c\n", x, c);
2477 if (!no_labels) printf("%s = ", name);
2485 int_eximarith_t x = *((int_eximarith_t *)value);
2486 if (!no_labels) printf("%s = ", name);
2487 if (x == 0) printf("0\n");
2488 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2489 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2490 else printf(PR_EXIM_ARITH "K\n", x);
2495 if (!no_labels) printf("%s = ", name);
2496 printf("%#o\n", *((int *)value));
2499 /* Can be negative only when "unset", in which case integer */
2503 int x = *((int *)value);
2506 if (x < 0) printf("%s =\n", name); else
2508 if (!no_labels) printf("%s = ", name);
2509 printf("%d.", x/1000);
2522 /* If the numerical value is unset, try for the string value */
2524 case opt_expand_uid:
2525 if (! *get_set_flag(name, oltop, last, options_block))
2527 sprintf(CS name2, "*expand_%.50s", name);
2528 if ((ol2 = find_option(name2, oltop, last)))
2530 void *value2 = ol2->value;
2532 value2 = (void *)(US options_block + (long int)value2);
2534 if (!no_labels) printf("%s = ", name);
2535 printf("%s\n", s ? string_printing(s) : US"");
2540 /* Else fall through */
2543 if (!no_labels) printf("%s = ", name);
2544 if (! *get_set_flag(name, oltop, last, options_block))
2547 if ((pw = getpwuid(*((uid_t *)value))))
2548 printf("%s\n", pw->pw_name);
2550 printf("%ld\n", (long int)(*((uid_t *)value)));
2553 /* If the numerical value is unset, try for the string value */
2555 case opt_expand_gid:
2556 if (! *get_set_flag(name, oltop, last, options_block))
2558 sprintf(CS name2, "*expand_%.50s", name);
2559 if ( (ol2 = find_option(name2, oltop, last))
2560 && (ol2->type & opt_mask) == opt_stringptr)
2562 void *value2 = ol2->value;
2564 value2 = (void *)(US options_block + (long int)value2);
2566 if (!no_labels) printf("%s = ", name);
2567 printf("%s\n", s ? string_printing(s) : US"");
2572 /* Else fall through */
2575 if (!no_labels) printf("%s = ", name);
2576 if (! *get_set_flag(name, oltop, last, options_block))
2579 if ((gr = getgrgid(*((int *)value))))
2580 printf("%s\n", gr->gr_name);
2582 printf("%ld\n", (long int)(*((int *)value)));
2586 uidlist = *((uid_t **)value);
2587 if (!no_labels) printf("%s =", name);
2591 uschar sep = no_labels ? '\0' : ' ';
2592 for (i = 1; i <= (int)(uidlist[0]); i++)
2594 uschar *name = NULL;
2595 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2596 if (sep != '\0') printf("%c", sep);
2597 if (name) printf("%s", name);
2598 else printf("%ld", (long int)(uidlist[i]));
2606 gidlist = *((gid_t **)value);
2607 if (!no_labels) printf("%s =", name);
2611 uschar sep = no_labels ? '\0' : ' ';
2612 for (i = 1; i <= (int)(gidlist[0]); i++)
2614 uschar *name = NULL;
2615 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2616 if (sep != '\0') printf("%c", sep);
2617 if (name) printf("%s", name);
2618 else printf("%ld", (long int)(gidlist[i]));
2626 if (!no_labels) printf("%s = ", name);
2627 printf("%s\n", readconf_printtime(*((int *)value)));
2633 int *list = (int *)value;
2634 if (!no_labels) printf("%s = ", name);
2635 for (i = 0; i < list[1]; i++)
2636 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2642 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2646 case opt_expand_bool:
2647 sprintf(CS name2, "*expand_%.50s", name);
2648 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2650 void *value2 = ol2->value;
2652 value2 = (void *)(US options_block + (long int)value2);
2656 if (!no_labels) printf("%s = ", name);
2657 printf("%s\n", string_printing(s));
2660 /* s == NULL => string not set; fall through */
2666 case opt_bool_verify:
2668 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2676 /*************************************************
2677 * Print value from main configuration *
2678 *************************************************/
2680 /* This function, called as a result of encountering the -bP option,
2681 causes the value of any main configuration variable to be output if the
2682 second argument is NULL. There are some special values:
2684 all print all main configuration options
2685 config_file print the name of the configuration file
2686 (configure_file will still work, for backward
2688 routers print the routers' configurations
2689 transports print the transports' configuration
2690 authenticators print the authenticators' configuration
2691 macros print the macros' configuration
2692 router_list print a list of router names
2693 transport_list print a list of transport names
2694 authenticator_list print a list of authentication mechanism names
2695 macro_list print a list of macro names
2696 +name print a named list item
2697 local_scan print the local_scan options
2698 config print the configuration as it is parsed
2699 environment print the used execution environment
2701 If the second argument is not NULL, it must be one of "router", "transport",
2702 "authenticator" or "macro" in which case the first argument identifies the
2703 driver whose options are to be printed.
2706 name option name if type == NULL; else driver name
2707 type NULL or driver type name, as described above
2708 no_labels avoid the "foo = " at the start of an item
2710 Returns: Boolean success
2714 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2716 BOOL names_only = FALSE;
2718 optionlist *ol2 = NULL;
2719 driver_instance *d = NULL;
2730 static uschar *types[] = { US"address", US"domain", US"host",
2732 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2733 &hostlist_anchor, &localpartlist_anchor };
2735 for (i = 0; i < 4; i++)
2736 if ((t = tree_search(*(anchors[i]), name+1)))
2740 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2742 printf("%slist %s = %s\n", types[i], name+1,
2743 ((namedlist_block *)(t->data.ptr))->string);
2747 printf("no address, domain, host, or local part list called \"%s\" "
2748 "exists\n", name+1);
2753 if ( Ustrcmp(name, "configure_file") == 0
2754 || Ustrcmp(name, "config_file") == 0)
2756 printf("%s\n", CS config_main_filename);
2760 if (Ustrcmp(name, "all") == 0)
2762 for (ol = optionlist_config;
2763 ol < optionlist_config + nelem(optionlist_config); ol++)
2764 if (!(ol->type & opt_hidden))
2765 (void) print_ol(ol, US ol->name, NULL,
2766 optionlist_config, nelem(optionlist_config),
2771 if (Ustrcmp(name, "local_scan") == 0)
2773 #ifndef LOCAL_SCAN_HAS_OPTIONS
2774 printf("local_scan() options are not supported\n");
2777 for (ol = local_scan_options;
2778 ol < local_scan_options + local_scan_options_count; ol++)
2779 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2780 local_scan_options_count, no_labels);
2785 if (Ustrcmp(name, "config") == 0)
2787 print_config(f.admin_user, no_labels);
2791 if (Ustrcmp(name, "routers") == 0)
2796 else if (Ustrcmp(name, "transports") == 0)
2798 type = US"transport";
2801 else if (Ustrcmp(name, "authenticators") == 0)
2803 type = US"authenticator";
2806 else if (Ustrcmp(name, "macros") == 0)
2811 else if (Ustrcmp(name, "router_list") == 0)
2817 else if (Ustrcmp(name, "transport_list") == 0)
2819 type = US"transport";
2823 else if (Ustrcmp(name, "authenticator_list") == 0)
2825 type = US"authenticator";
2829 else if (Ustrcmp(name, "macro_list") == 0)
2835 else if (Ustrcmp(name, "environment") == 0)
2840 for (p = USS environ; *p; p++) ;
2841 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2843 for (p = USS environ; *p; p++)
2846 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2854 return print_ol(find_option(name,
2855 optionlist_config, nelem(optionlist_config)),
2856 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2859 /* Handle the options for a router or transport. Skip options that are flagged
2860 as hidden. Some of these are options with names starting with '*', used for
2861 internal alternative representations of other options (which the printing
2862 function will sort out). Others are synonyms kept for backward compatibility.
2865 if (Ustrcmp(type, "router") == 0)
2867 d = (driver_instance *)routers;
2868 ol2 = optionlist_routers;
2869 size = optionlist_routers_size;
2871 else if (Ustrcmp(type, "transport") == 0)
2873 d = (driver_instance *)transports;
2874 ol2 = optionlist_transports;
2875 size = optionlist_transports_size;
2877 else if (Ustrcmp(type, "authenticator") == 0)
2879 d = (driver_instance *)auths;
2880 ol2 = optionlist_auths;
2881 size = optionlist_auths_size;
2884 else if (Ustrcmp(type, "macro") == 0)
2886 /* People store passwords in macros and they were previously not available
2887 for printing. So we have an admin_users restriction. */
2890 fprintf(stderr, "exim: permission denied\n");
2893 for (m = macros; m; m = m->next)
2894 if (!name || Ustrcmp(name, m->name) == 0)
2897 printf("%s\n", CS m->name);
2899 printf("%s\n", CS m->replacement);
2901 printf("%s=%s\n", CS m->name, CS m->replacement);
2905 if (!name) return TRUE;
2907 printf("%s %s not found\n", type, name);
2913 for (; d; d = d->next) printf("%s\n", CS d->name);
2917 /* Either search for a given driver, or print all of them */
2919 for (; d; d = d->next)
2923 printf("\n%s %s:\n", d->name, type);
2924 else if (Ustrcmp(d->name, name) != 0) continue;
2926 for (ol = ol2; ol < ol2 + size; ol++)
2927 if (!(ol->type & opt_hidden))
2928 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2930 for (ol = d->info->options;
2931 ol < d->info->options + *(d->info->options_count); ol++)
2932 if (!(ol->type & opt_hidden))
2933 rc |= print_ol(ol, US ol->name, d, d->info->options,
2934 *d->info->options_count, no_labels);
2936 if (name) return rc;
2938 if (!name) return TRUE;
2940 printf("%s %s not found\n", type, name);
2946 /*************************************************
2947 * Read a named list item *
2948 *************************************************/
2950 /* This function reads a name and a list (i.e. string). The name is used to
2951 save the list in a tree, sorted by its name. Each entry also has a number,
2952 which can be used for caching tests, but if the string contains any expansion
2953 items other than $key, the number is set negative to inhibit caching. This
2954 mechanism is used for domain, host, and address lists that are referenced by
2958 anchorp points to the tree anchor
2959 numberp points to the current number for this tree
2960 max the maximum number permitted
2961 s the text of the option line, starting immediately after the name
2963 tname the name of the list type, for messages
2969 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2972 BOOL forcecache = FALSE;
2975 namedlist_block *nb = store_get(sizeof(namedlist_block));
2977 if (Ustrncmp(s, "_cache", 6) == 0)
2984 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2986 if (*numberp >= max)
2987 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2990 while (isspace(*s)) s++;
2992 while (isalnum(*s) || *s == '_') s++;
2993 t = store_get(sizeof(tree_node) + s-ss);
2994 Ustrncpy(t->name, ss, s-ss);
2996 while (isspace(*s)) s++;
2998 if (!tree_insertnode(anchorp, t))
2999 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3000 "duplicate name \"%s\" for a named %s", t->name, tname);
3003 nb->number = *numberp;
3006 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3007 "missing '=' after \"%s\"", t->name);
3008 while (isspace(*s)) s++;
3009 nb->string = read_string(s, t->name);
3010 nb->cache_data = NULL;
3012 /* Check the string for any expansions; if any are found, mark this list
3013 uncacheable unless the user has explicited forced caching. */
3015 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3021 /*************************************************
3022 * Unpick data for a rate limit *
3023 *************************************************/
3025 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3029 s string, in the form t,b,f,l
3030 where t is the threshold (integer)
3031 b is the initial delay (time)
3032 f is the multiplicative factor (fixed point)
3033 k is the maximum time (time)
3034 threshold where to store threshold
3035 base where to store base in milliseconds
3036 factor where to store factor in milliseconds
3037 limit where to store limit
3039 Returns: nothing (panics on error)
3043 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3046 uschar bstring[16], lstring[16];
3048 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3049 factor, lstring) == 4)
3051 *base = readconf_readtime(bstring, 0, TRUE);
3052 *limit = readconf_readtime(lstring, 0, TRUE);
3053 if (*base >= 0 && *limit >= 0) return;
3055 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3061 /*************************************************
3062 * Drop privs for checking TLS config *
3063 *************************************************/
3065 /* We want to validate TLS options during readconf, but do not want to be
3066 root when we call into the TLS library, in case of library linkage errors
3067 which cause segfaults; before this check, those were always done as the Exim
3068 runtime user and it makes sense to continue with that.
3070 Assumes: tls_require_ciphers has been set, if it will be
3071 exim_user has been set, if it will be
3072 exim_group has been set, if it will be
3074 Returns: bool for "okay"; false will cause caller to immediately exit.
3079 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3081 const uschar *errmsg;
3084 void (*oldsignal)(int);
3086 /* If TLS will never be used, no point checking ciphers */
3088 if ( !tls_advertise_hosts
3089 || !*tls_advertise_hosts
3090 || Ustrcmp(tls_advertise_hosts, ":") == 0
3093 else if (!nowarn && !tls_certificate)
3094 log_write(0, LOG_MAIN,
3095 "Warning: No server certificate defined; will use a selfsigned one.\n"
3096 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3098 oldsignal = signal(SIGCHLD, SIG_DFL);
3101 if ((pid = fork()) < 0)
3102 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3106 /* in some modes, will have dropped privilege already */
3108 exim_setugid(exim_uid, exim_gid, FALSE,
3109 US"calling tls_validate_require_cipher");
3111 if ((errmsg = tls_validate_require_cipher()))
3112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3113 "tls_require_ciphers invalid: %s", errmsg);
3119 rc = waitpid(pid, &status, 0);
3120 } while (rc < 0 && errno == EINTR);
3123 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3126 signal(SIGCHLD, oldsignal);
3130 #endif /* SUPPORT_TLS */
3135 /*************************************************
3136 * Read main configuration options *
3137 *************************************************/
3139 /* This function is the first to be called for configuration reading. It
3140 opens the configuration file and reads general configuration settings until
3141 it reaches the end of the configuration section. The file is then left open so
3142 that the remaining configuration data can subsequently be read if needed for
3145 The configuration file must be owned either by root or exim, and be writeable
3146 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3147 in the config file, so the test is done on the compiled in values. A slight
3148 anomaly, to be carefully documented.
3150 The name of the configuration file is taken from a list that is included in the
3151 binary of Exim. It can be altered from the command line, but if that is done,
3152 root privilege is immediately withdrawn unless the caller is root or exim.
3153 The first file on the list that exists is used.
3155 For use on multiple systems that share file systems, first look for a
3156 configuration file whose name has the current node name on the end. If that is
3157 not found, try the generic name. For really contorted configurations, that run
3158 multiple Exims with different uid settings, first try adding the effective uid
3159 before the node name. These complications are going to waste resources on most
3160 systems. Therefore they are available only when requested by compile-time
3164 readconf_main(BOOL nowarn)
3167 struct stat statbuf;
3168 uschar *s, *filename;
3169 const uschar *list = config_main_filelist;
3171 /* Loop through the possible file names */
3173 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3176 /* Cut out all the fancy processing unless specifically wanted */
3178 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3179 uschar *suffix = filename + Ustrlen(filename);
3181 /* Try for the node-specific file if a node name exists */
3183 #ifdef CONFIGURE_FILE_USE_NODE
3185 if (uname(&uts) >= 0)
3187 #ifdef CONFIGURE_FILE_USE_EUID
3188 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3189 config_file = Ufopen(filename, "rb");
3190 if (config_file == NULL)
3191 #endif /* CONFIGURE_FILE_USE_EUID */
3193 sprintf(CS suffix, ".%.256s", uts.nodename);
3194 config_file = Ufopen(filename, "rb");
3197 #endif /* CONFIGURE_FILE_USE_NODE */
3199 /* Otherwise, try the generic name, possibly with the euid added */
3201 #ifdef CONFIGURE_FILE_USE_EUID
3202 if (config_file == NULL)
3204 sprintf(CS suffix, ".%ld", (long int)original_euid);
3205 config_file = Ufopen(filename, "rb");
3207 #endif /* CONFIGURE_FILE_USE_EUID */
3209 /* Finally, try the unadorned name */
3211 if (config_file == NULL)
3214 config_file = Ufopen(filename, "rb");
3216 #else /* if neither defined */
3218 /* This is the common case when the fancy processing is not included. */
3220 config_file = Ufopen(filename, "rb");
3223 /* If the file does not exist, continue to try any others. For any other
3224 error, break out (and die). */
3226 if (config_file != NULL || errno != ENOENT) break;
3229 /* On success, save the name for verification; config_filename is used when
3230 logging configuration errors (it changes for .included files) whereas
3231 config_main_filename is the name shown by -bP. Failure to open a configuration
3232 file is a serious disaster. */
3236 uschar *last_slash = Ustrrchr(filename, '/');
3237 config_filename = config_main_filename = string_copy(filename);
3239 /* The config_main_directory we need for the $config_dir expansion.
3240 config_main_filename we need for $config_file expansion.
3241 And config_dir is the directory of the current configuration, used for
3242 relative .includes. We do need to know it's name, as we change our working
3245 if (filename[0] == '/')
3246 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3249 /* relative configuration file name: working dir + / + basename(filename) */
3251 uschar buf[PATH_MAX];
3254 if (os_getcwd(buf, PATH_MAX) == NULL)
3256 perror("exim: getcwd");
3259 g = string_cat(NULL, buf);
3261 /* If the dir does not end with a "/", append one */
3262 if (g->s[g->ptr-1] != '/')
3263 g = string_catn(g, US"/", 1);
3265 /* If the config file contains a "/", extract the directory part */
3267 g = string_catn(g, filename, last_slash - filename);
3269 config_main_directory = string_from_gstring(g);
3271 config_directory = config_main_directory;
3275 if (filename == NULL)
3276 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3277 "%s", config_main_filelist);
3279 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3280 "configuration file %s", filename));
3283 /* Now, once we found and opened our configuration file, we change the directory
3284 to a safe place. Later we change to $spool_directory. */
3286 if (Uchdir("/") < 0)
3288 perror("exim: chdir `/': ");
3292 /* Check the status of the file we have opened, if we have retained root
3293 privileges and the file isn't /dev/null (which *should* be 0666). */
3295 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3297 if (fstat(fileno(config_file), &statbuf) != 0)
3298 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3301 if ((statbuf.st_uid != root_uid /* owner not root */
3302 #ifdef CONFIGURE_OWNER
3303 && statbuf.st_uid != config_uid /* owner not the special one */
3306 (statbuf.st_gid != root_gid /* group not root & */
3307 #ifdef CONFIGURE_GROUP
3308 && statbuf.st_gid != config_gid /* group not the special one */
3310 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3312 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3314 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3315 "wrong owner, group, or mode", big_buffer);
3318 /* Process the main configuration settings. They all begin with a lower case
3319 letter. If we see something starting with an upper case letter, it is taken as
3320 a macro definition. */
3322 while ((s = get_config_line()))
3324 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3325 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3326 "found unexpected BOM (Byte Order Mark)");
3329 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3331 else if (Ustrncmp(s, "domainlist", 10) == 0)
3332 read_named_list(&domainlist_anchor, &domainlist_count,
3333 MAX_NAMED_LIST, s+10, US"domain list");
3335 else if (Ustrncmp(s, "hostlist", 8) == 0)
3336 read_named_list(&hostlist_anchor, &hostlist_count,
3337 MAX_NAMED_LIST, s+8, US"host list");
3339 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3340 read_named_list(&addresslist_anchor, &addresslist_count,
3341 MAX_NAMED_LIST, s+11, US"address list");
3343 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3344 read_named_list(&localpartlist_anchor, &localpartlist_count,
3345 MAX_NAMED_LIST, s+13, US"local part list");
3348 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3349 NULL, US"main option \"%s\" unknown");
3353 /* If local_sender_retain is set, local_from_check must be unset. */
3355 if (local_sender_retain && local_from_check)
3356 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3357 "local_sender_retain are set; this combination is not allowed");
3359 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3362 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3364 /* The max retry interval must not be greater than 24 hours. */
3366 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3368 /* remote_max_parallel must be > 0 */
3370 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3372 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3373 start of a new SMTP message. */
3375 freeze_tell_config = freeze_tell;
3377 /* The primary host name may be required for expansion of spool_directory
3378 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3379 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3380 canonize it. Some people like upper case letters in their host names, so we
3381 don't force the case. */
3383 if (primary_hostname == NULL)
3385 const uschar *hostname;
3387 if (uname(&uts) < 0)
3388 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3389 hostname = US uts.nodename;
3391 if (Ustrchr(hostname, '.') == NULL)
3394 struct hostent *hostdata;
3397 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3398 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3399 MCL_DOMAIN, TRUE, NULL) != OK))
3408 #if HAVE_GETIPNODEBYNAME
3410 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3412 hostdata = gethostbyname2(CS hostname, af);
3415 hostdata = gethostbyname(CS hostname);
3418 if (hostdata != NULL)
3420 hostname = US hostdata->h_name;
3424 if (af == AF_INET) break;
3429 primary_hostname = string_copy(hostname);
3432 /* Set up default value for smtp_active_hostname */
3434 smtp_active_hostname = primary_hostname;
3436 /* If spool_directory wasn't set in the build-time configuration, it must have
3437 got set above. Of course, writing to the log may not work if log_file_path is
3438 not set, but it will at least get to syslog or somewhere, with any luck. */
3440 if (*spool_directory == 0)
3441 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3444 /* Expand the spool directory name; it may, for example, contain the primary
3445 host name. Same comment about failure. */
3447 s = expand_string(spool_directory);
3449 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3450 "\"%s\": %s", spool_directory, expand_string_message);
3451 spool_directory = s;
3453 /* Expand log_file_path, which must contain "%s" in any component that isn't
3454 the null string or "syslog". It is also allowed to contain one instance of %D
3455 or %M. However, it must NOT contain % followed by anything else. */
3457 if (*log_file_path != 0)
3459 const uschar *ss, *sss;
3460 int sep = ':'; /* Fixed for log file path */
3461 s = expand_string(log_file_path);
3463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3464 "\"%s\": %s", log_file_path, expand_string_message);
3467 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3470 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3471 t = Ustrstr(sss, "%s");
3473 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3474 "contain \"%%s\"", sss);
3476 t = Ustrchr(sss, '%');
3479 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3480 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3481 "unexpected \"%%\" character", s);
3488 /* Interpret syslog_facility into an integer argument for 'ident' param to
3489 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3492 if (syslog_facility_str)
3495 uschar *s = syslog_facility_str;
3497 if ((Ustrlen(syslog_facility_str) >= 4) &&
3498 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3501 for (i = 0; i < syslog_list_size; i++)
3502 if (strcmpic(s, syslog_list[i].name) == 0)
3504 syslog_facility = syslog_list[i].value;
3508 if (i >= syslog_list_size)
3509 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3510 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3513 /* Expand pid_file_path */
3515 if (*pid_file_path != 0)
3517 if (!(s = expand_string(pid_file_path)))
3518 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3519 "\"%s\": %s", pid_file_path, expand_string_message);
3523 /* Set default value of process_log_path */
3525 if (!process_log_path || *process_log_path =='\0')
3526 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3528 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3531 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3533 /* Unpick the SMTP rate limiting options, if set */
3535 if (smtp_ratelimit_mail)
3536 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3537 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3539 if (smtp_ratelimit_rcpt)
3540 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3541 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3543 /* The qualify domains default to the primary host name */
3545 if (!qualify_domain_sender)
3546 qualify_domain_sender = primary_hostname;
3547 if (!qualify_domain_recipient)
3548 qualify_domain_recipient = qualify_domain_sender;
3550 /* Setting system_filter_user in the configuration sets the gid as well if a
3551 name is given, but a numerical value does not. */
3553 if (system_filter_uid_set && !system_filter_gid_set)
3555 struct passwd *pw = getpwuid(system_filter_uid);
3557 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3558 (long int)system_filter_uid);
3559 system_filter_gid = pw->pw_gid;
3560 system_filter_gid_set = TRUE;
3563 /* If the errors_reply_to field is set, check that it is syntactically valid
3564 and ensure it contains a domain. */
3566 if (errors_reply_to)
3569 int start, end, domain;
3570 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3571 &start, &end, &domain, FALSE);
3574 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3575 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3578 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3579 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3582 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3583 smtp_accept_max must also be set. */
3585 if (smtp_accept_max == 0 &&
3586 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3587 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3588 "smtp_accept_max must be set if smtp_accept_queue or "
3589 "smtp_accept_max_per_host is set");
3591 /* Set up the host number if anything is specified. It is an expanded string
3592 so that it can be computed from the host name, for example. We do this last
3593 so as to ensure that everything else is set up before the expansion. */
3595 if (host_number_string)
3599 uschar *s = expand_string(host_number_string);
3602 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3603 "failed to expand localhost_number \"%s\": %s",
3604 host_number_string, expand_string_message);
3605 n = Ustrtol(s, &end, 0);
3606 while (isspace(*end)) end++;
3608 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3609 "localhost_number value is not a number: %s", s);
3610 if (n > LOCALHOST_MAX)
3611 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3612 "localhost_number is greater than the maximum allowed value (%d)",
3618 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3620 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3622 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3623 tls_verify_hosts ? "" : "try_");
3625 /* This also checks that the library linkage is working and we can call
3626 routines in it, so call even if tls_require_ciphers is unset */
3627 if (!tls_dropprivs_validate_require_cipher(nowarn))
3630 /* Magic number: at time of writing, 1024 has been the long-standing value
3631 used by so many clients, and what Exim used to use always, that it makes
3632 sense to just min-clamp this max-clamp at that. */
3633 if (tls_dh_max_bits < 1024)
3634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3635 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3637 /* If openssl_options is set, validate it */
3638 if (openssl_options)
3641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3642 "openssl_options is set but we're using GnuTLS");
3645 if (!tls_openssl_options_parse(openssl_options, &dummy))
3646 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3647 "openssl_options parse error: %s", openssl_options);
3650 #endif /*SUPPORT_TLS*/
3652 if (!nowarn && !keep_environment && environ && *environ)
3653 log_write(0, LOG_MAIN,
3654 "Warning: purging the environment.\n"
3655 " Suggested action: use keep_environment.");
3660 /*************************************************
3661 * Initialize one driver *
3662 *************************************************/
3664 /* This is called once the driver's generic options, if any, have been read.
3665 We can now find the driver, set up defaults for the private options, and
3666 unset any "set" bits in the private options table (which might have been
3667 set by another incarnation of the same driver).
3670 d pointer to driver instance block, with generic
3672 drivers_available vector of available drivers
3673 size_of_info size of each block in drivers_available
3674 class class of driver, for error message
3676 Returns: pointer to the driver info block
3679 static driver_info *
3680 init_driver(driver_instance *d, driver_info *drivers_available,
3681 int size_of_info, uschar *class)
3685 for (dd = drivers_available; dd->driver_name[0] != 0;
3686 dd = (driver_info *)((US dd) + size_of_info))
3688 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3691 int len = dd->options_len;
3693 d->options_block = store_get(len);
3694 memcpy(d->options_block, dd->options_block, len);
3695 for (i = 0; i < *(dd->options_count); i++)
3696 dd->options[i].type &= ~opt_set;
3701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3702 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3704 return NULL; /* never obeyed */
3710 /*************************************************
3711 * Initialize driver list *
3712 *************************************************/
3714 /* This function is called for routers, transports, and authentication
3715 mechanisms. It reads the data from the current point in the configuration file
3716 up to the end of the section, and sets up a chain of instance blocks according
3717 to the file's contents. The file will already have been opened by a call to
3718 readconf_main, and must be left open for subsequent reading of further data.
3720 Any errors cause a panic crash. Note that the blocks with names driver_info and
3721 driver_instance must map the first portions of all the _info and _instance
3722 blocks for this shared code to work.
3725 class "router", "transport", or "authenticator"
3726 anchor &routers, &transports, &auths
3727 drivers_available available drivers
3728 size_of_info size of each info block
3729 instance_default points to default data for an instance
3730 instance_size size of instance block
3731 driver_optionlist generic option list
3732 driver_optionlist_count count of generic option list
3738 readconf_driver_init(
3740 driver_instance **anchor,
3741 driver_info *drivers_available,
3743 void *instance_default,
3745 optionlist *driver_optionlist,
3746 int driver_optionlist_count)
3748 driver_instance **p = anchor;
3749 driver_instance *d = NULL;
3752 while ((buffer = get_config_line()) != NULL)
3757 /* Read the first name on the line and test for the start of a new driver. A
3758 macro definition indicates the end of the previous driver. If this isn't the
3759 start of a new driver, the line will be re-read. */
3761 s = readconf_readname(name, sizeof(name), buffer);
3763 /* Handle macro definition, first finishing off the initialization of the
3764 previous driver, if any. */
3766 if (isupper(*name) && *s == '=')
3770 if (!d->driver_name)
3771 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3772 "no driver defined for %s \"%s\"", class, d->name);
3776 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3780 /* If the line starts with a name terminated by a colon, we are at the
3781 start of the definition of a new driver. The rest of the line must be
3788 /* Finish off initializing the previous driver. */
3792 if (!d->driver_name)
3793 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3794 "no driver defined for %s \"%s\"", class, d->name);
3798 /* Check that we haven't already got a driver of this name */
3800 for (d = *anchor; d; d = d->next)
3801 if (Ustrcmp(name, d->name) == 0)
3802 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3803 "there are two %ss called \"%s\"", class, name);
3805 /* Set up a new driver instance data block on the chain, with
3806 its default values installed. */
3808 d = store_get(instance_size);
3809 memcpy(d, instance_default, instance_size);
3812 d->name = string_copy(name);
3814 /* Clear out the "set" bits in the generic options */
3816 for (i = 0; i < driver_optionlist_count; i++)
3817 driver_optionlist[i].type &= ~opt_set;
3819 /* Check nothing more on this line, then do the next loop iteration. */
3821 while (isspace(*s)) s++;
3822 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3826 /* Not the start of a new driver. Give an error if we have not set up a
3827 current driver yet. */
3830 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3832 /* First look to see if this is a generic option; if it is "driver",
3833 initialize the driver. If is it not a generic option, we can look for a
3834 private option provided that the driver has been previously set up. */
3836 if (readconf_handle_option(buffer, driver_optionlist,
3837 driver_optionlist_count, d, NULL))
3839 if (!d->info && d->driver_name)
3840 init_driver(d, drivers_available, size_of_info, class);
3843 /* Handle private options - pass the generic block because some may
3844 live therein. A flag with each option indicates if it is in the public
3848 readconf_handle_option(buffer, d->info->options,
3849 *(d->info->options_count), d, US"option \"%s\" unknown");
3851 /* The option is not generic and the driver name has not yet been given. */
3853 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3854 "(\"driver\" must be specified before any private options)", name);
3857 /* Run the initialization function for the final driver. */
3861 if (!d->driver_name)
3862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3863 "no driver defined for %s \"%s\"", class, d->name);
3870 /*************************************************
3871 * Check driver dependency *
3872 *************************************************/
3874 /* This function is passed a driver instance and a string. It checks whether
3875 any of the string options for the driver contains the given string as an
3879 d points to a driver instance block
3880 s the string to search for
3882 Returns: TRUE if a dependency is found
3886 readconf_depends(driver_instance *d, uschar *s)
3888 int count = *(d->info->options_count);
3892 for (ol = d->info->options; ol < d->info->options + count; ol++)
3894 void *options_block;
3896 int type = ol->type & opt_mask;
3897 if (type != opt_stringptr) continue;
3898 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3899 value = *(uschar **)(US options_block + (long int)(ol->value));
3900 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3902 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3903 isalnum(ss[Ustrlen(s)])) continue;
3904 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3905 d->name, ol->name, s);
3910 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3917 /*************************************************
3918 * Decode an error type for retries *
3919 *************************************************/
3921 /* This function is global because it is also called from the main
3922 program when testing retry information. It decodes strings such as "quota_7d"
3923 into numerical error codes.
3926 pp points to start of text
3927 p points past end of text
3928 basic_errno points to an int to receive the main error number
3929 more_errno points to an int to receive the secondary error data
3931 Returns: NULL if decoded correctly; else points to error text
3935 readconf_retry_error(const uschar *pp, const uschar *p,
3936 int *basic_errno, int *more_errno)
3939 const uschar *q = pp;
3940 while (q < p && *q != '_') q++;
3943 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3945 *basic_errno = ERRNO_EXIMQUOTA;
3946 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3947 return US"bad time value";
3950 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3952 *basic_errno = ECONNREFUSED;
3955 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3956 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3957 else return US"A or MX expected after \"refused\"";
3961 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3963 *basic_errno = ETIMEDOUT;
3967 int xlen = p - q - 1;
3968 const uschar *x = q + 1;
3970 static uschar *extras[] =
3971 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3972 static int values[] =
3973 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3975 for (i = 0; i < nelem(extras); i++)
3976 if (strncmpic(x, extras[i], xlen) == 0)
3978 *more_errno = values[i];
3982 if (i >= nelem(extras))
3983 if (strncmpic(x, US"DNS", xlen) == 0)
3984 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3985 "available in retry rules (it has never worked) - treated as "
3988 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3992 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3993 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3994 strncmpic(pp, US"data_4", 6) == 0)
3997 int x = 255; /* means "any 4xx code" */
3998 if (p != pp + 8) bad = TRUE; else
4000 int a = pp[6], b = pp[7];
4004 if (isdigit(b)) x += b - '0';
4005 else if (b == 'x') x += 100;
4008 else if (a != 'x' || b != 'x') bad = TRUE;
4012 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4013 "x is literal and d is any digit", pp);
4015 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4016 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4017 *more_errno = x << 8;
4020 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4021 strncmpic(q+1, US"failed", p-q-1) == 0)
4022 *basic_errno = ERRNO_AUTHFAIL;
4024 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4025 *basic_errno = ERRNO_SMTPCLOSED;
4027 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4028 *basic_errno = ERRNO_TLSREQUIRED;
4030 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4031 *basic_errno = ERRNO_UNKNOWNHOST;
4033 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4034 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4042 /*************************************************
4043 * Read retry information *
4044 *************************************************/
4046 /* Each line of retry information contains:
4048 . A domain name pattern or an address pattern;
4050 . An error name, possibly with additional data, or *;
4052 . An optional sequence of retry items, each consisting of an identifying
4053 letter, a cutoff time, and optional parameters.
4055 All this is decoded and placed into a control block. */
4058 /* Subroutine to read an argument, preceded by a comma and terminated
4059 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4060 1 = fixed point number (returned *1000).
4063 paddr pointer to pointer to current character; updated
4064 type 0 => read a time; 1 => read a fixed point number
4066 Returns: time in seconds or fixed point number * 1000
4070 retry_arg(const uschar **paddr, int type)
4072 const uschar *p = *paddr;
4075 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4077 while (isspace(*p)) p++;
4079 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4081 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4082 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4087 case 0: return readconf_readtime(pp, *p, FALSE);
4088 case 1: return readconf_readfixed(pp, *p);
4090 return 0; /* Keep picky compilers happy */
4093 /* The function proper */
4096 readconf_retries(void)
4098 retry_config **chain = &retries;
4102 while ((p = get_config_line()))
4104 retry_rule **rchain;
4108 next = store_get(sizeof(retry_config));
4111 chain = &(next->next);
4112 next->basic_errno = next->more_errno = 0;
4113 next->senders = NULL;
4115 rchain = &(next->rules);
4117 next->pattern = string_dequote(&p);
4118 while (isspace(*p)) p++;
4120 while (mac_isgraph(*p)) p++;
4121 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4122 "missing error type in retry rule");
4124 /* Test error names for things we understand. */
4126 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4127 &next->more_errno)))
4128 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4130 /* There may be an optional address list of senders to be used as another
4131 constraint on the rule. This was added later, so the syntax is a bit of a
4132 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4135 while (isspace(*p)) p++;
4136 if (Ustrncmp(p, "senders", 7) == 0)
4139 while (isspace(*p)) p++;
4140 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4141 "\"=\" expected after \"senders\" in retry rule");
4142 while (isspace(*p)) p++;
4143 next->senders = string_dequote(&p);
4146 /* Now the retry rules. Keep the maximum timeout encountered. */
4148 while (isspace(*p)) p++;
4152 retry_rule *rule = store_get(sizeof(retry_rule));
4154 rchain = &(rule->next);
4156 rule->rule = toupper(*p++);
4157 rule->timeout = retry_arg(&p, 0);
4158 if (rule->timeout > retry_maximum_timeout)
4159 retry_maximum_timeout = rule->timeout;
4163 case 'F': /* Fixed interval */
4164 rule->p1 = retry_arg(&p, 0);
4167 case 'G': /* Geometrically increasing intervals */
4168 case 'H': /* Ditto, but with randomness */
4169 rule->p1 = retry_arg(&p, 0);
4170 rule->p2 = retry_arg(&p, 1);
4174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4178 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4179 (rule->rule != 'F' && rule->p2 < 1000))
4180 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4181 "bad parameters for retry rule");
4183 while (isspace(*p)) p++;
4187 while (isspace(*p)) p++;
4190 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4197 /*************************************************
4198 * Initialize authenticators *
4199 *************************************************/
4201 /* Read the authenticators section of the configuration file.
4210 auth_instance *au, *bu;
4212 readconf_driver_init(US"authenticator",
4213 (driver_instance **)(&auths), /* chain anchor */
4214 (driver_info *)auths_available, /* available drivers */
4215 sizeof(auth_info), /* size of info block */
4216 &auth_defaults, /* default values for generic options */
4217 sizeof(auth_instance), /* size of instance block */
4218 optionlist_auths, /* generic options */
4219 optionlist_auths_size);
4221 for (au = auths; au; au = au->next)
4223 if (!au->public_name)
4224 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4225 "the %s authenticator", au->name);
4227 for (bu = au->next; bu; bu = bu->next)
4228 if (strcmpic(au->public_name, bu->public_name) == 0)
4229 if ((au->client && bu->client) || (au->server && bu->server))
4230 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4231 "(%s and %s) have the same public name (%s)",
4232 au->client ? US"client" : US"server", au->name, bu->name,
4240 /*************************************************
4241 * Read ACL information *
4242 *************************************************/
4244 /* If this run of Exim is not doing something that involves receiving a
4245 message, we can just skip over the ACL information. No need to parse it.
4247 First, we have a function for acl_read() to call back to get the next line. We
4248 need to remember the line we passed, because at the end it will contain the
4249 name of the next ACL. */
4251 static uschar *acl_line;
4256 acl_line = get_config_line();
4261 /* Now the main function:
4272 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4275 acl_line = get_config_line();
4283 p = readconf_readname(name, sizeof(name), acl_line);
4284 if (isupper(*name) && *p == '=')
4286 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4287 acl_line = get_config_line();
4291 if (*p != ':' || name[0] == 0)
4292 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4294 node = store_get(sizeof(tree_node) + Ustrlen(name));
4295 Ustrcpy(node->name, name);
4296 if (!tree_insertnode(&acl_anchor, node))
4297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4298 "there are two ACLs called \"%s\"", name);
4300 node->data.ptr = acl_read(acl_callback, &error);
4302 if (node->data.ptr == NULL && error != NULL)
4303 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4309 /*************************************************
4310 * Read configuration for local_scan() *
4311 *************************************************/
4313 /* This function is called after "begin local_scan" is encountered in the
4314 configuration file. If the local_scan() function allows for configuration
4315 options, we can process them. Otherwise, we expire in a panic.
4322 local_scan_init(void)
4324 #ifndef LOCAL_SCAN_HAS_OPTIONS
4325 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4326 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4330 while ((p = get_config_line()))
4332 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4333 NULL, US"local_scan option \"%s\" unknown");
4340 /*************************************************
4341 * Read rest of configuration (after main) *
4342 *************************************************/
4344 /* This function reads the rest of the runtime configuration, after the main
4345 configuration. It is called only when actually needed. Each subsequent section
4346 of the configuration starts with a line of the form
4350 where the name is "routers", "transports", etc. A section is terminated by
4351 hitting the next "begin" line, and the next name is left in next_section.
4352 Because it may confuse people as to whether the names are singular or plural,
4353 we add "s" if it's missing. There is always enough room in next_section for
4354 this. This function is basically just a switch.
4360 static uschar *section_list[] = {
4374 while(next_section[0] != 0)
4378 int last = nelem(section_list);
4380 int n = Ustrlen(next_section);
4382 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4386 int c = strcmpic(next_section, section_list[mid]);
4388 if (c > 0) first = mid + 1; else last = mid;
4390 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4391 "\"%.*s\" is not a known configuration section name", n, next_section);
4392 mid = (last + first)/2;
4396 if (((had ^= bit) & bit) == 0)
4397 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4398 "\"%.*s\" section is repeated in the configuration file", n,
4403 case 0: readconf_acl(); break;
4404 case 1: auths_init(); break;
4405 case 2: local_scan_init(); break;
4406 case 3: readconf_retries(); break;
4407 case 4: readconf_rewrites(); break;
4408 case 5: route_init(); break;
4409 case 6: transport_init(); break;
4413 (void)fclose(config_file);
4416 /* Init the storage for the pre-parsed config lines */
4418 readconf_save_config(const uschar *s)
4420 save_config_line(string_sprintf("# Exim Configuration (%s)",
4421 f.running_in_test_harness ? US"X" : s));
4425 save_config_position(const uschar *file, int line)
4427 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4430 /* Append a pre-parsed logical line to the config lines store,
4431 this operates on a global (static) list that holds all the pre-parsed
4432 config lines, we do no further processing here, output formatting and
4433 honouring of <hide> or macros will be done during output */
4436 save_config_line(const uschar* line)
4438 static config_line_item *current;
4439 config_line_item *next;
4441 next = (config_line_item*) store_get(sizeof(config_line_item));
4442 next->line = string_copy(line);
4445 if (!config_lines) config_lines = next;
4446 else current->next = next;
4451 /* List the parsed config lines, care about nice formatting and
4452 hide the <hide> values unless we're the admin user */
4454 print_config(BOOL admin, BOOL terse)
4456 config_line_item *i;
4457 const int TS = terse ? 0 : 2;
4460 for (i = config_lines; i; i = i->next)
4465 /* skip over to the first non-space */
4466 for (current = i->line; *current && isspace(*current); ++current)
4469 if (*current == '\0')
4472 /* Collapse runs of spaces. We stop this if we encounter one of the
4473 * following characters: "'$, as this may indicate careful formatting */
4474 for (p = current; *p; ++p)
4477 if (!isspace(*p)) continue;
4478 if (*p != ' ') *p = ' ';
4480 for (next = p; isspace(*next); ++next)
4484 memmove(p+1, next, Ustrlen(next)+1);
4486 if (*next == '"' || *next == '\'' || *next == '$')
4491 if (current[0] == '#')
4494 /* begin lines are left aligned */
4495 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4497 if (!terse) puts("");
4502 /* router/acl/transport block names */
4503 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4505 if (!terse) puts("");
4506 printf("%*s%s\n", TS, "", current);
4510 /* hidden lines (all MACROS or lines prefixed with "hide") */
4512 && ( isupper(*current)
4513 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4517 if ((p = Ustrchr(current, '=')))
4520 printf("%*s%s= %s\n", indent, "", current, hidden);
4522 /* e.g.: hide split_spool_directory */
4524 printf("%*s\n", indent, hidden);
4528 /* rest is public */
4529 printf("%*s%s\n", indent, "", current);
4533 #endif /*!MACRO_PREDEF*/
4536 /* End of readconf.c */