1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar * syslog_facility_str;
22 static void fn_smtp_receive_timeout(const uschar *, const uschar *);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config[] = {
32 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
33 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
34 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
35 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
36 { "accept_8bitmime", opt_bool, &accept_8bitmime },
37 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
41 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
42 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
43 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
44 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
46 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
49 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
51 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
52 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
53 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
54 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
55 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
59 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
60 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
61 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
62 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
64 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
66 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
67 { "add_environment", opt_stringptr, &add_environment },
68 { "admin_groups", opt_gidlist, &admin_groups },
69 { "allow_domain_literals", opt_bool, &allow_domain_literals },
70 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
71 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
72 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
73 { "auto_thaw", opt_time, &auto_thaw },
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr, &av_scanner },
77 { "bi_command", opt_stringptr, &bi_command },
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr, &bmi_config_file },
81 { "bounce_message_file", opt_stringptr, &bounce_message_file },
82 { "bounce_message_text", opt_stringptr, &bounce_message_text },
83 { "bounce_return_body", opt_bool, &bounce_return_body },
84 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
85 { "bounce_return_message", opt_bool, &bounce_return_message },
86 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
87 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
88 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
89 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
90 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
91 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
92 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
93 { "check_log_inodes", opt_int, &check_log_inodes },
94 { "check_log_space", opt_Kint, &check_log_space },
95 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
96 { "check_spool_inodes", opt_int, &check_spool_inodes },
97 { "check_spool_space", opt_Kint, &check_spool_space },
98 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
99 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
100 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
101 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
102 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
103 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
106 { "dccifd_address", opt_stringptr, &dccifd_address },
107 { "dccifd_options", opt_stringptr, &dccifd_options },
109 { "debug_store", opt_bool, &debug_store },
110 { "delay_warning", opt_timelist, &delay_warning },
111 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
112 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
113 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
114 { "delivery_date_remove", opt_bool, &delivery_date_remove },
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool, &disable_fsync },
118 { "disable_ipv6", opt_bool, &disable_ipv6 },
120 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
122 #ifdef EXPERIMENTAL_DMARC
123 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
124 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
125 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
127 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
128 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
129 { "dns_cname_loops", opt_int, &dns_cname_loops },
130 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
131 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
132 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
133 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
134 { "dns_retrans", opt_time, &dns_retrans },
135 { "dns_retry", opt_int, &dns_retry },
136 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
137 { "dns_use_edns0", opt_int, &dns_use_edns0 },
138 /* This option is now a no-op, retained for compatibility */
139 { "drop_cr", opt_bool, &drop_cr },
140 /*********************************************************/
141 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
142 { "dsn_from", opt_stringptr, &dsn_from },
143 { "envelope_to_remove", opt_bool, &envelope_to_remove },
144 { "errors_copy", opt_stringptr, &errors_copy },
145 { "errors_reply_to", opt_stringptr, &errors_reply_to },
146 #ifndef DISABLE_EVENT
147 { "event_action", opt_stringptr, &event_action },
149 { "exim_group", opt_gid, &exim_gid },
150 { "exim_path", opt_stringptr, &exim_path },
151 { "exim_user", opt_uid, &exim_uid },
152 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
153 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
154 { "finduser_retries", opt_int, &finduser_retries },
155 { "freeze_tell", opt_stringptr, &freeze_tell },
156 { "gecos_name", opt_stringptr, &gecos_name },
157 { "gecos_pattern", opt_stringptr, &gecos_pattern },
159 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
160 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
162 { "header_line_maxsize", opt_int, &header_line_maxsize },
163 { "header_maxsize", opt_int, &header_maxsize },
164 { "headers_charset", opt_stringptr, &headers_charset },
165 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
166 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
167 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
168 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
169 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
170 { "hold_domains", opt_stringptr, &hold_domains },
171 { "host_lookup", opt_stringptr, &host_lookup },
172 { "host_lookup_order", opt_stringptr, &host_lookup_order },
173 { "host_reject_connection", opt_stringptr, &host_reject_connection },
174 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
176 { "hosts_proxy", opt_stringptr, &hosts_proxy },
178 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
180 { "ibase_servers", opt_stringptr, &ibase_servers },
182 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
183 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
184 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
185 { "keep_environment", opt_stringptr, &keep_environment },
186 { "keep_malformed", opt_time, &keep_malformed },
188 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
189 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
190 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
191 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
192 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
193 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
194 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
195 { "ldap_start_tls", opt_bool, &eldap_start_tls },
196 { "ldap_version", opt_int, &eldap_version },
198 { "local_from_check", opt_bool, &local_from_check },
199 { "local_from_prefix", opt_stringptr, &local_from_prefix },
200 { "local_from_suffix", opt_stringptr, &local_from_suffix },
201 { "local_interfaces", opt_stringptr, &local_interfaces },
202 #ifdef HAVE_LOCAL_SCAN
203 { "local_scan_timeout", opt_time, &local_scan_timeout },
205 { "local_sender_retain", opt_bool, &local_sender_retain },
206 { "localhost_number", opt_stringptr, &host_number_string },
207 { "log_file_path", opt_stringptr, &log_file_path },
208 { "log_selector", opt_stringptr, &log_selector_string },
209 { "log_timezone", opt_bool, &log_timezone },
210 { "lookup_open_max", opt_int, &lookup_open_max },
211 { "max_username_length", opt_int, &max_username_length },
212 { "message_body_newlines", opt_bool, &message_body_newlines },
213 { "message_body_visible", opt_mkint, &message_body_visible },
214 { "message_id_header_domain", opt_stringptr, &message_id_domain },
215 { "message_id_header_text", opt_stringptr, &message_id_text },
216 { "message_logs", opt_bool, &message_logs },
217 { "message_size_limit", opt_stringptr, &message_size_limit },
218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
219 { "move_frozen_messages", opt_bool, &move_frozen_messages },
221 { "mua_wrapper", opt_bool, &mua_wrapper },
223 { "mysql_servers", opt_stringptr, &mysql_servers },
225 { "never_users", opt_uidlist, &never_users },
227 { "openssl_options", opt_stringptr, &openssl_options },
230 { "oracle_servers", opt_stringptr, &oracle_servers },
232 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
234 { "perl_at_start", opt_bool, &opt_perl_at_start },
235 { "perl_startup", opt_stringptr, &opt_perl_startup },
236 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
239 { "pgsql_servers", opt_stringptr, &pgsql_servers },
241 { "pid_file_path", opt_stringptr, &pid_file_path },
242 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
243 #ifdef EXPERIMENTAL_PIPE_CONNECT
244 { "pipelining_connect_advertise_hosts", opt_stringptr,
245 &pipe_connect_advertise_hosts },
248 { "prdr_enable", opt_bool, &prdr_enable },
250 { "preserve_message_logs", opt_bool, &preserve_message_logs },
251 { "primary_hostname", opt_stringptr, &primary_hostname },
252 { "print_topbitchars", opt_bool, &print_topbitchars },
253 { "process_log_path", opt_stringptr, &process_log_path },
254 { "prod_requires_admin", opt_bool, &prod_requires_admin },
255 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
256 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
257 { "queue_domains", opt_stringptr, &queue_domains },
258 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
259 { "queue_only", opt_bool, &queue_only },
260 { "queue_only_file", opt_stringptr, &queue_only_file },
261 { "queue_only_load", opt_fixed, &queue_only_load },
262 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
263 { "queue_only_override", opt_bool, &queue_only_override },
264 { "queue_run_in_order", opt_bool, &queue_run_in_order },
265 { "queue_run_max", opt_stringptr, &queue_run_max },
266 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
267 { "receive_timeout", opt_time, &receive_timeout },
268 { "received_header_text", opt_stringptr, &received_header_text },
269 { "received_headers_max", opt_int, &received_headers_max },
270 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
271 { "recipients_max", opt_int, &recipients_max },
272 { "recipients_max_reject", opt_bool, &recipients_max_reject },
274 { "redis_servers", opt_stringptr, &redis_servers },
276 { "remote_max_parallel", opt_int, &remote_max_parallel },
277 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
278 { "retry_data_expire", opt_time, &retry_data_expire },
279 { "retry_interval_max", opt_time, &retry_interval_max },
280 { "return_path_remove", opt_bool, &return_path_remove },
281 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
282 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
283 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
284 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
285 { "slow_lookup_log", opt_int, &slow_lookup_log },
286 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
287 { "smtp_accept_max", opt_int, &smtp_accept_max },
288 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
289 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
290 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
291 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
292 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
293 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
294 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
295 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
296 { "smtp_banner", opt_stringptr, &smtp_banner },
297 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
298 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
299 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
300 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
301 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
302 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
303 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
304 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
305 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
306 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
307 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
308 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
309 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
310 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
312 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
314 #ifdef WITH_CONTENT_SCAN
315 { "spamd_address", opt_stringptr, &spamd_address },
318 { "spf_guess", opt_stringptr, &spf_guess },
320 { "split_spool_directory", opt_bool, &split_spool_directory },
321 { "spool_directory", opt_stringptr, &spool_directory },
322 { "spool_wireformat", opt_bool, &spool_wireformat },
324 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
326 #ifdef EXPERIMENTAL_SRS
327 { "srs_config", opt_stringptr, &srs_config },
328 { "srs_hashlength", opt_int, &srs_hashlength },
329 { "srs_hashmin", opt_int, &srs_hashmin },
330 { "srs_maxage", opt_int, &srs_maxage },
331 { "srs_secrets", opt_stringptr, &srs_secrets },
332 { "srs_usehash", opt_bool, &srs_usehash },
333 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
335 { "strict_acl_vars", opt_bool, &strict_acl_vars },
336 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
337 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
338 { "syslog_duplication", opt_bool, &syslog_duplication },
339 { "syslog_facility", opt_stringptr, &syslog_facility_str },
340 { "syslog_pid", opt_bool, &syslog_pid },
341 { "syslog_processname", opt_stringptr, &syslog_processname },
342 { "syslog_timestamp", opt_bool, &syslog_timestamp },
343 { "system_filter", opt_stringptr, &system_filter },
344 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
345 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
346 { "system_filter_group", opt_gid, &system_filter_gid },
347 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
348 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
349 { "system_filter_user", opt_uid, &system_filter_uid },
350 { "tcp_nodelay", opt_bool, &tcp_nodelay },
351 #ifdef USE_TCP_WRAPPERS
352 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
354 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
355 { "timezone", opt_stringptr, &timezone_string },
356 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
358 # ifdef EXPERIMENTAL_REQUIRETLS
359 { "tls_advertise_requiretls", opt_stringptr, &tls_advertise_requiretls },
361 { "tls_certificate", opt_stringptr, &tls_certificate },
362 { "tls_crl", opt_stringptr, &tls_crl },
363 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
364 { "tls_dhparam", opt_stringptr, &tls_dhparam },
365 { "tls_eccurve", opt_stringptr, &tls_eccurve },
366 # ifndef DISABLE_OCSP
367 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
369 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
370 { "tls_privatekey", opt_stringptr, &tls_privatekey },
371 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
372 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
373 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
374 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
375 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
377 { "trusted_groups", opt_gidlist, &trusted_groups },
378 { "trusted_users", opt_uidlist, &trusted_users },
379 { "unknown_login", opt_stringptr, &unknown_login },
380 { "unknown_username", opt_stringptr, &unknown_username },
381 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
382 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
383 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
384 { "warn_message_file", opt_stringptr, &warn_message_file },
385 { "write_rejectlog", opt_bool, &write_rejectlog }
389 static int optionlist_config_size = nelem(optionlist_config);
395 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
400 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
408 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
410 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
412 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
413 builtin_macro_create(buf);
414 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
419 options_logging(void)
423 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
425 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
426 builtin_macro_create(buf);
431 #else /*!MACRO_PREDEF*/
433 extern char **environ;
435 static void save_config_line(const uschar* line);
436 static void save_config_position(const uschar *file, int line);
437 static void print_config(BOOL admin, BOOL terse);
440 #define CSTATE_STACK_SIZE 10
442 const uschar *config_directory = NULL;
445 /* Structure for chain (stack) of .included files */
447 typedef struct config_file_item {
448 struct config_file_item *next;
449 const uschar *filename;
450 const uschar *directory;
455 /* Structure for chain of configuration lines (-bP config) */
457 typedef struct config_line_item {
458 struct config_line_item *next;
462 static config_line_item* config_lines;
464 /* Structure of table of conditional words and their state transitions */
466 typedef struct cond_item {
474 /* Structure of table of syslog facility names and values */
476 typedef struct syslog_fac_item {
482 static const char * const hidden = "<value not displayable>";
484 /* Static variables */
486 static config_file_item *config_file_stack = NULL; /* For includes */
488 static uschar *syslog_facility_str = NULL;
489 static uschar next_section[24];
490 static uschar time_buffer[24];
492 /* State variables for conditional loading (.ifdef / .else / .endif) */
494 static int cstate = 0;
495 static int cstate_stack_ptr = -1;
496 static int cstate_stack[CSTATE_STACK_SIZE];
498 /* Table of state transitions for handling conditional inclusions. There are
499 four possible state transitions:
503 .elifdef true (or .else)
506 .endif just causes the previous cstate to be popped off the stack */
508 static int next_cstate[3][4] =
510 /* State 0: reading from file, or reading until next .else or .endif */
512 /* State 1: condition failed, skipping until next .else or .endif */
514 /* State 2: skipping until .endif */
518 /* Table of conditionals and the states to set. For each name, there are four
519 values: the length of the name (to save computing it each time), the state to
520 set if a macro was found in the line, the state to set if a macro was not found
521 in the line, and a stack manipulation setting which is:
523 -1 pull state value off the stack
524 0 don't alter the stack
525 +1 push value onto stack, before setting new state
528 static cond_item cond_list[] = {
529 { US"ifdef", 5, 0, 1, 1 },
530 { US"ifndef", 6, 1, 0, 1 },
531 { US"elifdef", 7, 2, 3, 0 },
532 { US"elifndef", 8, 3, 2, 0 },
533 { US"else", 4, 2, 2, 0 },
534 { US"endif", 5, 0, 0, -1 }
537 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
539 /* Table of syslog facility names and their values */
541 static syslog_fac_item syslog_list[] = {
542 { US"mail", LOG_MAIL },
543 { US"user", LOG_USER },
544 { US"news", LOG_NEWS },
545 { US"uucp", LOG_UUCP },
546 { US"local0", LOG_LOCAL0 },
547 { US"local1", LOG_LOCAL1 },
548 { US"local2", LOG_LOCAL2 },
549 { US"local3", LOG_LOCAL3 },
550 { US"local4", LOG_LOCAL4 },
551 { US"local5", LOG_LOCAL5 },
552 { US"local6", LOG_LOCAL6 },
553 { US"local7", LOG_LOCAL7 },
554 { US"daemon", LOG_DAEMON }
557 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
562 /*************************************************
563 * Find the name of an option *
564 *************************************************/
566 /* This function is to aid debugging. Various functions take arguments that are
567 pointer variables in the options table or in option tables for various drivers.
568 For debugging output, it is useful to be able to find the name of the option
569 which is currently being processed. This function finds it, if it exists, by
570 searching the table(s).
572 Arguments: a value that is presumed to be in the table above
573 Returns: the option name, or an empty string
577 readconf_find_option(void *p)
579 for (int i = 0; i < nelem(optionlist_config); i++)
580 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
582 for (router_instance * r = routers; r; r = r->next)
584 router_info *ri = r->info;
585 for (int i = 0; i < *ri->options_count; i++)
587 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
588 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
589 return US ri->options[i].name;
593 for (transport_instance * t = transports; t; t = t->next)
595 transport_info *ti = t->info;
596 for (int i = 0; i < *ti->options_count; i++)
598 optionlist * op = &ti->options[i];
599 if ((op->type & opt_mask) != opt_stringptr) continue;
600 if (p == ( op->type & opt_public
602 : CS t->options_block
604 + (long int)op->value)
615 /*************************************************
616 * Deal with an assignment to a macro *
617 *************************************************/
619 /* We have a new definition; append to the list.
622 name Name of the macro; will be copied
623 val Expansion result for the macro; will be copied
627 macro_create(const uschar * name, const uschar * val, BOOL command_line)
629 macro_item * m = store_get(sizeof(macro_item));
631 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
633 m->command_line = command_line;
634 m->namelen = Ustrlen(name);
635 m->replen = Ustrlen(val);
636 m->name = string_copy(name);
637 m->replacement = string_copy(val);
649 /* This function is called when a line that starts with an upper case letter is
650 encountered. The argument "line" should contain a complete logical line, and
651 start with the first letter of the macro name. The macro name and the
652 replacement text are extracted and stored. Redefinition of existing,
653 non-command line, macros is permitted using '==' instead of '='.
656 s points to the start of the logical line
658 Returns: FALSE iff fatal error
662 macro_read_assignment(uschar *s)
669 while (isalnum(*s) || *s == '_')
671 if (namelen >= sizeof(name) - 1)
673 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
674 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
677 name[namelen++] = *s++;
681 while (isspace(*s)) s++;
684 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
693 while (isspace(*s)) s++;
695 /* If an existing macro of the same name was defined on the command line, we
696 just skip this definition. It's an error to attempt to redefine a macro without
697 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
698 It is also an error to define a macro whose name begins with the name of a
699 previously defined macro. This is the requirement that make using a tree
700 for macros hard; we must check all macros for the substring. Perhaps a
701 sorted list, and a bsearch, would work?
702 Note: it is documented that the other way round works. */
704 for (m = macros; m; m = m->next)
706 if (Ustrcmp(m->name, name) == 0)
708 if (!m->command_line && !redef)
710 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
711 "defined (use \"==\" if you want to redefine it)", name);
717 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
719 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
720 "a macro because previously defined macro \"%s\" is a substring",
725 /* We cannot have this test, because it is documented that a substring
726 macro is permitted (there is even an example).
728 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
729 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
730 * "a macro because it is a substring of previously defined macro \"%s\"",
735 /* Check for an overriding command-line definition. */
737 if (m && m->command_line) return TRUE;
739 /* Redefinition must refer to an existing macro. */
744 m->replen = Ustrlen(s);
745 m->replacement = string_copy(s);
749 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
754 /* We have a new definition. */
756 (void) macro_create(name, s, FALSE);
764 /* Process line for macros. The line is in big_buffer starting at offset len.
765 Expand big_buffer if needed. Handle definitions of new macros, and
766 macro expansions, rewriting the line in the buffer.
769 len Offset in buffer of start of line
770 newlen Pointer to offset of end of line, updated on return
771 macro_found Pointer to return that a macro was expanded
773 Return: pointer to first nonblank char in line
777 macros_expand(int len, int * newlen, BOOL * macro_found)
779 uschar * ss = big_buffer + len;
782 /* Find the true start of the physical line - leading spaces are always
785 while (isspace(*ss)) ss++;
787 /* Process the physical line for macros. If this is the start of the logical
788 line, skip over initial text at the start of the line if it starts with an
789 upper case character followed by a sequence of name characters and an equals
790 sign, because that is the definition of a new macro, and we don't do
791 replacement therein. */
794 if (len == 0 && isupper(*s))
796 while (isalnum(*s) || *s == '_') s++;
797 while (isspace(*s)) s++;
798 if (*s != '=') s = ss; /* Not a macro definition */
801 /* Skip leading chars which cannot start a macro name, to avoid multiple
802 pointless rescans in Ustrstr calls. */
804 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
806 /* For each defined macro, scan the line (from after XXX= if present),
807 replacing all occurrences of the macro. */
809 *macro_found = FALSE;
810 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
815 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
819 while ((p = Ustrstr(t, m->name)) != NULL)
823 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
824 m->name, (int) Ustrlen(ss)-1, ss);
825 /* Expand the buffer if necessary */
827 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
829 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
830 uschar *newbuffer = store_malloc(newsize);
831 memcpy(newbuffer, big_buffer, *newlen + 1);
832 p = newbuffer + (p - big_buffer);
833 s = newbuffer + (s - big_buffer);
834 ss = newbuffer + (ss - big_buffer);
835 t = newbuffer + (t - big_buffer);
836 big_buffer_size = newsize;
837 store_free(big_buffer);
838 big_buffer = newbuffer;
841 /* Shuffle the remaining characters up or down in the buffer before
842 copying in the replacement text. Don't rescan the replacement for this
846 if ((moveby = m->replen - m->namelen) != 0)
848 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
851 Ustrncpy(p, m->replacement, m->replen);
853 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
858 /* An empty macro replacement at the start of a line could mean that ss no
859 longer points to the first non-blank character. */
861 while (isspace(*ss)) ss++;
865 /*************************************************
866 * Read configuration line *
867 *************************************************/
869 /* A logical line of text is read from the configuration file into the big
870 buffer, taking account of macros, .includes, and continuations. The size of
871 big_buffer is increased if necessary. The count of configuration lines is
872 maintained. Physical input lines starting with # (ignoring leading white space,
873 and after macro replacement) and empty logical lines are always ignored.
874 Leading and trailing spaces are removed.
876 If we hit a line of the form "begin xxxx", the xxxx is placed in the
877 next_section vector, and the function returns NULL, indicating the end of a
878 configuration section. On end-of-file, NULL is returned with next_section
883 Returns: a pointer to the first non-blank in the line,
884 or NULL if eof or end of section is reached
888 get_config_line(void)
890 int startoffset = 0; /* To first non-blank char in logical line */
891 int len = 0; /* Of logical line so far */
896 /* Loop for handling continuation lines, skipping comments, and dealing with
901 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
903 if (config_file_stack != NULL) /* EOF inside .include */
905 (void)fclose(config_file);
906 config_file = config_file_stack->file;
907 config_filename = config_file_stack->filename;
908 config_directory = config_file_stack->directory;
909 config_lineno = config_file_stack->lineno;
910 config_file_stack = config_file_stack->next;
912 save_config_position(config_filename, config_lineno);
916 /* EOF at top level */
918 if (cstate_stack_ptr >= 0)
919 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
920 "Unexpected end of configuration file: .endif missing");
922 if (len != 0) break; /* EOF after continuation */
923 next_section[0] = 0; /* EOF at start of logical line */
928 newlen = len + Ustrlen(big_buffer + len);
930 if (config_lines && config_lineno == 1)
931 save_config_position(config_filename, config_lineno);
933 /* Handle pathologically long physical lines - yes, it did happen - by
934 extending big_buffer at this point. The code also copes with very long
937 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
940 big_buffer_size += BIG_BUFFER_SIZE;
941 newbuffer = store_malloc(big_buffer_size);
943 /* This use of strcpy is OK because we know that the string in the old
944 buffer is shorter than the new buffer. */
946 Ustrcpy(newbuffer, big_buffer);
947 store_free(big_buffer);
948 big_buffer = newbuffer;
949 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
951 newlen += Ustrlen(big_buffer + newlen);
954 ss = macros_expand(len, &newlen, ¯o_found);
956 /* Check for comment lines - these are physical lines. */
958 if (*ss == '#') continue;
960 /* Handle conditionals, which are also applied to physical lines. Conditions
961 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
962 expansion occured on the rest of the line. A preliminary test for the leading
963 '.' saves effort on most lines. */
969 /* Search the list of conditional directives */
971 for (i = 0; i < cond_list_size; i++)
974 cond_item *c = cond_list+i;
975 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
977 /* The following character must be white space or end of string */
979 n = ss[1 + c->namelen];
980 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
982 /* .ifdef and .ifndef push the current state onto the stack, then set
983 a new one from the table. Stack overflow is an error */
987 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
989 ".%s nested too deeply", c->name);
990 cstate_stack[++cstate_stack_ptr] = cstate;
991 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
994 /* For any of the others, stack underflow is an error. The next state
995 comes either from the stack (.endif) or from the table. */
999 if (cstate_stack_ptr < 0)
1000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1001 ".%s without matching .ifdef", c->name);
1002 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1003 next_cstate[cstate][macro_found? c->action1 : c->action2];
1006 /* Having dealt with a directive, break the loop */
1011 /* If we have handled a conditional directive, continue with the next
1012 physical line. Otherwise, fall through. */
1014 if (i < cond_list_size) continue;
1017 /* If the conditional state is not 0 (actively using these lines), ignore
1020 if (cstate != 0) continue; /* Conditional skip */
1022 /* Handle .include lines - these are also physical lines. */
1024 if (Ustrncmp(ss, ".include", 8) == 0 &&
1026 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1029 int include_if_exists = isspace(ss[8])? 0 : 10;
1030 config_file_item *save;
1031 struct stat statbuf;
1033 ss += 9 + include_if_exists;
1034 while (isspace(*ss)) ss++;
1035 t = ss + Ustrlen(ss);
1036 while (t > ss && isspace(t[-1])) t--;
1037 if (*ss == '\"' && t[-1] == '\"')
1044 /* We allow relative file names. For security reasons currently
1045 relative names not allowed with .include_if_exists. For .include_if_exists
1046 we need to check the permissions/ownership of the containing folder */
1048 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1049 "absolute path \"%s\"", ss);
1052 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1053 ss = string_from_gstring(g);
1056 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1059 save_config_position(config_filename, config_lineno);
1060 save = store_get(sizeof(config_file_item));
1061 save->next = config_file_stack;
1062 config_file_stack = save;
1063 save->file = config_file;
1064 save->filename = config_filename;
1065 save->directory = config_directory;
1066 save->lineno = config_lineno;
1068 if (!(config_file = Ufopen(ss, "rb")))
1069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1070 "configuration file %s", ss);
1072 config_filename = string_copy(ss);
1073 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1078 /* If this is the start of the logical line, remember where the non-blank
1079 data starts. Otherwise shuffle down continuation lines to remove leading
1083 startoffset = ss - big_buffer;
1086 s = big_buffer + len;
1089 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1094 /* Accept the new addition to the line. Remove trailing white space. */
1097 while (len > 0 && isspace(big_buffer[len-1])) len--;
1098 big_buffer[len] = 0;
1100 /* We are done if the line does not end in backslash and contains some data.
1101 Empty logical lines are ignored. For continuations, remove the backslash and
1102 go round the loop to read the continuation line. */
1106 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1107 big_buffer[--len] = 0; /* Remove backslash */
1109 } /* Loop for reading multiple physical lines */
1111 /* We now have a logical line. Test for the end of a configuration section (or,
1112 more accurately, for the start of the next section). Place the name of the next
1113 section in next_section, and return NULL. If the name given is longer than
1114 next_section, truncate it. It will be unrecognized later, because all the known
1115 section names do fit. Leave space for pluralizing. */
1117 s = big_buffer + startoffset; /* First non-space character */
1120 save_config_line(s);
1122 if (strncmpic(s, US"begin ", 6) == 0)
1125 while (isspace(*s)) s++;
1126 if (big_buffer + len - s > sizeof(next_section) - 2)
1127 s[sizeof(next_section) - 2] = 0;
1128 Ustrcpy(next_section, s);
1132 /* Return the first non-blank character. */
1139 /*************************************************
1141 *************************************************/
1143 /* The yield is the pointer to the next uschar. Names longer than the
1144 output space are silently truncated. This function is also used from acl.c when
1148 name where to put the name
1152 Returns: new input pointer
1156 readconf_readname(uschar *name, int len, uschar *s)
1159 while (isspace(*s)) s++;
1162 while (isalnum(*s) || *s == '_')
1164 if (p < len-1) name[p++] = *s;
1169 while (isspace(*s)) s++;
1176 /*************************************************
1177 * Read a time value *
1178 *************************************************/
1180 /* This function is also called from outside, to read argument
1181 time values. The format of a time value is:
1183 [<n>w][<n>d][<n>h][<n>m][<n>s]
1185 as long as at least one is present. If a format error is encountered,
1186 return a negative value. The value must be terminated by the given
1191 terminator required terminating character
1192 return_msec if TRUE, allow fractional seconds and return milliseconds
1194 Returns: the time value, or -1 on syntax error
1195 value is seconds if return_msec is FALSE
1196 value is milliseconds if return_msec is TRUE
1200 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1208 if (!isdigit(*s)) return -1;
1209 (void)sscanf(CCS s, "%d%n", &value, &count);
1214 case 'w': value *= 7;
1215 case 'd': value *= 24;
1216 case 'h': value *= 60;
1217 case 'm': value *= 60;
1222 if (!return_msec) return -1;
1223 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1225 if (*s++ != 's') return -1;
1226 yield += (int)(fraction * 1000.0);
1232 if (return_msec) value *= 1000;
1234 if (*s == terminator) return yield;
1236 /* Control never reaches here. */
1241 /*************************************************
1242 * Read a fixed point value *
1243 *************************************************/
1245 /* The value is returned *1000
1249 terminator required terminator
1251 Returns: the value, or -1 on error
1255 readconf_readfixed(const uschar *s, int terminator)
1259 if (!isdigit(*s)) return -1;
1260 (void)sscanf(CS s, "%d%n", &value, &count);
1262 yield = value * 1000;
1266 while (isdigit((*(++s))))
1268 yield += (*s - '0') * m;
1273 return (*s == terminator)? yield : (-1);
1278 /*************************************************
1279 * Find option in list *
1280 *************************************************/
1282 /* The lists are always in order, so binary chop can be used.
1285 name the option name to search for
1286 ol the first entry in the option list
1287 last one more than the offset of the last entry in the option list
1289 Returns: pointer to an option entry, or NULL if not found
1293 find_option(uschar *name, optionlist *ol, int last)
1296 while (last > first)
1298 int middle = (first + last)/2;
1299 int c = Ustrcmp(name, ol[middle].name);
1301 if (c == 0) return ol + middle;
1302 else if (c > 0) first = middle + 1;
1310 /*************************************************
1311 * Find a set flag in option list *
1312 *************************************************/
1314 /* Because some versions of Unix make no restrictions on the values of uids and
1315 gids (even negative ones), we cannot represent "unset" by a special value.
1316 There is therefore a separate boolean variable for each one indicating whether
1317 a value is set or not. This function returns a pointer to the boolean, given
1318 the original option name. It is a major disaster if the flag cannot be found.
1321 name the name of the uid or gid option
1322 oltop points to the start of the relevant option list
1323 last one more than the offset of the last item in the option list
1324 data_block NULL when reading main options => data values in the option
1325 list are absolute addresses; otherwise they are byte offsets
1326 in data_block (used for driver options)
1328 Returns: a pointer to the boolean flag.
1332 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1336 sprintf(CS name2, "*set_%.50s", name);
1337 ol = find_option(name2, oltop, last);
1338 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1339 "Exim internal error: missing set flag for %s", name);
1340 return (data_block == NULL)? (BOOL *)(ol->value) :
1341 (BOOL *)(US data_block + (long int)(ol->value));
1347 /*************************************************
1348 * Output extra characters message and die *
1349 *************************************************/
1351 /* Called when an option line has junk on the end. Sometimes this is because
1352 the sysadmin thinks comments are permitted.
1355 s points to the extra characters
1356 t1..t3 strings to insert in the log message
1358 Returns: doesn't return; dies
1362 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1364 uschar *comment = US"";
1365 if (*s == '#') comment = US" (# is comment only at line start)";
1366 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1367 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1372 /*************************************************
1373 * Read rewrite information *
1374 *************************************************/
1376 /* Each line of rewrite information contains:
1378 . A complete address in the form user@domain, possibly with
1379 leading * for each part; or alternatively, a regex.
1381 . A replacement string (which will be expanded).
1383 . An optional sequence of one-letter flags, indicating which
1384 headers etc. to apply this rule to.
1386 All this is decoded and placed into a control block. The OR of the flags is
1387 maintained in a common word.
1390 p points to the string that makes up the rule
1391 existflags points to the overall flag word
1392 isglobal TRUE if reading global rewrite rules
1394 Returns: the control block for the parsed rule.
1397 static rewrite_rule *
1398 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1400 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1403 next->key = string_dequote(&p);
1405 while (isspace(*p)) p++;
1407 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1408 "missing rewrite replacement string");
1411 next->replacement = string_dequote(&p);
1413 while (*p != 0) switch (*p++)
1415 case ' ': case '\t': break;
1417 case 'q': next->flags |= rewrite_quit; break;
1418 case 'w': next->flags |= rewrite_whole; break;
1420 case 'h': next->flags |= rewrite_all_headers; break;
1421 case 's': next->flags |= rewrite_sender; break;
1422 case 'f': next->flags |= rewrite_from; break;
1423 case 't': next->flags |= rewrite_to; break;
1424 case 'c': next->flags |= rewrite_cc; break;
1425 case 'b': next->flags |= rewrite_bcc; break;
1426 case 'r': next->flags |= rewrite_replyto; break;
1428 case 'E': next->flags |= rewrite_all_envelope; break;
1429 case 'F': next->flags |= rewrite_envfrom; break;
1430 case 'T': next->flags |= rewrite_envto; break;
1432 case 'Q': next->flags |= rewrite_qualify; break;
1433 case 'R': next->flags |= rewrite_repeat; break;
1436 next->flags |= rewrite_smtp;
1437 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1438 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1439 "rewrite rule has the S flag but is not a regular expression");
1443 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1444 "unknown rewrite flag character '%c' "
1445 "(could be missing quotes round replacement item)", p[-1]);
1449 /* If no action flags are set, set all the "normal" rewrites. */
1451 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1452 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1454 /* Remember which exist, for optimization, and return the rule */
1456 *existflags |= next->flags;
1463 /*************************************************
1464 * Read global rewrite information *
1465 *************************************************/
1467 /* Each line is a single rewrite rule; it is parsed into a control block
1468 by readconf_one_rewrite(), and its flags are ORed into the global flag
1469 word rewrite_existflags. */
1472 readconf_rewrites(void)
1474 rewrite_rule **chain = &global_rewrite_rules;
1477 while ((p = get_config_line()) != NULL)
1479 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1481 chain = &(next->next);
1487 /*************************************************
1489 *************************************************/
1491 /* Strings are read into the normal store pool. As long we aren't too
1492 near the end of the current block, the string will just use what is necessary
1493 on the top of the stacking pool, because string_cat() uses the extension
1497 s the rest of the input line
1498 name the option name (for errors)
1500 Returns: pointer to the string
1504 read_string(const uschar *s, const uschar *name)
1509 if (*s != '\"') return string_copy(s);
1512 yield = string_dequote(&s);
1514 if (s == ss+1 || s[-1] != '\"')
1515 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1516 "missing quote at end of string value for %s", name);
1518 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1524 /*************************************************
1525 * Custom-handler options *
1526 *************************************************/
1528 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1531 smtp_receive_timeout_s = string_copy(str);
1534 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1535 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1536 if (smtp_receive_timeout < 0)
1537 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1542 /*************************************************
1543 * Handle option line *
1544 *************************************************/
1546 /* This function is called from several places to process a line containing the
1547 setting of an option. The first argument is the line to be decoded; it has been
1548 checked not to be empty and not to start with '#'. Trailing newlines and white
1549 space have been removed. The second argument is a pointer to the list of
1550 variable names that are to be recognized, together with their types and
1551 locations, and the third argument gives the number of entries in the list.
1553 The fourth argument is a pointer to a data block. If it is NULL, then the data
1554 values in the options list are absolute addresses. Otherwise, they are byte
1555 offsets in the data block.
1557 String option data may continue onto several lines; this function reads further
1558 data from config_file if necessary.
1560 The yield of this function is normally zero. If a string continues onto
1561 multiple lines, then the data value is permitted to be followed by a comma
1562 or a semicolon (for use in drivers) and the yield is that character.
1565 buffer contains the configuration line to be handled
1566 oltop points to the start of the relevant option list
1567 last one more than the offset of the last item in the option list
1568 data_block NULL when reading main options => data values in the option
1569 list are absolute addresses; otherwise they are byte offsets
1570 in data_block when they have opt_public set; otherwise
1571 they are byte offsets in data_block->options_block.
1572 unknown_txt format string to use in panic message for unknown option;
1573 must contain %s for option name
1574 if given as NULL, don't panic on unknown option
1576 Returns: TRUE if an option was read successfully,
1577 FALSE false for an unknown option if unknown_txt == NULL,
1578 otherwise panic and die on an unknown option
1582 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1583 void *data_block, uschar *unknown_txt)
1587 int count, type, value;
1591 BOOL boolvalue = TRUE;
1592 BOOL freesptr = TRUE;
1593 optionlist *ol, *ol2;
1597 uschar *inttype = US"";
1600 uschar **str_target;
1604 /* There may be leading spaces; thereafter, we expect an option name starting
1607 while (isspace(*s)) s++;
1609 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1611 /* Read the name of the option, and skip any subsequent white space. If
1612 it turns out that what we read was "hide", set the flag indicating that
1613 this is a secure option, and loop to read the next word. */
1615 for (int n = 0; n < 2; n++)
1617 while (isalnum(*s) || *s == '_')
1619 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1623 while (isspace(*s)) s++;
1624 if (Ustrcmp(name, "hide") != 0) break;
1625 issecure = opt_secure;
1629 /* Deal with "no_" or "not_" here for booleans */
1631 if (Ustrncmp(name, "no_", 3) == 0)
1637 if (Ustrncmp(name, "not_", 4) == 0)
1643 /* Search the list for the given name. A non-existent name, or an option that
1644 is set twice, is a disaster. */
1646 if (!(ol = find_option(name + offset, oltop, last)))
1648 if (unknown_txt == NULL) return FALSE;
1649 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1652 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1653 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1654 "\"%s\" option set for the second time", name);
1656 ol->type |= opt_set | issecure;
1657 type = ol->type & opt_mask;
1659 /* Types with data values must be followed by '='; the "no[t]_" prefix
1660 applies only to boolean values. */
1662 if (type < opt_bool || type > opt_bool_last)
1665 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1666 "negation prefix applied to a non-boolean option");
1668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1669 "unexpected end of line (data missing) after %s", name);
1671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1674 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1675 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1676 ultimately expands to one of those values. */
1678 else if (*s != 0 && (offset != 0 || *s != '='))
1679 extra_chars_error(s, US"boolean option ", name, US"");
1681 /* Skip white space after = */
1683 if (*s == '=') while (isspace((*(++s))));
1685 /* If there is a data block and the opt_public flag is not set, change
1686 the data block pointer to the private options block. */
1688 if (data_block != NULL && (ol->type & opt_public) == 0)
1689 data_block = (void *)(((driver_instance *)data_block)->options_block);
1691 /* Now get the data according to the type. */
1695 /* If a string value is not enclosed in quotes, it consists of
1696 the rest of the current line, verbatim. Otherwise, string escapes
1699 A transport is specified as a string, which is then looked up in the
1700 list of transports. A search type is specified as one of a number of
1703 A set or rewrite rules for a driver is specified as a string, which is
1704 then parsed into a suitable chain of control blocks.
1706 Uids and gids are specified as strings which are then looked up in the
1707 passwd file. Lists of uids and gids are similarly specified as colon-
1708 separated strings. */
1713 case opt_expand_uid:
1714 case opt_expand_gid:
1719 reset_point = sptr = read_string(s, name);
1721 /* Having read a string, we now have several different ways of using it,
1722 depending on the data type, so do another switch. If keeping the actual
1723 string is not required (because it is interpreted), freesptr is set TRUE,
1724 and at the end we reset the pool. */
1728 /* If this was a string, set the variable to point to the new string,
1729 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1730 rules, we still keep the string (for printing), and parse the rules into a
1731 control block and flags word. */
1734 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1736 if (ol->type & opt_rep_con)
1738 uschar * saved_condition;
1739 /* We already have a condition, we're conducting a crude hack to let
1740 multiple condition rules be chained together, despite storing them in
1742 *str_target = string_copy_malloc( (saved_condition = *str_target)
1743 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1744 saved_condition, sptr)
1746 /* TODO(pdp): there is a memory leak here and just below
1747 when we set 3 or more conditions; I still don't
1748 understand the store mechanism enough to know
1749 what's the safe way to free content from an earlier store.
1750 AFAICT, stores stack, so freeing an early stored item also stores
1751 all data alloc'd after it. If we knew conditions were adjacent,
1752 we could survive that, but we don't. So I *think* we need to take
1753 another bit from opt_type to indicate "malloced"; this seems like
1754 quite a hack, especially for this one case. It also means that
1755 we can't ever reclaim the store from the *first* condition.
1757 Because we only do this once, near process start-up, I'm prepared to
1758 let this slide for the time being, even though it rankles. */
1760 else if (ol->type & opt_rep_str)
1762 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1763 int sep_i = -(int)sep_o;
1764 const uschar * list = sptr;
1766 gstring * list_o = NULL;
1770 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1771 list_o = string_cat(list_o, *str_target);
1774 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1775 list_o = string_append_listele(list_o, sep_o, s);
1778 *str_target = string_copy_malloc(string_from_gstring(list_o));
1789 *USS (US data_block + (long int)(ol->value)) = sptr;
1791 *USS (ol->value) = sptr;
1793 if (type == opt_rewrite)
1798 rewrite_rule **chain;
1801 sprintf(CS name2, "*%.50s_rules", name);
1802 ol2 = find_option(name2, oltop, last);
1803 sprintf(CS name2, "*%.50s_flags", name);
1804 ol3 = find_option(name2, oltop, last);
1806 if (ol2 == NULL || ol3 == NULL)
1807 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1808 "rewrite rules not available for driver");
1810 if (data_block == NULL)
1812 chain = (rewrite_rule **)(ol2->value);
1813 flagptr = (int *)(ol3->value);
1817 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1818 flagptr = (int *)(US data_block + (long int)(ol3->value));
1821 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1823 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1825 chain = &(next->next);
1828 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1829 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1830 "non-header rewrite - not allowed at transport time -");
1834 /* If it was an expanded uid, see if there is any expansion to be
1835 done by checking for the presence of a $ character. If there is, save it
1836 in the corresponding *expand_user option field. Otherwise, fall through
1837 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1840 case opt_expand_uid:
1841 sprintf(CS name2, "*expand_%.50s", name);
1842 ol2 = find_option(name2, oltop, last);
1845 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1847 if (data_block == NULL)
1848 *((uschar **)(ol2->value)) = ss;
1850 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1854 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1860 /* Look up a fixed uid, and also make use of the corresponding gid
1861 if a passwd entry is returned and the gid has not been set. */
1864 if (!route_finduser(sptr, &pw, &uid))
1865 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1866 if (data_block == NULL)
1867 *((uid_t *)(ol->value)) = uid;
1869 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1871 /* Set the flag indicating a fixed value is set */
1873 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1875 /* Handle matching gid if we have a passwd entry: done by finding the
1876 same name with terminating "user" changed to "group"; if not found,
1877 ignore. Also ignore if the value is already set. */
1879 if (pw == NULL) break;
1880 Ustrcpy(name+Ustrlen(name)-4, "group");
1881 ol2 = find_option(name, oltop, last);
1882 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1883 (ol2->type & opt_mask) == opt_expand_gid))
1885 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1888 if (data_block == NULL)
1889 *((gid_t *)(ol2->value)) = pw->pw_gid;
1891 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1897 /* If it was an expanded gid, see if there is any expansion to be
1898 done by checking for the presence of a $ character. If there is, save it
1899 in the corresponding *expand_user option field. Otherwise, fall through
1900 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1903 case opt_expand_gid:
1904 sprintf(CS name2, "*expand_%.50s", name);
1905 ol2 = find_option(name2, oltop, last);
1908 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1910 if (data_block == NULL)
1911 *((uschar **)(ol2->value)) = ss;
1913 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1917 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1923 /* Handle freestanding gid */
1926 if (!route_findgroup(sptr, &gid))
1927 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1928 if (data_block == NULL)
1929 *((gid_t *)(ol->value)) = gid;
1931 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1932 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1935 /* If it was a uid list, look up each individual entry, and build
1936 a vector of uids, with a count in the first element. Put the vector
1937 in malloc store so we can free the string. (We are reading into
1938 permanent store already.) */
1946 const uschar *op = expand_string (sptr);
1949 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1950 name, expand_string_message);
1953 if (*p != 0) count++;
1954 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1955 list = store_malloc(count*sizeof(uid_t));
1956 list[ptr++] = (uid_t)(count - 1);
1958 if (data_block == NULL)
1959 *((uid_t **)(ol->value)) = list;
1961 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1967 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1968 if (!route_finduser(big_buffer, NULL, &uid))
1969 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1976 /* If it was a gid list, look up each individual entry, and build
1977 a vector of gids, with a count in the first element. Put the vector
1978 in malloc store so we can free the string. (We are reading into permanent
1987 const uschar *op = expand_string (sptr);
1990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1991 name, expand_string_message);
1994 if (*p != 0) count++;
1995 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1996 list = store_malloc(count*sizeof(gid_t));
1997 list[ptr++] = (gid_t)(count - 1);
1999 if (data_block == NULL)
2000 *((gid_t **)(ol->value)) = list;
2002 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2008 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2009 if (!route_findgroup(big_buffer, &gid))
2010 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2018 /* Release store if the value of the string doesn't need to be kept. */
2020 if (freesptr) store_reset(reset_point);
2023 /* Expanded boolean: if no characters follow, or if there are no dollar
2024 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2025 save the string for later expansion in the alternate place. */
2027 case opt_expand_bool:
2028 if (*s != 0 && Ustrchr(s, '$') != 0)
2030 sprintf(CS name2, "*expand_%.50s", name);
2031 ol2 = find_option(name2, oltop, last);
2034 reset_point = sptr = read_string(s, name);
2035 if (data_block == NULL)
2036 *((uschar **)(ol2->value)) = sptr;
2038 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2045 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2046 look for yes/not/true/false. Some booleans are stored in a single bit in
2047 a single int. There's a special fudge for verify settings; without a suffix
2048 they set both xx_sender and xx_recipient. The table points to the sender
2049 value; search subsequently for the recipient. There's another special case:
2050 opt_bool_set also notes when a boolean has been set. */
2054 case opt_bool_verify:
2058 s = readconf_readname(name2, 64, s);
2059 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2061 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2063 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2064 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2065 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2066 US"for boolean option ", name);
2069 /* Handle single-bit type. */
2071 if (type == opt_bit)
2073 int bit = 1 << ((ol->type >> 16) & 31);
2074 int *ptr = (data_block == NULL)?
2075 (int *)(ol->value) :
2076 (int *)(US data_block + (long int)ol->value);
2077 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2081 /* Handle full BOOL types */
2083 if (data_block == NULL)
2084 *((BOOL *)(ol->value)) = boolvalue;
2086 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2090 if (type == opt_bool_verify)
2092 sprintf(CS name2, "%.50s_recipient", name + offset);
2093 ol2 = find_option(name2, oltop, last);
2096 if (data_block == NULL)
2097 *((BOOL *)(ol2->value)) = boolvalue;
2099 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2103 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2105 else if (type == opt_bool_set)
2107 sprintf(CS name2, "*set_%.50s", name + offset);
2108 ol2 = find_option(name2, oltop, last);
2111 if (data_block == NULL)
2112 *((BOOL *)(ol2->value)) = TRUE;
2114 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2123 inttype = US"octal ";
2125 /* Integer: a simple(ish) case; allow octal and hex formats, and
2126 suffixes K, M and G. The different types affect output, not input. */
2135 lvalue = strtol(CS s, CSS &endptr, intbase);
2138 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2141 if (errno != ERANGE && *endptr)
2143 uschar * mp = US"GgMmKk\0"; /* YyZzEePpTtGgMmKk */
2145 if ((mp = Ustrchr(mp, *endptr)))
2150 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2161 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2163 "absolute value of integer \"%s\" is too large (overflow)", s);
2165 while (isspace(*endptr)) endptr++;
2167 extra_chars_error(endptr, inttype, US"integer value for ", name);
2169 value = (int)lvalue;
2173 *(int *)(US data_block + (long int)ol->value) = value;
2175 *(int *)ol->value = value;
2178 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M,
2185 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2188 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2191 if (errno != ERANGE && *endptr)
2193 uschar * mp = US"EePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2195 if ((mp = Ustrchr(mp, *endptr)))
2200 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2210 lvalue = (lvalue + 512)/1024;
2213 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2214 "absolute value of integer \"%s\" is too large (overflow)", s);
2216 while (isspace(*endptr)) endptr++;
2218 extra_chars_error(endptr, inttype, US"integer value for ", name);
2221 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2223 *(int_eximarith_t *)ol->value = lvalue;
2227 /* Fixed-point number: held to 3 decimal places. */
2230 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2232 "fixed-point number expected for %s", name);
2234 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2235 "integer \"%s\" is too large (overflow)", s);
2239 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2240 "integer \"%s\" is too large (overflow)", s);
2242 /* We get a coverity error here for using count, as it derived
2243 from the tainted buffer pointed to by s, as parsed by sscanf().
2244 By the definition of sscanf we must be accessing between start
2245 and end of s (assuming it is nul-terminated...) so ignore the error. */
2246 /* coverity[tainted_data] */
2247 if (s[count] == '.')
2250 while (isdigit(s[++count]))
2252 value += (s[count] - '0') * d;
2257 while (isspace(s[count])) count++;
2260 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2262 if (data_block == NULL)
2263 *((int *)(ol->value)) = value;
2265 *((int *)(US data_block + (long int)(ol->value))) = value;
2268 /* There's a special routine to read time values. */
2271 value = readconf_readtime(s, 0, FALSE);
2273 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2275 if (data_block == NULL)
2276 *((int *)(ol->value)) = value;
2278 *((int *)(US data_block + (long int)(ol->value))) = value;
2281 /* A time list is a list of colon-separated times, with the first
2282 element holding the size of the list and the second the number of
2288 int *list = (data_block == NULL)?
2289 (int *)(ol->value) :
2290 (int *)(US data_block + (long int)(ol->value));
2292 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2295 uschar *snext = Ustrchr(s, ':');
2299 while (ss > s && isspace(ss[-1])) ss--;
2302 value = readconf_readtime(s, terminator, FALSE);
2304 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2306 if (count > 1 && value <= list[count])
2307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2308 "time value out of order for %s", name);
2309 list[count+1] = value;
2310 if (snext == NULL) break;
2312 while (isspace(*s)) s++;
2315 if (count > list[0] - 2)
2316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2318 if (count > 0 && list[2] == 0) count = 0;
2325 void (*fn)() = ol->value;
2336 /*************************************************
2337 * Print a time value *
2338 *************************************************/
2341 Argument: a time value in seconds
2342 Returns: pointer to a fixed buffer containing the time as a string,
2343 in readconf_readtime() format
2347 readconf_printtime(int t)
2350 uschar *p = time_buffer;
2367 if (w > 0) p += sprintf(CS p, "%dw", w);
2368 if (d > 0) p += sprintf(CS p, "%dd", d);
2369 if (h > 0) p += sprintf(CS p, "%dh", h);
2370 if (m > 0) p += sprintf(CS p, "%dm", m);
2371 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2378 /*************************************************
2379 * Print an individual option value *
2380 *************************************************/
2382 /* This is used by the -bP option, so prints to the standard output.
2383 The entire options list is passed in as an argument, because some options come
2384 in pairs - typically uid/gid settings, which can either be explicit numerical
2385 values, or strings to be expanded later. If the numerical value is unset,
2386 search for "*expand_<name>" to see if there is a string equivalent.
2389 ol option entry, or NULL for an unknown option
2391 options_block NULL for main configuration options; otherwise points to
2392 a driver block; if the option doesn't have opt_public
2393 set, then options_block->options_block is where the item
2395 oltop points to the option list in which ol exists
2396 last one more than the offset of the last entry in optop
2397 no_labels do not show "foo = " at the start.
2399 Returns: boolean success
2403 print_ol(optionlist *ol, uschar *name, void *options_block,
2404 optionlist *oltop, int last, BOOL no_labels)
2417 printf("%s is not a known option\n", name);
2421 /* Non-admin callers cannot see options that have been flagged secure by the
2424 if (!f.admin_user && ol->type & opt_secure)
2427 printf("%s\n", hidden);
2429 printf("%s = %s\n", name, hidden);
2433 /* Else show the value of the option */
2438 if (!(ol->type & opt_public))
2439 options_block = (void *)(((driver_instance *)options_block)->options_block);
2440 value = (void *)(US options_block + (long int)value);
2443 switch(ol->type & opt_mask)
2446 case opt_rewrite: /* Show the text value */
2448 if (!no_labels) printf("%s = ", name);
2449 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2453 if (!no_labels) printf("%s = ", name);
2454 printf("%d\n", *((int *)value));
2459 int x = *((int *)value);
2460 if (x != 0 && (x & 1023) == 0)
2464 if ((x & 1023) == 0)
2469 if (!no_labels) printf("%s = ", name);
2470 printf("%d%c\n", x, c);
2474 if (!no_labels) printf("%s = ", name);
2482 int_eximarith_t x = *((int_eximarith_t *)value);
2483 if (!no_labels) printf("%s = ", name);
2484 if (x == 0) printf("0\n");
2485 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2486 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2487 else printf(PR_EXIM_ARITH "K\n", x);
2492 if (!no_labels) printf("%s = ", name);
2493 printf("%#o\n", *((int *)value));
2496 /* Can be negative only when "unset", in which case integer */
2500 int x = *((int *)value);
2503 if (x < 0) printf("%s =\n", name); else
2505 if (!no_labels) printf("%s = ", name);
2506 printf("%d.", x/1000);
2519 /* If the numerical value is unset, try for the string value */
2521 case opt_expand_uid:
2522 if (! *get_set_flag(name, oltop, last, options_block))
2524 sprintf(CS name2, "*expand_%.50s", name);
2525 if ((ol2 = find_option(name2, oltop, last)))
2527 void *value2 = ol2->value;
2529 value2 = (void *)(US options_block + (long int)value2);
2531 if (!no_labels) printf("%s = ", name);
2532 printf("%s\n", s ? string_printing(s) : US"");
2537 /* Else fall through */
2540 if (!no_labels) printf("%s = ", name);
2541 if (! *get_set_flag(name, oltop, last, options_block))
2544 if ((pw = getpwuid(*((uid_t *)value))))
2545 printf("%s\n", pw->pw_name);
2547 printf("%ld\n", (long int)(*((uid_t *)value)));
2550 /* If the numerical value is unset, try for the string value */
2552 case opt_expand_gid:
2553 if (! *get_set_flag(name, oltop, last, options_block))
2555 sprintf(CS name2, "*expand_%.50s", name);
2556 if ( (ol2 = find_option(name2, oltop, last))
2557 && (ol2->type & opt_mask) == opt_stringptr)
2559 void *value2 = ol2->value;
2561 value2 = (void *)(US options_block + (long int)value2);
2563 if (!no_labels) printf("%s = ", name);
2564 printf("%s\n", s ? string_printing(s) : US"");
2569 /* Else fall through */
2572 if (!no_labels) printf("%s = ", name);
2573 if (! *get_set_flag(name, oltop, last, options_block))
2576 if ((gr = getgrgid(*((int *)value))))
2577 printf("%s\n", gr->gr_name);
2579 printf("%ld\n", (long int)(*((int *)value)));
2583 uidlist = *((uid_t **)value);
2584 if (!no_labels) printf("%s =", name);
2587 uschar sep = no_labels ? '\0' : ' ';
2588 for (int i = 1; i <= (int)(uidlist[0]); i++)
2590 uschar *name = NULL;
2591 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2592 if (sep != '\0') printf("%c", sep);
2593 if (name) printf("%s", name);
2594 else printf("%ld", (long int)(uidlist[i]));
2602 gidlist = *((gid_t **)value);
2603 if (!no_labels) printf("%s =", name);
2606 uschar sep = no_labels ? '\0' : ' ';
2607 for (int i = 1; i <= (int)(gidlist[0]); i++)
2609 uschar *name = NULL;
2610 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2611 if (sep != '\0') printf("%c", sep);
2612 if (name) printf("%s", name);
2613 else printf("%ld", (long int)(gidlist[i]));
2621 if (!no_labels) printf("%s = ", name);
2622 printf("%s\n", readconf_printtime(*((int *)value)));
2627 int *list = (int *)value;
2628 if (!no_labels) printf("%s = ", name);
2629 for (int i = 0; i < list[1]; i++)
2630 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2636 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2640 case opt_expand_bool:
2641 sprintf(CS name2, "*expand_%.50s", name);
2642 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2644 void *value2 = ol2->value;
2646 value2 = (void *)(US options_block + (long int)value2);
2650 if (!no_labels) printf("%s = ", name);
2651 printf("%s\n", string_printing(s));
2654 /* s == NULL => string not set; fall through */
2660 case opt_bool_verify:
2662 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2670 /*************************************************
2671 * Print value from main configuration *
2672 *************************************************/
2674 /* This function, called as a result of encountering the -bP option,
2675 causes the value of any main configuration variable to be output if the
2676 second argument is NULL. There are some special values:
2678 all print all main configuration options
2679 config_file print the name of the configuration file
2680 (configure_file will still work, for backward
2682 routers print the routers' configurations
2683 transports print the transports' configuration
2684 authenticators print the authenticators' configuration
2685 macros print the macros' configuration
2686 router_list print a list of router names
2687 transport_list print a list of transport names
2688 authenticator_list print a list of authentication mechanism names
2689 macro_list print a list of macro names
2690 +name print a named list item
2691 local_scan print the local_scan options
2692 config print the configuration as it is parsed
2693 environment print the used execution environment
2695 If the second argument is not NULL, it must be one of "router", "transport",
2696 "authenticator" or "macro" in which case the first argument identifies the
2697 driver whose options are to be printed.
2700 name option name if type == NULL; else driver name
2701 type NULL or driver type name, as described above
2702 no_labels avoid the "foo = " at the start of an item
2704 Returns: Boolean success
2708 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2710 BOOL names_only = FALSE;
2711 optionlist *ol2 = NULL;
2712 driver_instance *d = NULL;
2721 static uschar *types[] = { US"address", US"domain", US"host",
2723 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2724 &hostlist_anchor, &localpartlist_anchor };
2726 for (int i = 0; i < 4; i++)
2727 if ((t = tree_search(*(anchors[i]), name+1)))
2731 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2733 printf("%slist %s = %s\n", types[i], name+1,
2734 ((namedlist_block *)(t->data.ptr))->string);
2738 printf("no address, domain, host, or local part list called \"%s\" "
2739 "exists\n", name+1);
2744 if ( Ustrcmp(name, "configure_file") == 0
2745 || Ustrcmp(name, "config_file") == 0)
2747 printf("%s\n", CS config_main_filename);
2751 if (Ustrcmp(name, "all") == 0)
2753 for (optionlist * ol = optionlist_config;
2754 ol < optionlist_config + nelem(optionlist_config); ol++)
2755 if (!(ol->type & opt_hidden))
2756 (void) print_ol(ol, US ol->name, NULL,
2757 optionlist_config, nelem(optionlist_config),
2762 if (Ustrcmp(name, "local_scan") == 0)
2764 #ifndef LOCAL_SCAN_HAS_OPTIONS
2765 printf("local_scan() options are not supported\n");
2768 for (optionlist * ol = local_scan_options;
2769 ol < local_scan_options + local_scan_options_count; ol++)
2770 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2771 local_scan_options_count, no_labels);
2776 if (Ustrcmp(name, "config") == 0)
2778 print_config(f.admin_user, no_labels);
2782 if (Ustrcmp(name, "routers") == 0)
2787 else if (Ustrcmp(name, "transports") == 0)
2789 type = US"transport";
2792 else if (Ustrcmp(name, "authenticators") == 0)
2794 type = US"authenticator";
2797 else if (Ustrcmp(name, "macros") == 0)
2802 else if (Ustrcmp(name, "router_list") == 0)
2808 else if (Ustrcmp(name, "transport_list") == 0)
2810 type = US"transport";
2814 else if (Ustrcmp(name, "authenticator_list") == 0)
2816 type = US"authenticator";
2820 else if (Ustrcmp(name, "macro_list") == 0)
2826 else if (Ustrcmp(name, "environment") == 0)
2831 for (p = USS environ; *p; p++) ;
2832 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2834 for (p = USS environ; *p; p++)
2837 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2845 return print_ol(find_option(name,
2846 optionlist_config, nelem(optionlist_config)),
2847 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2850 /* Handle the options for a router or transport. Skip options that are flagged
2851 as hidden. Some of these are options with names starting with '*', used for
2852 internal alternative representations of other options (which the printing
2853 function will sort out). Others are synonyms kept for backward compatibility.
2856 if (Ustrcmp(type, "router") == 0)
2858 d = (driver_instance *)routers;
2859 ol2 = optionlist_routers;
2860 size = optionlist_routers_size;
2862 else if (Ustrcmp(type, "transport") == 0)
2864 d = (driver_instance *)transports;
2865 ol2 = optionlist_transports;
2866 size = optionlist_transports_size;
2868 else if (Ustrcmp(type, "authenticator") == 0)
2870 d = (driver_instance *)auths;
2871 ol2 = optionlist_auths;
2872 size = optionlist_auths_size;
2875 else if (Ustrcmp(type, "macro") == 0)
2877 /* People store passwords in macros and they were previously not available
2878 for printing. So we have an admin_users restriction. */
2881 fprintf(stderr, "exim: permission denied\n");
2884 for (macro_item * m = macros; m; m = m->next)
2885 if (!name || Ustrcmp(name, m->name) == 0)
2888 printf("%s\n", CS m->name);
2890 printf("%s\n", CS m->replacement);
2892 printf("%s=%s\n", CS m->name, CS m->replacement);
2896 if (!name) return TRUE;
2898 printf("%s %s not found\n", type, name);
2904 for (; d; d = d->next) printf("%s\n", CS d->name);
2908 /* Either search for a given driver, or print all of them */
2910 for (; d; d = d->next)
2914 printf("\n%s %s:\n", d->name, type);
2915 else if (Ustrcmp(d->name, name) != 0) continue;
2917 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2918 if (!(ol->type & opt_hidden))
2919 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2921 for (optionlist * ol = d->info->options;
2922 ol < d->info->options + *(d->info->options_count); ol++)
2923 if (!(ol->type & opt_hidden))
2924 rc |= print_ol(ol, US ol->name, d, d->info->options,
2925 *d->info->options_count, no_labels);
2927 if (name) return rc;
2929 if (!name) return TRUE;
2931 printf("%s %s not found\n", type, name);
2937 /*************************************************
2938 * Read a named list item *
2939 *************************************************/
2941 /* This function reads a name and a list (i.e. string). The name is used to
2942 save the list in a tree, sorted by its name. Each entry also has a number,
2943 which can be used for caching tests, but if the string contains any expansion
2944 items other than $key, the number is set negative to inhibit caching. This
2945 mechanism is used for domain, host, and address lists that are referenced by
2949 anchorp points to the tree anchor
2950 numberp points to the current number for this tree
2951 max the maximum number permitted
2952 s the text of the option line, starting immediately after the name
2954 tname the name of the list type, for messages
2960 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2963 BOOL forcecache = FALSE;
2966 namedlist_block *nb = store_get(sizeof(namedlist_block));
2968 if (Ustrncmp(s, "_cache", 6) == 0)
2975 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2977 if (*numberp >= max)
2978 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2981 while (isspace(*s)) s++;
2983 while (isalnum(*s) || *s == '_') s++;
2984 t = store_get(sizeof(tree_node) + s-ss);
2985 Ustrncpy(t->name, ss, s-ss);
2987 while (isspace(*s)) s++;
2989 if (!tree_insertnode(anchorp, t))
2990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2991 "duplicate name \"%s\" for a named %s", t->name, tname);
2994 nb->number = *numberp;
2997 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2998 "missing '=' after \"%s\"", t->name);
2999 while (isspace(*s)) s++;
3000 nb->string = read_string(s, t->name);
3001 nb->cache_data = NULL;
3003 /* Check the string for any expansions; if any are found, mark this list
3004 uncacheable unless the user has explicited forced caching. */
3006 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3012 /*************************************************
3013 * Unpick data for a rate limit *
3014 *************************************************/
3016 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3020 s string, in the form t,b,f,l
3021 where t is the threshold (integer)
3022 b is the initial delay (time)
3023 f is the multiplicative factor (fixed point)
3024 k is the maximum time (time)
3025 threshold where to store threshold
3026 base where to store base in milliseconds
3027 factor where to store factor in milliseconds
3028 limit where to store limit
3030 Returns: nothing (panics on error)
3034 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3037 uschar bstring[16], lstring[16];
3039 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3040 factor, lstring) == 4)
3042 *base = readconf_readtime(bstring, 0, TRUE);
3043 *limit = readconf_readtime(lstring, 0, TRUE);
3044 if (*base >= 0 && *limit >= 0) return;
3046 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3052 /*************************************************
3053 * Drop privs for checking TLS config *
3054 *************************************************/
3056 /* We want to validate TLS options during readconf, but do not want to be
3057 root when we call into the TLS library, in case of library linkage errors
3058 which cause segfaults; before this check, those were always done as the Exim
3059 runtime user and it makes sense to continue with that.
3061 Assumes: tls_require_ciphers has been set, if it will be
3062 exim_user has been set, if it will be
3063 exim_group has been set, if it will be
3065 Returns: bool for "okay"; false will cause caller to immediately exit.
3070 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3072 const uschar *errmsg;
3075 void (*oldsignal)(int);
3077 /* If TLS will never be used, no point checking ciphers */
3079 if ( !tls_advertise_hosts
3080 || !*tls_advertise_hosts
3081 || Ustrcmp(tls_advertise_hosts, ":") == 0
3084 else if (!nowarn && !tls_certificate)
3085 log_write(0, LOG_MAIN,
3086 "Warning: No server certificate defined; will use a selfsigned one.\n"
3087 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3089 oldsignal = signal(SIGCHLD, SIG_DFL);
3092 if ((pid = fork()) < 0)
3093 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3097 /* in some modes, will have dropped privilege already */
3099 exim_setugid(exim_uid, exim_gid, FALSE,
3100 US"calling tls_validate_require_cipher");
3102 if ((errmsg = tls_validate_require_cipher()))
3103 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3104 "tls_require_ciphers invalid: %s", errmsg);
3110 rc = waitpid(pid, &status, 0);
3111 } while (rc < 0 && errno == EINTR);
3114 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3117 signal(SIGCHLD, oldsignal);
3121 #endif /* SUPPORT_TLS */
3126 /*************************************************
3127 * Read main configuration options *
3128 *************************************************/
3130 /* This function is the first to be called for configuration reading. It
3131 opens the configuration file and reads general configuration settings until
3132 it reaches the end of the configuration section. The file is then left open so
3133 that the remaining configuration data can subsequently be read if needed for
3136 The configuration file must be owned either by root or exim, and be writeable
3137 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3138 in the config file, so the test is done on the compiled in values. A slight
3139 anomaly, to be carefully documented.
3141 The name of the configuration file is taken from a list that is included in the
3142 binary of Exim. It can be altered from the command line, but if that is done,
3143 root privilege is immediately withdrawn unless the caller is root or exim.
3144 The first file on the list that exists is used.
3146 For use on multiple systems that share file systems, first look for a
3147 configuration file whose name has the current node name on the end. If that is
3148 not found, try the generic name. For really contorted configurations, that run
3149 multiple Exims with different uid settings, first try adding the effective uid
3150 before the node name. These complications are going to waste resources on most
3151 systems. Therefore they are available only when requested by compile-time
3155 readconf_main(BOOL nowarn)
3158 struct stat statbuf;
3159 uschar *s, *filename;
3160 const uschar *list = config_main_filelist;
3162 /* Loop through the possible file names */
3164 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3167 /* Cut out all the fancy processing unless specifically wanted */
3169 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3170 uschar *suffix = filename + Ustrlen(filename);
3172 /* Try for the node-specific file if a node name exists */
3174 #ifdef CONFIGURE_FILE_USE_NODE
3176 if (uname(&uts) >= 0)
3178 #ifdef CONFIGURE_FILE_USE_EUID
3179 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3180 config_file = Ufopen(filename, "rb");
3181 if (config_file == NULL)
3182 #endif /* CONFIGURE_FILE_USE_EUID */
3184 sprintf(CS suffix, ".%.256s", uts.nodename);
3185 config_file = Ufopen(filename, "rb");
3188 #endif /* CONFIGURE_FILE_USE_NODE */
3190 /* Otherwise, try the generic name, possibly with the euid added */
3192 #ifdef CONFIGURE_FILE_USE_EUID
3193 if (config_file == NULL)
3195 sprintf(CS suffix, ".%ld", (long int)original_euid);
3196 config_file = Ufopen(filename, "rb");
3198 #endif /* CONFIGURE_FILE_USE_EUID */
3200 /* Finally, try the unadorned name */
3202 if (config_file == NULL)
3205 config_file = Ufopen(filename, "rb");
3207 #else /* if neither defined */
3209 /* This is the common case when the fancy processing is not included. */
3211 config_file = Ufopen(filename, "rb");
3214 /* If the file does not exist, continue to try any others. For any other
3215 error, break out (and die). */
3217 if (config_file != NULL || errno != ENOENT) break;
3220 /* On success, save the name for verification; config_filename is used when
3221 logging configuration errors (it changes for .included files) whereas
3222 config_main_filename is the name shown by -bP. Failure to open a configuration
3223 file is a serious disaster. */
3227 uschar *last_slash = Ustrrchr(filename, '/');
3228 config_filename = config_main_filename = string_copy(filename);
3230 /* The config_main_directory we need for the $config_dir expansion.
3231 config_main_filename we need for $config_file expansion.
3232 And config_dir is the directory of the current configuration, used for
3233 relative .includes. We do need to know it's name, as we change our working
3236 if (filename[0] == '/')
3237 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3240 /* relative configuration file name: working dir + / + basename(filename) */
3242 uschar buf[PATH_MAX];
3245 if (os_getcwd(buf, PATH_MAX) == NULL)
3247 perror("exim: getcwd");
3250 g = string_cat(NULL, buf);
3252 /* If the dir does not end with a "/", append one */
3253 if (g->s[g->ptr-1] != '/')
3254 g = string_catn(g, US"/", 1);
3256 /* If the config file contains a "/", extract the directory part */
3258 g = string_catn(g, filename, last_slash - filename);
3260 config_main_directory = string_from_gstring(g);
3262 config_directory = config_main_directory;
3266 if (filename == NULL)
3267 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3268 "%s", config_main_filelist);
3270 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3271 "configuration file %s", filename));
3274 /* Now, once we found and opened our configuration file, we change the directory
3275 to a safe place. Later we change to $spool_directory. */
3277 if (Uchdir("/") < 0)
3279 perror("exim: chdir `/': ");
3283 /* Check the status of the file we have opened, if we have retained root
3284 privileges and the file isn't /dev/null (which *should* be 0666). */
3286 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3288 if (fstat(fileno(config_file), &statbuf) != 0)
3289 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3292 if ((statbuf.st_uid != root_uid /* owner not root */
3293 #ifdef CONFIGURE_OWNER
3294 && statbuf.st_uid != config_uid /* owner not the special one */
3297 (statbuf.st_gid != root_gid /* group not root & */
3298 #ifdef CONFIGURE_GROUP
3299 && statbuf.st_gid != config_gid /* group not the special one */
3301 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3303 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3305 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3306 "wrong owner, group, or mode", big_buffer);
3309 /* Process the main configuration settings. They all begin with a lower case
3310 letter. If we see something starting with an upper case letter, it is taken as
3311 a macro definition. */
3313 while ((s = get_config_line()))
3315 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3317 "found unexpected BOM (Byte Order Mark)");
3320 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3322 else if (Ustrncmp(s, "domainlist", 10) == 0)
3323 read_named_list(&domainlist_anchor, &domainlist_count,
3324 MAX_NAMED_LIST, s+10, US"domain list");
3326 else if (Ustrncmp(s, "hostlist", 8) == 0)
3327 read_named_list(&hostlist_anchor, &hostlist_count,
3328 MAX_NAMED_LIST, s+8, US"host list");
3330 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3331 read_named_list(&addresslist_anchor, &addresslist_count,
3332 MAX_NAMED_LIST, s+11, US"address list");
3334 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3335 read_named_list(&localpartlist_anchor, &localpartlist_count,
3336 MAX_NAMED_LIST, s+13, US"local part list");
3339 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3340 NULL, US"main option \"%s\" unknown");
3344 /* If local_sender_retain is set, local_from_check must be unset. */
3346 if (local_sender_retain && local_from_check)
3347 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3348 "local_sender_retain are set; this combination is not allowed");
3350 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3353 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3355 /* The max retry interval must not be greater than 24 hours. */
3357 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3359 /* remote_max_parallel must be > 0 */
3361 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3363 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3364 start of a new SMTP message. */
3366 freeze_tell_config = freeze_tell;
3368 /* The primary host name may be required for expansion of spool_directory
3369 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3370 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3371 canonize it. Some people like upper case letters in their host names, so we
3372 don't force the case. */
3374 if (primary_hostname == NULL)
3376 const uschar *hostname;
3378 if (uname(&uts) < 0)
3379 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3380 hostname = US uts.nodename;
3382 if (Ustrchr(hostname, '.') == NULL)
3385 struct hostent *hostdata;
3388 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3389 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3390 MCL_DOMAIN, TRUE, NULL) != OK))
3399 #if HAVE_GETIPNODEBYNAME
3401 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3403 hostdata = gethostbyname2(CS hostname, af);
3406 hostdata = gethostbyname(CS hostname);
3409 if (hostdata != NULL)
3411 hostname = US hostdata->h_name;
3415 if (af == AF_INET) break;
3420 primary_hostname = string_copy(hostname);
3423 /* Set up default value for smtp_active_hostname */
3425 smtp_active_hostname = primary_hostname;
3427 /* If spool_directory wasn't set in the build-time configuration, it must have
3428 got set above. Of course, writing to the log may not work if log_file_path is
3429 not set, but it will at least get to syslog or somewhere, with any luck. */
3431 if (*spool_directory == 0)
3432 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3435 /* Expand the spool directory name; it may, for example, contain the primary
3436 host name. Same comment about failure. */
3438 s = expand_string(spool_directory);
3440 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3441 "\"%s\": %s", spool_directory, expand_string_message);
3442 spool_directory = s;
3444 /* Expand log_file_path, which must contain "%s" in any component that isn't
3445 the null string or "syslog". It is also allowed to contain one instance of %D
3446 or %M. However, it must NOT contain % followed by anything else. */
3448 if (*log_file_path != 0)
3450 const uschar *ss, *sss;
3451 int sep = ':'; /* Fixed for log file path */
3452 s = expand_string(log_file_path);
3454 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3455 "\"%s\": %s", log_file_path, expand_string_message);
3458 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3461 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3462 t = Ustrstr(sss, "%s");
3464 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3465 "contain \"%%s\"", sss);
3467 t = Ustrchr(sss, '%');
3470 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3471 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3472 "unexpected \"%%\" character", s);
3479 /* Interpret syslog_facility into an integer argument for 'ident' param to
3480 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3483 if (syslog_facility_str)
3486 uschar *s = syslog_facility_str;
3488 if ((Ustrlen(syslog_facility_str) >= 4) &&
3489 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3492 for (i = 0; i < syslog_list_size; i++)
3493 if (strcmpic(s, syslog_list[i].name) == 0)
3495 syslog_facility = syslog_list[i].value;
3499 if (i >= syslog_list_size)
3500 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3501 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3504 /* Expand pid_file_path */
3506 if (*pid_file_path != 0)
3508 if (!(s = expand_string(pid_file_path)))
3509 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3510 "\"%s\": %s", pid_file_path, expand_string_message);
3514 /* Set default value of process_log_path */
3516 if (!process_log_path || *process_log_path =='\0')
3517 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3519 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3522 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3524 /* Unpick the SMTP rate limiting options, if set */
3526 if (smtp_ratelimit_mail)
3527 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3528 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3530 if (smtp_ratelimit_rcpt)
3531 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3532 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3534 /* The qualify domains default to the primary host name */
3536 if (!qualify_domain_sender)
3537 qualify_domain_sender = primary_hostname;
3538 if (!qualify_domain_recipient)
3539 qualify_domain_recipient = qualify_domain_sender;
3541 /* Setting system_filter_user in the configuration sets the gid as well if a
3542 name is given, but a numerical value does not. */
3544 if (system_filter_uid_set && !system_filter_gid_set)
3546 struct passwd *pw = getpwuid(system_filter_uid);
3548 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3549 (long int)system_filter_uid);
3550 system_filter_gid = pw->pw_gid;
3551 system_filter_gid_set = TRUE;
3554 /* If the errors_reply_to field is set, check that it is syntactically valid
3555 and ensure it contains a domain. */
3557 if (errors_reply_to)
3560 int start, end, domain;
3561 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3562 &start, &end, &domain, FALSE);
3565 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3566 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3569 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3570 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3573 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3574 smtp_accept_max must also be set. */
3576 if (smtp_accept_max == 0 &&
3577 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3578 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3579 "smtp_accept_max must be set if smtp_accept_queue or "
3580 "smtp_accept_max_per_host is set");
3582 /* Set up the host number if anything is specified. It is an expanded string
3583 so that it can be computed from the host name, for example. We do this last
3584 so as to ensure that everything else is set up before the expansion. */
3586 if (host_number_string)
3590 uschar *s = expand_string(host_number_string);
3593 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3594 "failed to expand localhost_number \"%s\": %s",
3595 host_number_string, expand_string_message);
3596 n = Ustrtol(s, &end, 0);
3597 while (isspace(*end)) end++;
3599 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3600 "localhost_number value is not a number: %s", s);
3601 if (n > LOCALHOST_MAX)
3602 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3603 "localhost_number is greater than the maximum allowed value (%d)",
3609 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3611 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3613 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3614 tls_verify_hosts ? "" : "try_");
3616 /* This also checks that the library linkage is working and we can call
3617 routines in it, so call even if tls_require_ciphers is unset */
3618 if (!tls_dropprivs_validate_require_cipher(nowarn))
3621 /* Magic number: at time of writing, 1024 has been the long-standing value
3622 used by so many clients, and what Exim used to use always, that it makes
3623 sense to just min-clamp this max-clamp at that. */
3624 if (tls_dh_max_bits < 1024)
3625 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3626 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3628 /* If openssl_options is set, validate it */
3629 if (openssl_options)
3632 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3633 "openssl_options is set but we're using GnuTLS");
3636 if (!tls_openssl_options_parse(openssl_options, &dummy))
3637 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3638 "openssl_options parse error: %s", openssl_options);
3641 #endif /*SUPPORT_TLS*/
3643 if (!nowarn && !keep_environment && environ && *environ)
3644 log_write(0, LOG_MAIN,
3645 "Warning: purging the environment.\n"
3646 " Suggested action: use keep_environment.");
3651 /*************************************************
3652 * Initialize one driver *
3653 *************************************************/
3655 /* This is called once the driver's generic options, if any, have been read.
3656 We can now find the driver, set up defaults for the private options, and
3657 unset any "set" bits in the private options table (which might have been
3658 set by another incarnation of the same driver).
3661 d pointer to driver instance block, with generic
3663 drivers_available vector of available drivers
3664 size_of_info size of each block in drivers_available
3665 class class of driver, for error message
3667 Returns: pointer to the driver info block
3670 static driver_info *
3671 init_driver(driver_instance *d, driver_info *drivers_available,
3672 int size_of_info, uschar *class)
3674 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3675 dd = (driver_info *)((US dd) + size_of_info))
3676 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3678 int len = dd->options_len;
3680 d->options_block = store_get(len);
3681 memcpy(d->options_block, dd->options_block, len);
3682 for (int i = 0; i < *(dd->options_count); i++)
3683 dd->options[i].type &= ~opt_set;
3687 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3688 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3690 return NULL; /* never obeyed */
3696 /*************************************************
3697 * Initialize driver list *
3698 *************************************************/
3700 /* This function is called for routers, transports, and authentication
3701 mechanisms. It reads the data from the current point in the configuration file
3702 up to the end of the section, and sets up a chain of instance blocks according
3703 to the file's contents. The file will already have been opened by a call to
3704 readconf_main, and must be left open for subsequent reading of further data.
3706 Any errors cause a panic crash. Note that the blocks with names driver_info and
3707 driver_instance must map the first portions of all the _info and _instance
3708 blocks for this shared code to work.
3711 class "router", "transport", or "authenticator"
3712 anchor &routers, &transports, &auths
3713 drivers_available available drivers
3714 size_of_info size of each info block
3715 instance_default points to default data for an instance
3716 instance_size size of instance block
3717 driver_optionlist generic option list
3718 driver_optionlist_count count of generic option list
3724 readconf_driver_init(
3726 driver_instance **anchor,
3727 driver_info *drivers_available,
3729 void *instance_default,
3731 optionlist *driver_optionlist,
3732 int driver_optionlist_count)
3734 driver_instance **p = anchor;
3735 driver_instance *d = NULL;
3738 while ((buffer = get_config_line()) != NULL)
3743 /* Read the first name on the line and test for the start of a new driver. A
3744 macro definition indicates the end of the previous driver. If this isn't the
3745 start of a new driver, the line will be re-read. */
3747 s = readconf_readname(name, sizeof(name), buffer);
3749 /* Handle macro definition, first finishing off the initialization of the
3750 previous driver, if any. */
3752 if (isupper(*name) && *s == '=')
3756 if (!d->driver_name)
3757 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3758 "no driver defined for %s \"%s\"", class, d->name);
3762 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3766 /* If the line starts with a name terminated by a colon, we are at the
3767 start of the definition of a new driver. The rest of the line must be
3772 /* Finish off initializing the previous driver. */
3776 if (!d->driver_name)
3777 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3778 "no driver defined for %s \"%s\"", class, d->name);
3782 /* Check that we haven't already got a driver of this name */
3784 for (d = *anchor; d; d = d->next)
3785 if (Ustrcmp(name, d->name) == 0)
3786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3787 "there are two %ss called \"%s\"", class, name);
3789 /* Set up a new driver instance data block on the chain, with
3790 its default values installed. */
3792 d = store_get(instance_size);
3793 memcpy(d, instance_default, instance_size);
3796 d->name = string_copy(name);
3798 /* Clear out the "set" bits in the generic options */
3800 for (int i = 0; i < driver_optionlist_count; i++)
3801 driver_optionlist[i].type &= ~opt_set;
3803 /* Check nothing more on this line, then do the next loop iteration. */
3805 while (isspace(*s)) s++;
3806 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3810 /* Not the start of a new driver. Give an error if we have not set up a
3811 current driver yet. */
3814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3816 /* First look to see if this is a generic option; if it is "driver",
3817 initialize the driver. If is it not a generic option, we can look for a
3818 private option provided that the driver has been previously set up. */
3820 if (readconf_handle_option(buffer, driver_optionlist,
3821 driver_optionlist_count, d, NULL))
3823 if (!d->info && d->driver_name)
3824 init_driver(d, drivers_available, size_of_info, class);
3827 /* Handle private options - pass the generic block because some may
3828 live therein. A flag with each option indicates if it is in the public
3832 readconf_handle_option(buffer, d->info->options,
3833 *(d->info->options_count), d, US"option \"%s\" unknown");
3835 /* The option is not generic and the driver name has not yet been given. */
3837 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3838 "(\"driver\" must be specified before any private options)", name);
3841 /* Run the initialization function for the final driver. */
3845 if (!d->driver_name)
3846 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3847 "no driver defined for %s \"%s\"", class, d->name);
3854 /*************************************************
3855 * Check driver dependency *
3856 *************************************************/
3858 /* This function is passed a driver instance and a string. It checks whether
3859 any of the string options for the driver contains the given string as an
3863 d points to a driver instance block
3864 s the string to search for
3866 Returns: TRUE if a dependency is found
3870 readconf_depends(driver_instance *d, uschar *s)
3872 int count = *(d->info->options_count);
3875 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3877 void *options_block;
3879 int type = ol->type & opt_mask;
3880 if (type != opt_stringptr) continue;
3881 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3882 value = *(uschar **)(US options_block + (long int)(ol->value));
3883 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3885 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3886 isalnum(ss[Ustrlen(s)])) continue;
3887 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3888 d->name, ol->name, s);
3893 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3900 /*************************************************
3901 * Decode an error type for retries *
3902 *************************************************/
3904 /* This function is global because it is also called from the main
3905 program when testing retry information. It decodes strings such as "quota_7d"
3906 into numerical error codes.
3909 pp points to start of text
3910 p points past end of text
3911 basic_errno points to an int to receive the main error number
3912 more_errno points to an int to receive the secondary error data
3914 Returns: NULL if decoded correctly; else points to error text
3918 readconf_retry_error(const uschar *pp, const uschar *p,
3919 int *basic_errno, int *more_errno)
3922 const uschar *q = pp;
3923 while (q < p && *q != '_') q++;
3926 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3928 *basic_errno = ERRNO_EXIMQUOTA;
3929 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3930 return US"bad time value";
3933 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3935 *basic_errno = ECONNREFUSED;
3938 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3939 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3940 else return US"A or MX expected after \"refused\"";
3944 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3946 *basic_errno = ETIMEDOUT;
3950 int xlen = p - q - 1;
3951 const uschar *x = q + 1;
3953 static uschar *extras[] =
3954 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3955 static int values[] =
3956 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3958 for (i = 0; i < nelem(extras); i++)
3959 if (strncmpic(x, extras[i], xlen) == 0)
3961 *more_errno = values[i];
3965 if (i >= nelem(extras))
3966 if (strncmpic(x, US"DNS", xlen) == 0)
3967 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3968 "available in retry rules (it has never worked) - treated as "
3971 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3975 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3976 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3977 strncmpic(pp, US"data_4", 6) == 0)
3980 int x = 255; /* means "any 4xx code" */
3981 if (p != pp + 8) bad = TRUE; else
3983 int a = pp[6], b = pp[7];
3987 if (isdigit(b)) x += b - '0';
3988 else if (b == 'x') x += 100;
3991 else if (a != 'x' || b != 'x') bad = TRUE;
3995 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3996 "x is literal and d is any digit", pp);
3998 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3999 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4000 *more_errno = x << 8;
4003 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4004 strncmpic(q+1, US"failed", p-q-1) == 0)
4005 *basic_errno = ERRNO_AUTHFAIL;
4007 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4008 *basic_errno = ERRNO_SMTPCLOSED;
4010 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4011 *basic_errno = ERRNO_TLSREQUIRED;
4013 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4014 *basic_errno = ERRNO_UNKNOWNHOST;
4016 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4017 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4025 /*************************************************
4026 * Read retry information *
4027 *************************************************/
4029 /* Each line of retry information contains:
4031 . A domain name pattern or an address pattern;
4033 . An error name, possibly with additional data, or *;
4035 . An optional sequence of retry items, each consisting of an identifying
4036 letter, a cutoff time, and optional parameters.
4038 All this is decoded and placed into a control block. */
4041 /* Subroutine to read an argument, preceded by a comma and terminated
4042 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4043 1 = fixed point number (returned *1000).
4046 paddr pointer to pointer to current character; updated
4047 type 0 => read a time; 1 => read a fixed point number
4049 Returns: time in seconds or fixed point number * 1000
4053 retry_arg(const uschar **paddr, int type)
4055 const uschar *p = *paddr;
4058 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4060 while (isspace(*p)) p++;
4062 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4064 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4065 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4070 case 0: return readconf_readtime(pp, *p, FALSE);
4071 case 1: return readconf_readfixed(pp, *p);
4073 return 0; /* Keep picky compilers happy */
4076 /* The function proper */
4079 readconf_retries(void)
4081 retry_config **chain = &retries;
4085 while ((p = get_config_line()))
4087 retry_rule **rchain;
4091 next = store_get(sizeof(retry_config));
4094 chain = &(next->next);
4095 next->basic_errno = next->more_errno = 0;
4096 next->senders = NULL;
4098 rchain = &(next->rules);
4100 next->pattern = string_dequote(&p);
4101 while (isspace(*p)) p++;
4103 while (mac_isgraph(*p)) p++;
4104 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4105 "missing error type in retry rule");
4107 /* Test error names for things we understand. */
4109 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4110 &next->more_errno)))
4111 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4113 /* There may be an optional address list of senders to be used as another
4114 constraint on the rule. This was added later, so the syntax is a bit of a
4115 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4118 while (isspace(*p)) p++;
4119 if (Ustrncmp(p, "senders", 7) == 0)
4122 while (isspace(*p)) p++;
4123 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4124 "\"=\" expected after \"senders\" in retry rule");
4125 while (isspace(*p)) p++;
4126 next->senders = string_dequote(&p);
4129 /* Now the retry rules. Keep the maximum timeout encountered. */
4131 while (isspace(*p)) p++;
4135 retry_rule *rule = store_get(sizeof(retry_rule));
4137 rchain = &(rule->next);
4139 rule->rule = toupper(*p++);
4140 rule->timeout = retry_arg(&p, 0);
4141 if (rule->timeout > retry_maximum_timeout)
4142 retry_maximum_timeout = rule->timeout;
4146 case 'F': /* Fixed interval */
4147 rule->p1 = retry_arg(&p, 0);
4150 case 'G': /* Geometrically increasing intervals */
4151 case 'H': /* Ditto, but with randomness */
4152 rule->p1 = retry_arg(&p, 0);
4153 rule->p2 = retry_arg(&p, 1);
4157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4161 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4162 (rule->rule != 'F' && rule->p2 < 1000))
4163 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4164 "bad parameters for retry rule");
4166 while (isspace(*p)) p++;
4170 while (isspace(*p)) p++;
4173 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4180 /*************************************************
4181 * Initialize authenticators *
4182 *************************************************/
4184 /* Read the authenticators section of the configuration file.
4193 #ifdef EXPERIMENTAL_PIPE_CONNECT
4197 readconf_driver_init(US"authenticator",
4198 (driver_instance **)(&auths), /* chain anchor */
4199 (driver_info *)auths_available, /* available drivers */
4200 sizeof(auth_info), /* size of info block */
4201 &auth_defaults, /* default values for generic options */
4202 sizeof(auth_instance), /* size of instance block */
4203 optionlist_auths, /* generic options */
4204 optionlist_auths_size);
4206 for (auth_instance * au = auths; au; au = au->next)
4208 if (!au->public_name)
4209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4210 "the %s authenticator", au->name);
4212 for (auth_instance * bu = au->next; bu; bu = bu->next)
4213 if (strcmpic(au->public_name, bu->public_name) == 0)
4214 if ((au->client && bu->client) || (au->server && bu->server))
4215 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4216 "(%s and %s) have the same public name (%s)",
4217 au->client ? US"client" : US"server", au->name, bu->name,
4219 #ifdef EXPERIMENTAL_PIPE_CONNECT
4223 #ifdef EXPERIMENTAL_PIPE_CONNECT
4224 f.smtp_in_early_pipe_no_auth = nauths > 16;
4231 /*************************************************
4232 * Read ACL information *
4233 *************************************************/
4235 /* If this run of Exim is not doing something that involves receiving a
4236 message, we can just skip over the ACL information. No need to parse it.
4238 First, we have a function for acl_read() to call back to get the next line. We
4239 need to remember the line we passed, because at the end it will contain the
4240 name of the next ACL. */
4242 static uschar *acl_line;
4247 acl_line = get_config_line();
4252 /* Now the main function:
4263 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4266 acl_line = get_config_line();
4274 p = readconf_readname(name, sizeof(name), acl_line);
4275 if (isupper(*name) && *p == '=')
4277 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4278 acl_line = get_config_line();
4282 if (*p != ':' || name[0] == 0)
4283 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4285 node = store_get(sizeof(tree_node) + Ustrlen(name));
4286 Ustrcpy(node->name, name);
4287 if (!tree_insertnode(&acl_anchor, node))
4288 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4289 "there are two ACLs called \"%s\"", name);
4291 node->data.ptr = acl_read(acl_callback, &error);
4293 if (node->data.ptr == NULL && error != NULL)
4294 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4300 /*************************************************
4301 * Read configuration for local_scan() *
4302 *************************************************/
4304 /* This function is called after "begin local_scan" is encountered in the
4305 configuration file. If the local_scan() function allows for configuration
4306 options, we can process them. Otherwise, we expire in a panic.
4313 local_scan_init(void)
4315 #ifndef LOCAL_SCAN_HAS_OPTIONS
4316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4317 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4321 while ((p = get_config_line()))
4323 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4324 NULL, US"local_scan option \"%s\" unknown");
4331 /*************************************************
4332 * Read rest of configuration (after main) *
4333 *************************************************/
4335 /* This function reads the rest of the runtime configuration, after the main
4336 configuration. It is called only when actually needed. Each subsequent section
4337 of the configuration starts with a line of the form
4341 where the name is "routers", "transports", etc. A section is terminated by
4342 hitting the next "begin" line, and the next name is left in next_section.
4343 Because it may confuse people as to whether the names are singular or plural,
4344 we add "s" if it's missing. There is always enough room in next_section for
4345 this. This function is basically just a switch.
4351 static uschar *section_list[] = {
4365 while(next_section[0] != 0)
4369 int last = nelem(section_list);
4371 int n = Ustrlen(next_section);
4373 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4377 int c = strcmpic(next_section, section_list[mid]);
4379 if (c > 0) first = mid + 1; else last = mid;
4381 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4382 "\"%.*s\" is not a known configuration section name", n, next_section);
4383 mid = (last + first)/2;
4387 if (((had ^= bit) & bit) == 0)
4388 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4389 "\"%.*s\" section is repeated in the configuration file", n,
4394 case 0: readconf_acl(); break;
4395 case 1: auths_init(); break;
4396 case 2: local_scan_init(); break;
4397 case 3: readconf_retries(); break;
4398 case 4: readconf_rewrites(); break;
4399 case 5: route_init(); break;
4400 case 6: transport_init(); break;
4404 (void)fclose(config_file);
4407 /* Init the storage for the pre-parsed config lines */
4409 readconf_save_config(const uschar *s)
4411 save_config_line(string_sprintf("# Exim Configuration (%s)",
4412 f.running_in_test_harness ? US"X" : s));
4416 save_config_position(const uschar *file, int line)
4418 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4421 /* Append a pre-parsed logical line to the config lines store,
4422 this operates on a global (static) list that holds all the pre-parsed
4423 config lines, we do no further processing here, output formatting and
4424 honouring of <hide> or macros will be done during output */
4427 save_config_line(const uschar* line)
4429 static config_line_item *current;
4430 config_line_item *next;
4432 next = (config_line_item*) store_get(sizeof(config_line_item));
4433 next->line = string_copy(line);
4436 if (!config_lines) config_lines = next;
4437 else current->next = next;
4442 /* List the parsed config lines, care about nice formatting and
4443 hide the <hide> values unless we're the admin user */
4445 print_config(BOOL admin, BOOL terse)
4447 const int TS = terse ? 0 : 2;
4450 for (config_line_item * i = config_lines; i; i = i->next)
4455 /* skip over to the first non-space */
4456 for (current = i->line; *current && isspace(*current); ++current)
4459 if (*current == '\0')
4462 /* Collapse runs of spaces. We stop this if we encounter one of the
4463 * following characters: "'$, as this may indicate careful formatting */
4464 for (p = current; *p; ++p)
4467 if (!isspace(*p)) continue;
4468 if (*p != ' ') *p = ' ';
4470 for (next = p; isspace(*next); ++next)
4474 memmove(p+1, next, Ustrlen(next)+1);
4476 if (*next == '"' || *next == '\'' || *next == '$')
4481 if (current[0] == '#')
4484 /* begin lines are left aligned */
4485 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4487 if (!terse) puts("");
4492 /* router/acl/transport block names */
4493 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4495 if (!terse) puts("");
4496 printf("%*s%s\n", TS, "", current);
4500 /* hidden lines (all MACROS or lines prefixed with "hide") */
4502 && ( isupper(*current)
4503 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4507 if ((p = Ustrchr(current, '=')))
4510 printf("%*s%s= %s\n", indent, "", current, hidden);
4512 /* e.g.: hide split_spool_directory */
4514 printf("%*s\n", indent, hidden);
4518 /* rest is public */
4519 printf("%*s%s\n", indent, "", current);
4523 #endif /*!MACRO_PREDEF*/
4526 /* End of readconf.c */