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 *, unsigned);
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 { "exim_version", opt_stringptr, &version_string },
153 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
154 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
155 { "finduser_retries", opt_int, &finduser_retries },
156 { "freeze_tell", opt_stringptr, &freeze_tell },
157 { "gecos_name", opt_stringptr, &gecos_name },
158 { "gecos_pattern", opt_stringptr, &gecos_pattern },
160 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
161 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
163 { "header_line_maxsize", opt_int, &header_line_maxsize },
164 { "header_maxsize", opt_int, &header_maxsize },
165 { "headers_charset", opt_stringptr, &headers_charset },
166 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
167 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
168 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
169 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
170 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
171 { "hold_domains", opt_stringptr, &hold_domains },
172 { "host_lookup", opt_stringptr, &host_lookup },
173 { "host_lookup_order", opt_stringptr, &host_lookup_order },
174 { "host_reject_connection", opt_stringptr, &host_reject_connection },
175 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
177 { "hosts_proxy", opt_stringptr, &hosts_proxy },
179 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
181 { "ibase_servers", opt_stringptr, &ibase_servers },
183 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
184 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
185 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
186 { "keep_environment", opt_stringptr, &keep_environment },
187 { "keep_malformed", opt_time, &keep_malformed },
189 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
190 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
191 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
192 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
193 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
194 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
195 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
196 { "ldap_start_tls", opt_bool, &eldap_start_tls },
197 { "ldap_version", opt_int, &eldap_version },
199 { "local_from_check", opt_bool, &local_from_check },
200 { "local_from_prefix", opt_stringptr, &local_from_prefix },
201 { "local_from_suffix", opt_stringptr, &local_from_suffix },
202 { "local_interfaces", opt_stringptr, &local_interfaces },
203 #ifdef HAVE_LOCAL_SCAN
204 { "local_scan_timeout", opt_time, &local_scan_timeout },
206 { "local_sender_retain", opt_bool, &local_sender_retain },
207 { "localhost_number", opt_stringptr, &host_number_string },
208 { "log_file_path", opt_stringptr, &log_file_path },
209 { "log_selector", opt_stringptr, &log_selector_string },
210 { "log_timezone", opt_bool, &log_timezone },
211 { "lookup_open_max", opt_int, &lookup_open_max },
212 { "max_username_length", opt_int, &max_username_length },
213 { "message_body_newlines", opt_bool, &message_body_newlines },
214 { "message_body_visible", opt_mkint, &message_body_visible },
215 { "message_id_header_domain", opt_stringptr, &message_id_domain },
216 { "message_id_header_text", opt_stringptr, &message_id_text },
217 { "message_logs", opt_bool, &message_logs },
218 { "message_size_limit", opt_stringptr, &message_size_limit },
219 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
220 { "move_frozen_messages", opt_bool, &move_frozen_messages },
222 { "mua_wrapper", opt_bool, &mua_wrapper },
224 { "mysql_servers", opt_stringptr, &mysql_servers },
226 { "never_users", opt_uidlist, &never_users },
228 { "openssl_options", opt_stringptr, &openssl_options },
231 { "oracle_servers", opt_stringptr, &oracle_servers },
233 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
235 { "perl_at_start", opt_bool, &opt_perl_at_start },
236 { "perl_startup", opt_stringptr, &opt_perl_startup },
237 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
240 { "pgsql_servers", opt_stringptr, &pgsql_servers },
242 { "pid_file_path", opt_stringptr, &pid_file_path },
243 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
244 #ifdef SUPPORT_PIPE_CONNECT
245 { "pipelining_connect_advertise_hosts", opt_stringptr,
246 &pipe_connect_advertise_hosts },
249 { "prdr_enable", opt_bool, &prdr_enable },
251 { "preserve_message_logs", opt_bool, &preserve_message_logs },
252 { "primary_hostname", opt_stringptr, &primary_hostname },
253 { "print_topbitchars", opt_bool, &print_topbitchars },
254 { "process_log_path", opt_stringptr, &process_log_path },
255 { "prod_requires_admin", opt_bool, &prod_requires_admin },
256 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
257 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
258 { "queue_domains", opt_stringptr, &queue_domains },
259 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
260 { "queue_only", opt_bool, &queue_only },
261 { "queue_only_file", opt_stringptr, &queue_only_file },
262 { "queue_only_load", opt_fixed, &queue_only_load },
263 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
264 { "queue_only_override", opt_bool, &queue_only_override },
265 { "queue_run_in_order", opt_bool, &queue_run_in_order },
266 { "queue_run_max", opt_stringptr, &queue_run_max },
267 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
268 { "receive_timeout", opt_time, &receive_timeout },
269 { "received_header_text", opt_stringptr, &received_header_text },
270 { "received_headers_max", opt_int, &received_headers_max },
271 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
272 { "recipients_max", opt_int, &recipients_max },
273 { "recipients_max_reject", opt_bool, &recipients_max_reject },
275 { "redis_servers", opt_stringptr, &redis_servers },
277 { "remote_max_parallel", opt_int, &remote_max_parallel },
278 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
279 { "retry_data_expire", opt_time, &retry_data_expire },
280 { "retry_interval_max", opt_time, &retry_interval_max },
281 { "return_path_remove", opt_bool, &return_path_remove },
282 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
283 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
284 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
285 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
286 { "slow_lookup_log", opt_int, &slow_lookup_log },
287 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
288 { "smtp_accept_max", opt_int, &smtp_accept_max },
289 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
290 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
291 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
292 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
293 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
294 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
295 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
296 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
297 { "smtp_banner", opt_stringptr, &smtp_banner },
298 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
299 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
300 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
301 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
302 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
303 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
304 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
305 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
306 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
307 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
308 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
309 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
310 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
311 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
313 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
315 #ifdef WITH_CONTENT_SCAN
316 { "spamd_address", opt_stringptr, &spamd_address },
319 { "spf_guess", opt_stringptr, &spf_guess },
321 { "split_spool_directory", opt_bool, &split_spool_directory },
322 { "spool_directory", opt_stringptr, &spool_directory },
323 { "spool_wireformat", opt_bool, &spool_wireformat },
325 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
327 #ifdef EXPERIMENTAL_SRS
328 { "srs_config", opt_stringptr, &srs_config },
329 { "srs_hashlength", opt_int, &srs_hashlength },
330 { "srs_hashmin", opt_int, &srs_hashmin },
331 { "srs_maxage", opt_int, &srs_maxage },
332 { "srs_secrets", opt_stringptr, &srs_secrets },
333 { "srs_usehash", opt_bool, &srs_usehash },
334 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
336 { "strict_acl_vars", opt_bool, &strict_acl_vars },
337 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
338 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
339 { "syslog_duplication", opt_bool, &syslog_duplication },
340 { "syslog_facility", opt_stringptr, &syslog_facility_str },
341 { "syslog_pid", opt_bool, &syslog_pid },
342 { "syslog_processname", opt_stringptr, &syslog_processname },
343 { "syslog_timestamp", opt_bool, &syslog_timestamp },
344 { "system_filter", opt_stringptr, &system_filter },
345 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
346 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
347 { "system_filter_group", opt_gid, &system_filter_gid },
348 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
349 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
350 { "system_filter_user", opt_uid, &system_filter_uid },
351 { "tcp_nodelay", opt_bool, &tcp_nodelay },
352 #ifdef USE_TCP_WRAPPERS
353 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
355 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
356 { "timezone", opt_stringptr, &timezone_string },
357 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
359 { "tls_certificate", opt_stringptr, &tls_certificate },
360 { "tls_crl", opt_stringptr, &tls_crl },
361 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
362 { "tls_dhparam", opt_stringptr, &tls_dhparam },
363 { "tls_eccurve", opt_stringptr, &tls_eccurve },
364 # ifndef DISABLE_OCSP
365 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
367 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
368 { "tls_privatekey", opt_stringptr, &tls_privatekey },
369 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
370 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
371 # ifdef EXPERIMENTAL_TLS_RESUME
372 { "tls_resumption_hosts", opt_stringptr, &tls_resumption_hosts },
374 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
375 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
376 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
378 { "trusted_groups", opt_gidlist, &trusted_groups },
379 { "trusted_users", opt_uidlist, &trusted_users },
380 { "unknown_login", opt_stringptr, &unknown_login },
381 { "unknown_username", opt_stringptr, &unknown_username },
382 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
383 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
384 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
385 { "warn_message_file", opt_stringptr, &warn_message_file },
386 { "write_rejectlog", opt_bool, &write_rejectlog }
390 static int optionlist_config_size = nelem(optionlist_config);
397 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
402 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
410 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
412 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
414 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
415 builtin_macro_create(buf);
416 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
421 options_logging(void)
425 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
427 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
428 builtin_macro_create(buf);
433 #else /*!MACRO_PREDEF*/
435 extern char **environ;
437 static void save_config_line(const uschar* line);
438 static void save_config_position(const uschar *file, int line);
439 static void print_config(BOOL admin, BOOL terse);
442 #define CSTATE_STACK_SIZE 10
444 const uschar *config_directory = NULL;
447 /* Structure for chain (stack) of .included files */
449 typedef struct config_file_item {
450 struct config_file_item *next;
451 const uschar *filename;
452 const uschar *directory;
457 /* Structure for chain of configuration lines (-bP config) */
459 typedef struct config_line_item {
460 struct config_line_item *next;
464 static config_line_item* config_lines;
466 /* Structure of table of conditional words and their state transitions */
468 typedef struct cond_item {
476 /* Structure of table of syslog facility names and values */
478 typedef struct syslog_fac_item {
484 static const char * const hidden = "<value not displayable>";
486 /* Static variables */
488 static config_file_item *config_file_stack = NULL; /* For includes */
490 static uschar *syslog_facility_str = NULL;
491 static uschar next_section[24];
492 static uschar time_buffer[24];
494 /* State variables for conditional loading (.ifdef / .else / .endif) */
496 static int cstate = 0;
497 static int cstate_stack_ptr = -1;
498 static int cstate_stack[CSTATE_STACK_SIZE];
500 /* Table of state transitions for handling conditional inclusions. There are
501 four possible state transitions:
505 .elifdef true (or .else)
508 .endif just causes the previous cstate to be popped off the stack */
510 static int next_cstate[3][4] =
512 /* State 0: reading from file, or reading until next .else or .endif */
514 /* State 1: condition failed, skipping until next .else or .endif */
516 /* State 2: skipping until .endif */
520 /* Table of conditionals and the states to set. For each name, there are four
521 values: the length of the name (to save computing it each time), the state to
522 set if a macro was found in the line, the state to set if a macro was not found
523 in the line, and a stack manipulation setting which is:
525 -1 pull state value off the stack
526 0 don't alter the stack
527 +1 push value onto stack, before setting new state
530 static cond_item cond_list[] = {
531 { US"ifdef", 5, 0, 1, 1 },
532 { US"ifndef", 6, 1, 0, 1 },
533 { US"elifdef", 7, 2, 3, 0 },
534 { US"elifndef", 8, 3, 2, 0 },
535 { US"else", 4, 2, 2, 0 },
536 { US"endif", 5, 0, 0, -1 }
539 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
541 /* Table of syslog facility names and their values */
543 static syslog_fac_item syslog_list[] = {
544 { US"mail", LOG_MAIL },
545 { US"user", LOG_USER },
546 { US"news", LOG_NEWS },
547 { US"uucp", LOG_UUCP },
548 { US"local0", LOG_LOCAL0 },
549 { US"local1", LOG_LOCAL1 },
550 { US"local2", LOG_LOCAL2 },
551 { US"local3", LOG_LOCAL3 },
552 { US"local4", LOG_LOCAL4 },
553 { US"local5", LOG_LOCAL5 },
554 { US"local6", LOG_LOCAL6 },
555 { US"local7", LOG_LOCAL7 },
556 { US"daemon", LOG_DAEMON }
559 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
562 #define opt_fn_print BIT(0)
563 #define opt_fn_print_label BIT(1)
566 /*************************************************
567 * Find the name of an option *
568 *************************************************/
570 /* This function is to aid debugging. Various functions take arguments that are
571 pointer variables in the options table or in option tables for various drivers.
572 For debugging output, it is useful to be able to find the name of the option
573 which is currently being processed. This function finds it, if it exists, by
574 searching the table(s).
576 Arguments: a value that is presumed to be in the table above
577 Returns: the option name, or an empty string
581 readconf_find_option(void *p)
583 for (int i = 0; i < nelem(optionlist_config); i++)
584 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
586 for (router_instance * r = routers; r; r = r->next)
588 router_info *ri = r->info;
589 for (int i = 0; i < *ri->options_count; i++)
591 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
592 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
593 return US ri->options[i].name;
597 for (transport_instance * t = transports; t; t = t->next)
599 transport_info *ti = t->info;
600 for (int i = 0; i < *ti->options_count; i++)
602 optionlist * op = &ti->options[i];
603 if ((op->type & opt_mask) != opt_stringptr) continue;
604 if (p == ( op->type & opt_public
606 : CS t->options_block
608 + (long int)op->value)
619 /*************************************************
620 * Deal with an assignment to a macro *
621 *************************************************/
623 /* We have a new definition; append to the list.
626 name Name of the macro; will be copied
627 val Expansion result for the macro; will be copied
631 macro_create(const uschar * name, const uschar * val, BOOL command_line)
633 macro_item * m = store_get(sizeof(macro_item), FALSE);
635 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
637 m->command_line = command_line;
638 m->namelen = Ustrlen(name);
639 m->replen = Ustrlen(val);
640 m->name = string_copy(name);
641 m->replacement = string_copy(val);
653 /* This function is called when a line that starts with an upper case letter is
654 encountered. The argument "line" should contain a complete logical line, and
655 start with the first letter of the macro name. The macro name and the
656 replacement text are extracted and stored. Redefinition of existing,
657 non-command line, macros is permitted using '==' instead of '='.
660 s points to the start of the logical line
662 Returns: FALSE iff fatal error
666 macro_read_assignment(uschar *s)
673 while (isalnum(*s) || *s == '_')
675 if (namelen >= sizeof(name) - 1)
677 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
678 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
681 name[namelen++] = *s++;
685 while (isspace(*s)) s++;
688 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
697 while (isspace(*s)) s++;
699 /* If an existing macro of the same name was defined on the command line, we
700 just skip this definition. It's an error to attempt to redefine a macro without
701 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
702 It is also an error to define a macro whose name begins with the name of a
703 previously defined macro. This is the requirement that make using a tree
704 for macros hard; we must check all macros for the substring. Perhaps a
705 sorted list, and a bsearch, would work?
706 Note: it is documented that the other way round works. */
708 for (m = macros; m; m = m->next)
710 if (Ustrcmp(m->name, name) == 0)
712 if (!m->command_line && !redef)
714 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
715 "defined (use \"==\" if you want to redefine it)", name);
721 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
723 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
724 "a macro because previously defined macro \"%s\" is a substring",
729 /* We cannot have this test, because it is documented that a substring
730 macro is permitted (there is even an example).
732 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
733 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
734 * "a macro because it is a substring of previously defined macro \"%s\"",
739 /* Check for an overriding command-line definition. */
741 if (m && m->command_line) return TRUE;
743 /* Redefinition must refer to an existing macro. */
748 m->replen = Ustrlen(s);
749 m->replacement = string_copy(s);
753 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
758 /* We have a new definition. */
760 (void) macro_create(name, s, FALSE);
768 /* Process line for macros. The line is in big_buffer starting at offset len.
769 Expand big_buffer if needed. Handle definitions of new macros, and
770 macro expansions, rewriting the line in the buffer.
773 len Offset in buffer of start of line
774 newlen Pointer to offset of end of line, updated on return
775 macro_found Pointer to return that a macro was expanded
777 Return: pointer to first nonblank char in line
781 macros_expand(int len, int * newlen, BOOL * macro_found)
783 uschar * ss = big_buffer + len;
786 /* Find the true start of the physical line - leading spaces are always
789 while (isspace(*ss)) ss++;
791 /* Process the physical line for macros. If this is the start of the logical
792 line, skip over initial text at the start of the line if it starts with an
793 upper case character followed by a sequence of name characters and an equals
794 sign, because that is the definition of a new macro, and we don't do
795 replacement therein. */
798 if (len == 0 && isupper(*s))
800 while (isalnum(*s) || *s == '_') s++;
801 while (isspace(*s)) s++;
802 if (*s != '=') s = ss; /* Not a macro definition */
805 /* Skip leading chars which cannot start a macro name, to avoid multiple
806 pointless rescans in Ustrstr calls. */
808 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
810 /* For each defined macro, scan the line (from after XXX= if present),
811 replacing all occurrences of the macro. */
813 *macro_found = FALSE;
814 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
819 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
823 while ((p = Ustrstr(t, m->name)) != NULL)
827 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
828 m->name, (int) Ustrlen(ss)-1, ss);
829 /* Expand the buffer if necessary */
831 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
833 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
834 uschar *newbuffer = store_malloc(newsize);
835 memcpy(newbuffer, big_buffer, *newlen + 1);
836 p = newbuffer + (p - big_buffer);
837 s = newbuffer + (s - big_buffer);
838 ss = newbuffer + (ss - big_buffer);
839 t = newbuffer + (t - big_buffer);
840 big_buffer_size = newsize;
841 store_free(big_buffer);
842 big_buffer = newbuffer;
845 /* Shuffle the remaining characters up or down in the buffer before
846 copying in the replacement text. Don't rescan the replacement for this
850 if ((moveby = m->replen - m->namelen) != 0)
852 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
855 Ustrncpy(p, m->replacement, m->replen);
857 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
862 /* An empty macro replacement at the start of a line could mean that ss no
863 longer points to the first non-blank character. */
865 while (isspace(*ss)) ss++;
869 /*************************************************
870 * Read configuration line *
871 *************************************************/
873 /* A logical line of text is read from the configuration file into the big
874 buffer, taking account of macros, .includes, and continuations. The size of
875 big_buffer is increased if necessary. The count of configuration lines is
876 maintained. Physical input lines starting with # (ignoring leading white space,
877 and after macro replacement) and empty logical lines are always ignored.
878 Leading and trailing spaces are removed.
880 If we hit a line of the form "begin xxxx", the xxxx is placed in the
881 next_section vector, and the function returns NULL, indicating the end of a
882 configuration section. On end-of-file, NULL is returned with next_section
887 Returns: a pointer to the first non-blank in the line,
888 or NULL if eof or end of section is reached
892 get_config_line(void)
894 int startoffset = 0; /* To first non-blank char in logical line */
895 int len = 0; /* Of logical line so far */
900 /* Loop for handling continuation lines, skipping comments, and dealing with
905 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
907 if (config_file_stack != NULL) /* EOF inside .include */
909 (void)fclose(config_file);
910 config_file = config_file_stack->file;
911 config_filename = config_file_stack->filename;
912 config_directory = config_file_stack->directory;
913 config_lineno = config_file_stack->lineno;
914 config_file_stack = config_file_stack->next;
916 save_config_position(config_filename, config_lineno);
920 /* EOF at top level */
922 if (cstate_stack_ptr >= 0)
923 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
924 "Unexpected end of configuration file: .endif missing");
926 if (len != 0) break; /* EOF after continuation */
927 next_section[0] = 0; /* EOF at start of logical line */
932 newlen = len + Ustrlen(big_buffer + len);
934 if (config_lines && config_lineno == 1)
935 save_config_position(config_filename, config_lineno);
937 /* Handle pathologically long physical lines - yes, it did happen - by
938 extending big_buffer at this point. The code also copes with very long
941 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
944 big_buffer_size += BIG_BUFFER_SIZE;
945 newbuffer = store_malloc(big_buffer_size);
947 /* This use of strcpy is OK because we know that the string in the old
948 buffer is shorter than the new buffer. */
950 Ustrcpy(newbuffer, big_buffer);
951 store_free(big_buffer);
952 big_buffer = newbuffer;
953 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
955 newlen += Ustrlen(big_buffer + newlen);
958 ss = macros_expand(len, &newlen, ¯o_found);
960 /* Check for comment lines - these are physical lines. */
962 if (*ss == '#') continue;
964 /* Handle conditionals, which are also applied to physical lines. Conditions
965 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
966 expansion occurred on the rest of the line. A preliminary test for the leading
967 '.' saves effort on most lines. */
973 /* Search the list of conditional directives */
975 for (i = 0; i < cond_list_size; i++)
978 cond_item *c = cond_list+i;
979 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
981 /* The following character must be white space or end of string */
983 n = ss[1 + c->namelen];
984 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
986 /* .ifdef and .ifndef push the current state onto the stack, then set
987 a new one from the table. Stack overflow is an error */
991 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
992 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
993 ".%s nested too deeply", c->name);
994 cstate_stack[++cstate_stack_ptr] = cstate;
995 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
998 /* For any of the others, stack underflow is an error. The next state
999 comes either from the stack (.endif) or from the table. */
1003 if (cstate_stack_ptr < 0)
1004 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1005 ".%s without matching .ifdef", c->name);
1006 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1007 next_cstate[cstate][macro_found? c->action1 : c->action2];
1010 /* Having dealt with a directive, break the loop */
1015 /* If we have handled a conditional directive, continue with the next
1016 physical line. Otherwise, fall through. */
1018 if (i < cond_list_size) continue;
1021 /* If the conditional state is not 0 (actively using these lines), ignore
1024 if (cstate != 0) continue; /* Conditional skip */
1026 /* Handle .include lines - these are also physical lines. */
1028 if (Ustrncmp(ss, ".include", 8) == 0 &&
1030 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1033 int include_if_exists = isspace(ss[8])? 0 : 10;
1034 config_file_item *save;
1035 struct stat statbuf;
1037 ss += 9 + include_if_exists;
1038 while (isspace(*ss)) ss++;
1039 t = ss + Ustrlen(ss);
1040 while (t > ss && isspace(t[-1])) t--;
1041 if (*ss == '\"' && t[-1] == '\"')
1048 /* We allow relative file names. For security reasons currently
1049 relative names not allowed with .include_if_exists. For .include_if_exists
1050 we need to check the permissions/ownership of the containing folder */
1052 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1053 "absolute path \"%s\"", ss);
1056 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1057 ss = string_from_gstring(g);
1060 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1063 save_config_position(config_filename, config_lineno);
1064 save = store_get(sizeof(config_file_item), FALSE);
1065 save->next = config_file_stack;
1066 config_file_stack = save;
1067 save->file = config_file;
1068 save->filename = config_filename;
1069 save->directory = config_directory;
1070 save->lineno = config_lineno;
1072 if (!(config_file = Ufopen(ss, "rb")))
1073 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1074 "configuration file %s", ss);
1076 config_filename = string_copy(ss);
1077 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1082 /* If this is the start of the logical line, remember where the non-blank
1083 data starts. Otherwise shuffle down continuation lines to remove leading
1087 startoffset = ss - big_buffer;
1090 s = big_buffer + len;
1093 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1098 /* Accept the new addition to the line. Remove trailing white space. */
1101 while (len > 0 && isspace(big_buffer[len-1])) len--;
1102 big_buffer[len] = 0;
1104 /* We are done if the line does not end in backslash and contains some data.
1105 Empty logical lines are ignored. For continuations, remove the backslash and
1106 go round the loop to read the continuation line. */
1110 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1111 big_buffer[--len] = 0; /* Remove backslash */
1113 } /* Loop for reading multiple physical lines */
1115 /* We now have a logical line. Test for the end of a configuration section (or,
1116 more accurately, for the start of the next section). Place the name of the next
1117 section in next_section, and return NULL. If the name given is longer than
1118 next_section, truncate it. It will be unrecognized later, because all the known
1119 section names do fit. Leave space for pluralizing. */
1121 s = big_buffer + startoffset; /* First non-space character */
1124 save_config_line(s);
1126 if (strncmpic(s, US"begin ", 6) == 0)
1129 while (isspace(*s)) s++;
1130 if (big_buffer + len - s > sizeof(next_section) - 2)
1131 s[sizeof(next_section) - 2] = 0;
1132 Ustrcpy(next_section, s);
1136 /* Return the first non-blank character. */
1143 /*************************************************
1145 *************************************************/
1147 /* The yield is the pointer to the next uschar. Names longer than the
1148 output space are silently truncated. This function is also used from acl.c when
1152 name where to put the name
1156 Returns: new input pointer
1160 readconf_readname(uschar *name, int len, uschar *s)
1163 while (isspace(*s)) s++;
1166 while (isalnum(*s) || *s == '_')
1168 if (p < len-1) name[p++] = *s;
1173 while (isspace(*s)) s++;
1180 /*************************************************
1181 * Read a time value *
1182 *************************************************/
1184 /* This function is also called from outside, to read argument
1185 time values. The format of a time value is:
1187 [<n>w][<n>d][<n>h][<n>m][<n>s]
1189 as long as at least one is present. If a format error is encountered,
1190 return a negative value. The value must be terminated by the given
1195 terminator required terminating character
1196 return_msec if TRUE, allow fractional seconds and return milliseconds
1198 Returns: the time value, or -1 on syntax error
1199 value is seconds if return_msec is FALSE
1200 value is milliseconds if return_msec is TRUE
1204 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1212 if (!isdigit(*s)) return -1;
1213 (void)sscanf(CCS s, "%d%n", &value, &count);
1218 case 'w': value *= 7;
1219 case 'd': value *= 24;
1220 case 'h': value *= 60;
1221 case 'm': value *= 60;
1226 if (!return_msec) return -1;
1227 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1229 if (*s++ != 's') return -1;
1230 yield += (int)(fraction * 1000.0);
1236 if (return_msec) value *= 1000;
1238 if (*s == terminator) return yield;
1240 /* Control never reaches here. */
1245 /*************************************************
1246 * Read a fixed point value *
1247 *************************************************/
1249 /* The value is returned *1000
1253 terminator required terminator
1255 Returns: the value, or -1 on error
1259 readconf_readfixed(const uschar *s, int terminator)
1263 if (!isdigit(*s)) return -1;
1264 (void)sscanf(CS s, "%d%n", &value, &count);
1266 yield = value * 1000;
1270 while (isdigit((*(++s))))
1272 yield += (*s - '0') * m;
1277 return (*s == terminator)? yield : (-1);
1282 /*************************************************
1283 * Find option in list *
1284 *************************************************/
1286 /* The lists are always in order, so binary chop can be used.
1289 name the option name to search for
1290 ol the first entry in the option list
1291 last one more than the offset of the last entry in the option list
1293 Returns: pointer to an option entry, or NULL if not found
1297 find_option(uschar *name, optionlist *ol, int last)
1300 while (last > first)
1302 int middle = (first + last)/2;
1303 int c = Ustrcmp(name, ol[middle].name);
1305 if (c == 0) return ol + middle;
1306 else if (c > 0) first = middle + 1;
1314 /*************************************************
1315 * Find a set flag in option list *
1316 *************************************************/
1318 /* Because some versions of Unix make no restrictions on the values of uids and
1319 gids (even negative ones), we cannot represent "unset" by a special value.
1320 There is therefore a separate boolean variable for each one indicating whether
1321 a value is set or not. This function returns a pointer to the boolean, given
1322 the original option name. It is a major disaster if the flag cannot be found.
1325 name the name of the uid or gid option
1326 oltop points to the start of the relevant option list
1327 last one more than the offset of the last item in the option list
1328 data_block NULL when reading main options => data values in the option
1329 list are absolute addresses; otherwise they are byte offsets
1330 in data_block (used for driver options)
1332 Returns: a pointer to the boolean flag.
1336 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1340 sprintf(CS name2, "*set_%.50s", name);
1341 ol = find_option(name2, oltop, last);
1342 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1343 "Exim internal error: missing set flag for %s", name);
1344 return (data_block == NULL)? (BOOL *)(ol->value) :
1345 (BOOL *)(US data_block + (long int)(ol->value));
1351 /*************************************************
1352 * Output extra characters message and die *
1353 *************************************************/
1355 /* Called when an option line has junk on the end. Sometimes this is because
1356 the sysadmin thinks comments are permitted.
1359 s points to the extra characters
1360 t1..t3 strings to insert in the log message
1362 Returns: doesn't return; dies
1366 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1368 uschar *comment = US"";
1369 if (*s == '#') comment = US" (# is comment only at line start)";
1370 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1371 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1376 /*************************************************
1377 * Read rewrite information *
1378 *************************************************/
1380 /* Each line of rewrite information contains:
1382 . A complete address in the form user@domain, possibly with
1383 leading * for each part; or alternatively, a regex.
1385 . A replacement string (which will be expanded).
1387 . An optional sequence of one-letter flags, indicating which
1388 headers etc. to apply this rule to.
1390 All this is decoded and placed into a control block. The OR of the flags is
1391 maintained in a common word.
1394 p points to the string that makes up the rule
1395 existflags points to the overall flag word
1396 isglobal TRUE if reading global rewrite rules
1398 Returns: the control block for the parsed rule.
1401 static rewrite_rule *
1402 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1404 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1407 next->key = string_dequote(&p);
1409 while (isspace(*p)) p++;
1411 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1412 "missing rewrite replacement string");
1415 next->replacement = string_dequote(&p);
1417 while (*p != 0) switch (*p++)
1419 case ' ': case '\t': break;
1421 case 'q': next->flags |= rewrite_quit; break;
1422 case 'w': next->flags |= rewrite_whole; break;
1424 case 'h': next->flags |= rewrite_all_headers; break;
1425 case 's': next->flags |= rewrite_sender; break;
1426 case 'f': next->flags |= rewrite_from; break;
1427 case 't': next->flags |= rewrite_to; break;
1428 case 'c': next->flags |= rewrite_cc; break;
1429 case 'b': next->flags |= rewrite_bcc; break;
1430 case 'r': next->flags |= rewrite_replyto; break;
1432 case 'E': next->flags |= rewrite_all_envelope; break;
1433 case 'F': next->flags |= rewrite_envfrom; break;
1434 case 'T': next->flags |= rewrite_envto; break;
1436 case 'Q': next->flags |= rewrite_qualify; break;
1437 case 'R': next->flags |= rewrite_repeat; break;
1440 next->flags |= rewrite_smtp;
1441 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1442 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1443 "rewrite rule has the S flag but is not a regular expression");
1447 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1448 "unknown rewrite flag character '%c' "
1449 "(could be missing quotes round replacement item)", p[-1]);
1453 /* If no action flags are set, set all the "normal" rewrites. */
1455 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1456 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1458 /* Remember which exist, for optimization, and return the rule */
1460 *existflags |= next->flags;
1467 /*************************************************
1468 * Read global rewrite information *
1469 *************************************************/
1471 /* Each line is a single rewrite rule; it is parsed into a control block
1472 by readconf_one_rewrite(), and its flags are ORed into the global flag
1473 word rewrite_existflags. */
1476 readconf_rewrites(void)
1478 rewrite_rule **chain = &global_rewrite_rules;
1481 while ((p = get_config_line()) != NULL)
1483 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1485 chain = &(next->next);
1491 /*************************************************
1493 *************************************************/
1495 /* Strings are read into the normal store pool. As long we aren't too
1496 near the end of the current block, the string will just use what is necessary
1497 on the top of the stacking pool, because string_cat() uses the extension
1501 s the rest of the input line
1502 name the option name (for errors)
1504 Returns: pointer to the string
1508 read_string(const uschar *s, const uschar *name)
1513 if (*s != '\"') return string_copy(s);
1516 yield = string_dequote(&s);
1518 if (s == ss+1 || s[-1] != '\"')
1519 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1520 "missing quote at end of string value for %s", name);
1522 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1528 /*************************************************
1529 * Custom-handler options *
1530 *************************************************/
1532 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1534 if (flags & opt_fn_print)
1536 if (flags & opt_fn_print_label) printf("%s = ", name);
1537 printf("%s\n", smtp_receive_timeout_s
1538 ? string_printing2(smtp_receive_timeout_s, FALSE)
1539 : readconf_printtime(smtp_receive_timeout));
1541 else if (*str == '$')
1542 smtp_receive_timeout_s = string_copy(str);
1545 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1546 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1547 if (smtp_receive_timeout < 0)
1548 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1553 /*************************************************
1554 * Handle option line *
1555 *************************************************/
1557 /* This function is called from several places to process a line containing the
1558 setting of an option. The first argument is the line to be decoded; it has been
1559 checked not to be empty and not to start with '#'. Trailing newlines and white
1560 space have been removed. The second argument is a pointer to the list of
1561 variable names that are to be recognized, together with their types and
1562 locations, and the third argument gives the number of entries in the list.
1564 The fourth argument is a pointer to a data block. If it is NULL, then the data
1565 values in the options list are absolute addresses. Otherwise, they are byte
1566 offsets in the data block.
1568 String option data may continue onto several lines; this function reads further
1569 data from config_file if necessary.
1571 The yield of this function is normally zero. If a string continues onto
1572 multiple lines, then the data value is permitted to be followed by a comma
1573 or a semicolon (for use in drivers) and the yield is that character.
1576 buffer contains the configuration line to be handled
1577 oltop points to the start of the relevant option list
1578 last one more than the offset of the last item in the option list
1579 data_block NULL when reading main options => data values in the option
1580 list are absolute addresses; otherwise they are byte offsets
1581 in data_block when they have opt_public set; otherwise
1582 they are byte offsets in data_block->options_block.
1583 unknown_txt format string to use in panic message for unknown option;
1584 must contain %s for option name
1585 if given as NULL, don't panic on unknown option
1587 Returns: TRUE if an option was read successfully,
1588 FALSE false for an unknown option if unknown_txt == NULL,
1589 otherwise panic and die on an unknown option
1593 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1594 void *data_block, uschar *unknown_txt)
1598 int count, type, value;
1602 BOOL boolvalue = TRUE;
1603 BOOL freesptr = TRUE;
1604 optionlist *ol, *ol2;
1608 uschar *inttype = US"";
1611 uschar **str_target;
1615 /* There may be leading spaces; thereafter, we expect an option name starting
1618 while (isspace(*s)) s++;
1620 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1622 /* Read the name of the option, and skip any subsequent white space. If
1623 it turns out that what we read was "hide", set the flag indicating that
1624 this is a secure option, and loop to read the next word. */
1626 for (int n = 0; n < 2; n++)
1628 while (isalnum(*s) || *s == '_')
1630 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1634 while (isspace(*s)) s++;
1635 if (Ustrcmp(name, "hide") != 0) break;
1636 issecure = opt_secure;
1640 /* Deal with "no_" or "not_" here for booleans */
1642 if (Ustrncmp(name, "no_", 3) == 0)
1648 if (Ustrncmp(name, "not_", 4) == 0)
1654 /* Search the list for the given name. A non-existent name, or an option that
1655 is set twice, is a disaster. */
1657 if (!(ol = find_option(name + offset, oltop, last)))
1659 if (unknown_txt == NULL) return FALSE;
1660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1663 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1664 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1665 "\"%s\" option set for the second time", name);
1667 ol->type |= opt_set | issecure;
1668 type = ol->type & opt_mask;
1670 /* Types with data values must be followed by '='; the "no[t]_" prefix
1671 applies only to boolean values. */
1673 if (type < opt_bool || type > opt_bool_last)
1676 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1677 "negation prefix applied to a non-boolean option");
1679 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1680 "unexpected end of line (data missing) after %s", name);
1682 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1685 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1686 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1687 ultimately expands to one of those values. */
1689 else if (*s != 0 && (offset != 0 || *s != '='))
1690 extra_chars_error(s, US"boolean option ", name, US"");
1692 /* Skip white space after = */
1694 if (*s == '=') while (isspace((*(++s))));
1696 /* If there is a data block and the opt_public flag is not set, change
1697 the data block pointer to the private options block. */
1699 if (data_block != NULL && (ol->type & opt_public) == 0)
1700 data_block = (void *)(((driver_instance *)data_block)->options_block);
1702 /* Now get the data according to the type. */
1706 /* If a string value is not enclosed in quotes, it consists of
1707 the rest of the current line, verbatim. Otherwise, string escapes
1710 A transport is specified as a string, which is then looked up in the
1711 list of transports. A search type is specified as one of a number of
1714 A set or rewrite rules for a driver is specified as a string, which is
1715 then parsed into a suitable chain of control blocks.
1717 Uids and gids are specified as strings which are then looked up in the
1718 passwd file. Lists of uids and gids are similarly specified as colon-
1719 separated strings. */
1724 case opt_expand_uid:
1725 case opt_expand_gid:
1730 reset_point = store_mark();
1731 sptr = read_string(s, name);
1733 /* Having read a string, we now have several different ways of using it,
1734 depending on the data type, so do another switch. If keeping the actual
1735 string is not required (because it is interpreted), freesptr is set TRUE,
1736 and at the end we reset the pool. */
1740 /* If this was a string, set the variable to point to the new string,
1741 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1742 rules, we still keep the string (for printing), and parse the rules into a
1743 control block and flags word. */
1746 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1748 if (ol->type & opt_rep_con)
1750 uschar * saved_condition;
1751 /* We already have a condition, we're conducting a crude hack to let
1752 multiple condition rules be chained together, despite storing them in
1754 *str_target = string_copy_perm( (saved_condition = *str_target)
1755 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1756 saved_condition, sptr)
1759 /* TODO(pdp): there is a memory leak here and just below
1760 when we set 3 or more conditions; I still don't
1761 understand the store mechanism enough to know
1762 what's the safe way to free content from an earlier store.
1763 AFAICT, stores stack, so freeing an early stored item also stores
1764 all data alloc'd after it. If we knew conditions were adjacent,
1765 we could survive that, but we don't. So I *think* we need to take
1766 another bit from opt_type to indicate "malloced"; this seems like
1767 quite a hack, especially for this one case. It also means that
1768 we can't ever reclaim the store from the *first* condition.
1770 Because we only do this once, near process start-up, I'm prepared to
1771 let this slide for the time being, even though it rankles. */
1773 else if (ol->type & opt_rep_str)
1776 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1777 : Ustrncmp(name, "set", 3) == 0 ? ';'
1779 int sep_i = -(int)sep_o;
1780 const uschar * list = sptr;
1782 gstring * list_o = NULL;
1786 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1787 list_o = string_cat(list_o, *str_target);
1790 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1791 list_o = string_append_listele(list_o, sep_o, s);
1794 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1805 *USS (US data_block + (long int)(ol->value)) = sptr;
1807 *USS (ol->value) = sptr;
1809 if (type == opt_rewrite)
1814 rewrite_rule **chain;
1817 sprintf(CS name2, "*%.50s_rules", name);
1818 ol2 = find_option(name2, oltop, last);
1819 sprintf(CS name2, "*%.50s_flags", name);
1820 ol3 = find_option(name2, oltop, last);
1822 if (ol2 == NULL || ol3 == NULL)
1823 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1824 "rewrite rules not available for driver");
1826 if (data_block == NULL)
1828 chain = (rewrite_rule **)(ol2->value);
1829 flagptr = (int *)(ol3->value);
1833 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1834 flagptr = (int *)(US data_block + (long int)(ol3->value));
1837 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1839 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1841 chain = &(next->next);
1844 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1845 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1846 "non-header rewrite - not allowed at transport time -");
1850 /* If it was an expanded uid, see if there is any expansion to be
1851 done by checking for the presence of a $ character. If there is, save it
1852 in the corresponding *expand_user option field. Otherwise, fall through
1853 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1856 case opt_expand_uid:
1857 sprintf(CS name2, "*expand_%.50s", name);
1858 ol2 = find_option(name2, oltop, last);
1861 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1863 if (data_block == NULL)
1864 *((uschar **)(ol2->value)) = ss;
1866 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1870 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1876 /* Look up a fixed uid, and also make use of the corresponding gid
1877 if a passwd entry is returned and the gid has not been set. */
1880 if (!route_finduser(sptr, &pw, &uid))
1881 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1882 if (data_block == NULL)
1883 *((uid_t *)(ol->value)) = uid;
1885 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1887 /* Set the flag indicating a fixed value is set */
1889 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1891 /* Handle matching gid if we have a passwd entry: done by finding the
1892 same name with terminating "user" changed to "group"; if not found,
1893 ignore. Also ignore if the value is already set. */
1895 if (pw == NULL) break;
1896 Ustrcpy(name+Ustrlen(name)-4, US"group");
1897 ol2 = find_option(name, oltop, last);
1898 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1899 (ol2->type & opt_mask) == opt_expand_gid))
1901 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1904 if (data_block == NULL)
1905 *((gid_t *)(ol2->value)) = pw->pw_gid;
1907 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1913 /* If it was an expanded gid, see if there is any expansion to be
1914 done by checking for the presence of a $ character. If there is, save it
1915 in the corresponding *expand_user option field. Otherwise, fall through
1916 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1919 case opt_expand_gid:
1920 sprintf(CS name2, "*expand_%.50s", name);
1921 ol2 = find_option(name2, oltop, last);
1924 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1926 if (data_block == NULL)
1927 *((uschar **)(ol2->value)) = ss;
1929 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1933 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1939 /* Handle freestanding gid */
1942 if (!route_findgroup(sptr, &gid))
1943 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1944 if (data_block == NULL)
1945 *((gid_t *)(ol->value)) = gid;
1947 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1948 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1951 /* If it was a uid list, look up each individual entry, and build
1952 a vector of uids, with a count in the first element. Put the vector
1953 in malloc store so we can free the string. (We are reading into
1954 permanent store already.) */
1962 const uschar *op = expand_string (sptr);
1965 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1966 name, expand_string_message);
1969 if (*p != 0) count++;
1970 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1971 list = store_malloc(count*sizeof(uid_t));
1972 list[ptr++] = (uid_t)(count - 1);
1974 if (data_block == NULL)
1975 *((uid_t **)(ol->value)) = list;
1977 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1983 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1984 if (!route_finduser(big_buffer, NULL, &uid))
1985 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1992 /* If it was a gid list, look up each individual entry, and build
1993 a vector of gids, with a count in the first element. Put the vector
1994 in malloc store so we can free the string. (We are reading into permanent
2003 const uschar *op = expand_string (sptr);
2006 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2007 name, expand_string_message);
2010 if (*p != 0) count++;
2011 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2012 list = store_malloc(count*sizeof(gid_t));
2013 list[ptr++] = (gid_t)(count - 1);
2015 if (data_block == NULL)
2016 *((gid_t **)(ol->value)) = list;
2018 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2024 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2025 if (!route_findgroup(big_buffer, &gid))
2026 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2034 /* Release store if the value of the string doesn't need to be kept. */
2036 if (freesptr) reset_point = store_reset(reset_point);
2039 /* Expanded boolean: if no characters follow, or if there are no dollar
2040 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2041 save the string for later expansion in the alternate place. */
2043 case opt_expand_bool:
2044 if (*s != 0 && Ustrchr(s, '$') != 0)
2046 sprintf(CS name2, "*expand_%.50s", name);
2047 if ((ol2 = find_option(name2, oltop, last)))
2049 reset_point = store_mark();
2050 sptr = read_string(s, name);
2051 if (data_block == NULL)
2052 *((uschar **)(ol2->value)) = sptr;
2054 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2061 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2062 look for yes/not/true/false. Some booleans are stored in a single bit in
2063 a single int. There's a special fudge for verify settings; without a suffix
2064 they set both xx_sender and xx_recipient. The table points to the sender
2065 value; search subsequently for the recipient. There's another special case:
2066 opt_bool_set also notes when a boolean has been set. */
2070 case opt_bool_verify:
2074 s = readconf_readname(name2, 64, s);
2075 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2077 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2079 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2080 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2081 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2082 US"for boolean option ", name);
2085 /* Handle single-bit type. */
2087 if (type == opt_bit)
2089 int bit = 1 << ((ol->type >> 16) & 31);
2090 int *ptr = (data_block == NULL)?
2091 (int *)(ol->value) :
2092 (int *)(US data_block + (long int)ol->value);
2093 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2097 /* Handle full BOOL types */
2099 if (data_block == NULL)
2100 *((BOOL *)(ol->value)) = boolvalue;
2102 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2106 if (type == opt_bool_verify)
2108 sprintf(CS name2, "%.50s_recipient", name + offset);
2109 ol2 = find_option(name2, oltop, last);
2112 if (data_block == NULL)
2113 *((BOOL *)(ol2->value)) = boolvalue;
2115 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2119 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2121 else if (type == opt_bool_set)
2123 sprintf(CS name2, "*set_%.50s", name + offset);
2124 ol2 = find_option(name2, oltop, last);
2127 if (data_block == NULL)
2128 *((BOOL *)(ol2->value)) = TRUE;
2130 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2139 inttype = US"octal ";
2141 /* Integer: a simple(ish) case; allow octal and hex formats, and
2142 suffixes K, M, G, and T. The different types affect output, not input. */
2151 lvalue = strtol(CS s, CSS &endptr, intbase);
2154 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2157 if (errno != ERANGE && *endptr)
2159 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2161 if ((mp = Ustrchr(mp, *endptr)))
2166 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2177 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2178 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2179 "absolute value of integer \"%s\" is too large (overflow)", s);
2181 while (isspace(*endptr)) endptr++;
2183 extra_chars_error(endptr, inttype, US"integer value for ", name);
2185 value = (int)lvalue;
2189 *(int *)(US data_block + (long int)ol->value) = value;
2191 *(int *)ol->value = value;
2194 /* Integer held in K: again, allow formats and suffixes as above. */
2200 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2203 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2206 if (errno != ERANGE && *endptr)
2208 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2210 if ((mp = Ustrchr(mp, *endptr)))
2215 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2224 lvalue = (lvalue + 512)/1024;
2227 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2228 "absolute value of integer \"%s\" is too large (overflow)", s);
2230 while (isspace(*endptr)) endptr++;
2232 extra_chars_error(endptr, inttype, US"integer value for ", name);
2235 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2237 *(int_eximarith_t *)ol->value = lvalue;
2241 /* Fixed-point number: held to 3 decimal places. */
2244 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2245 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2246 "fixed-point number expected for %s", name);
2248 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2249 "integer \"%s\" is too large (overflow)", s);
2253 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2254 "integer \"%s\" is too large (overflow)", s);
2256 /* We get a coverity error here for using count, as it derived
2257 from the tainted buffer pointed to by s, as parsed by sscanf().
2258 By the definition of sscanf we must be accessing between start
2259 and end of s (assuming it is nul-terminated...) so ignore the error. */
2260 /* coverity[tainted_data] */
2261 if (s[count] == '.')
2264 while (isdigit(s[++count]))
2266 value += (s[count] - '0') * d;
2271 while (isspace(s[count])) count++;
2274 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2276 if (data_block == NULL)
2277 *((int *)(ol->value)) = value;
2279 *((int *)(US data_block + (long int)(ol->value))) = value;
2282 /* There's a special routine to read time values. */
2285 value = readconf_readtime(s, 0, FALSE);
2287 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2289 if (data_block == NULL)
2290 *((int *)(ol->value)) = value;
2292 *((int *)(US data_block + (long int)(ol->value))) = value;
2295 /* A time list is a list of colon-separated times, with the first
2296 element holding the size of the list and the second the number of
2302 int *list = (data_block == NULL)?
2303 (int *)(ol->value) :
2304 (int *)(US data_block + (long int)(ol->value));
2306 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2309 uschar *snext = Ustrchr(s, ':');
2313 while (ss > s && isspace(ss[-1])) ss--;
2316 value = readconf_readtime(s, terminator, FALSE);
2318 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2320 if (count > 1 && value <= list[count])
2321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2322 "time value out of order for %s", name);
2323 list[count+1] = value;
2324 if (snext == NULL) break;
2326 while (isspace(*s)) s++;
2329 if (count > list[0] - 2)
2330 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2332 if (count > 0 && list[2] == 0) count = 0;
2339 void (*fn)() = ol->value;
2350 /*************************************************
2351 * Print a time value *
2352 *************************************************/
2355 Argument: a time value in seconds
2356 Returns: pointer to a fixed buffer containing the time as a string,
2357 in readconf_readtime() format
2361 readconf_printtime(int t)
2364 uschar *p = time_buffer;
2381 if (w > 0) p += sprintf(CS p, "%dw", w);
2382 if (d > 0) p += sprintf(CS p, "%dd", d);
2383 if (h > 0) p += sprintf(CS p, "%dh", h);
2384 if (m > 0) p += sprintf(CS p, "%dm", m);
2385 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2392 /*************************************************
2393 * Print an individual option value *
2394 *************************************************/
2396 /* This is used by the -bP option, so prints to the standard output.
2397 The entire options list is passed in as an argument, because some options come
2398 in pairs - typically uid/gid settings, which can either be explicit numerical
2399 values, or strings to be expanded later. If the numerical value is unset,
2400 search for "*expand_<name>" to see if there is a string equivalent.
2403 ol option entry, or NULL for an unknown option
2405 options_block NULL for main configuration options; otherwise points to
2406 a driver block; if the option doesn't have opt_public
2407 set, then options_block->options_block is where the item
2409 oltop points to the option list in which ol exists
2410 last one more than the offset of the last entry in optop
2411 no_labels do not show "foo = " at the start.
2413 Returns: boolean success
2417 print_ol(optionlist *ol, uschar *name, void *options_block,
2418 optionlist *oltop, int last, BOOL no_labels)
2431 printf("%s is not a known option\n", name);
2435 /* Non-admin callers cannot see options that have been flagged secure by the
2438 if (!f.admin_user && ol->type & opt_secure)
2441 printf("%s\n", hidden);
2443 printf("%s = %s\n", name, hidden);
2447 /* Else show the value of the option */
2452 if (!(ol->type & opt_public))
2453 options_block = (void *)(((driver_instance *)options_block)->options_block);
2454 value = (void *)(US options_block + (long int)value);
2457 switch(ol->type & opt_mask)
2460 case opt_rewrite: /* Show the text value */
2462 if (!no_labels) printf("%s = ", name);
2463 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2467 if (!no_labels) printf("%s = ", name);
2468 printf("%d\n", *((int *)value));
2473 int x = *((int *)value);
2474 if (x != 0 && (x & 1023) == 0)
2478 if ((x & 1023) == 0)
2483 if (!no_labels) printf("%s = ", name);
2484 printf("%d%c\n", x, c);
2488 if (!no_labels) printf("%s = ", name);
2496 int_eximarith_t x = *((int_eximarith_t *)value);
2497 if (!no_labels) printf("%s = ", name);
2498 if (x == 0) printf("0\n");
2499 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2500 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2501 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2502 else printf(PR_EXIM_ARITH "K\n", x);
2507 if (!no_labels) printf("%s = ", name);
2508 printf("%#o\n", *((int *)value));
2511 /* Can be negative only when "unset", in which case integer */
2515 int x = *((int *)value);
2518 if (x < 0) printf("%s =\n", name); else
2520 if (!no_labels) printf("%s = ", name);
2521 printf("%d.", x/1000);
2534 /* If the numerical value is unset, try for the string value */
2536 case opt_expand_uid:
2537 if (! *get_set_flag(name, oltop, last, options_block))
2539 sprintf(CS name2, "*expand_%.50s", name);
2540 if ((ol2 = find_option(name2, oltop, last)))
2542 void *value2 = ol2->value;
2544 value2 = (void *)(US options_block + (long int)value2);
2546 if (!no_labels) printf("%s = ", name);
2547 printf("%s\n", s ? string_printing(s) : US"");
2552 /* Else fall through */
2555 if (!no_labels) printf("%s = ", name);
2556 if (! *get_set_flag(name, oltop, last, options_block))
2559 if ((pw = getpwuid(*((uid_t *)value))))
2560 printf("%s\n", pw->pw_name);
2562 printf("%ld\n", (long int)(*((uid_t *)value)));
2565 /* If the numerical value is unset, try for the string value */
2567 case opt_expand_gid:
2568 if (! *get_set_flag(name, oltop, last, options_block))
2570 sprintf(CS name2, "*expand_%.50s", name);
2571 if ( (ol2 = find_option(name2, oltop, last))
2572 && (ol2->type & opt_mask) == opt_stringptr)
2574 void *value2 = ol2->value;
2576 value2 = (void *)(US options_block + (long int)value2);
2578 if (!no_labels) printf("%s = ", name);
2579 printf("%s\n", s ? string_printing(s) : US"");
2584 /* Else fall through */
2587 if (!no_labels) printf("%s = ", name);
2588 if (! *get_set_flag(name, oltop, last, options_block))
2591 if ((gr = getgrgid(*((int *)value))))
2592 printf("%s\n", gr->gr_name);
2594 printf("%ld\n", (long int)(*((int *)value)));
2598 uidlist = *((uid_t **)value);
2599 if (!no_labels) printf("%s =", name);
2602 uschar sep = no_labels ? '\0' : ' ';
2603 for (int i = 1; i <= (int)(uidlist[0]); i++)
2605 uschar *name = NULL;
2606 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2607 if (sep != '\0') printf("%c", sep);
2608 if (name) printf("%s", name);
2609 else printf("%ld", (long int)(uidlist[i]));
2617 gidlist = *((gid_t **)value);
2618 if (!no_labels) printf("%s =", name);
2621 uschar sep = no_labels ? '\0' : ' ';
2622 for (int i = 1; i <= (int)(gidlist[0]); i++)
2624 uschar *name = NULL;
2625 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2626 if (sep != '\0') printf("%c", sep);
2627 if (name) printf("%s", name);
2628 else printf("%ld", (long int)(gidlist[i]));
2636 if (!no_labels) printf("%s = ", name);
2637 printf("%s\n", readconf_printtime(*((int *)value)));
2642 int *list = (int *)value;
2643 if (!no_labels) printf("%s = ", name);
2644 for (int i = 0; i < list[1]; i++)
2645 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2651 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2655 case opt_expand_bool:
2656 sprintf(CS name2, "*expand_%.50s", name);
2657 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2659 void *value2 = ol2->value;
2661 value2 = (void *)(US options_block + (long int)value2);
2665 if (!no_labels) printf("%s = ", name);
2666 printf("%s\n", string_printing(s));
2669 /* s == NULL => string not set; fall through */
2675 case opt_bool_verify:
2677 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2682 void (*fn)() = ol->value;
2683 fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2692 /*************************************************
2693 * Print value from main configuration *
2694 *************************************************/
2696 /* This function, called as a result of encountering the -bP option,
2697 causes the value of any main configuration variable to be output if the
2698 second argument is NULL. There are some special values:
2700 all print all main configuration options
2701 config_file print the name of the configuration file
2702 (configure_file will still work, for backward
2704 routers print the routers' configurations
2705 transports print the transports' configuration
2706 authenticators print the authenticators' configuration
2707 macros print the macros' configuration
2708 router_list print a list of router names
2709 transport_list print a list of transport names
2710 authenticator_list print a list of authentication mechanism names
2711 macro_list print a list of macro names
2712 +name print a named list item
2713 local_scan print the local_scan options
2714 config print the configuration as it is parsed
2715 environment print the used execution environment
2717 If the second argument is not NULL, it must be one of "router", "transport",
2718 "authenticator" or "macro" in which case the first argument identifies the
2719 driver whose options are to be printed.
2722 name option name if type == NULL; else driver name
2723 type NULL or driver type name, as described above
2724 no_labels avoid the "foo = " at the start of an item
2726 Returns: Boolean success
2730 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2732 BOOL names_only = FALSE;
2733 optionlist *ol2 = NULL;
2734 driver_instance *d = NULL;
2743 static uschar *types[] = { US"address", US"domain", US"host",
2745 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2746 &hostlist_anchor, &localpartlist_anchor };
2748 for (int i = 0; i < 4; i++)
2749 if ((t = tree_search(*(anchors[i]), name+1)))
2753 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2755 printf("%slist %s = %s\n", types[i], name+1,
2756 ((namedlist_block *)(t->data.ptr))->string);
2760 printf("no address, domain, host, or local part list called \"%s\" "
2761 "exists\n", name+1);
2766 if ( Ustrcmp(name, "configure_file") == 0
2767 || Ustrcmp(name, "config_file") == 0)
2769 printf("%s\n", CS config_main_filename);
2773 if (Ustrcmp(name, "all") == 0)
2775 for (optionlist * ol = optionlist_config;
2776 ol < optionlist_config + nelem(optionlist_config); ol++)
2777 if (!(ol->type & opt_hidden))
2778 (void) print_ol(ol, US ol->name, NULL,
2779 optionlist_config, nelem(optionlist_config),
2784 if (Ustrcmp(name, "local_scan") == 0)
2786 #ifndef LOCAL_SCAN_HAS_OPTIONS
2787 printf("local_scan() options are not supported\n");
2790 for (optionlist * ol = local_scan_options;
2791 ol < local_scan_options + local_scan_options_count; ol++)
2792 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2793 local_scan_options_count, no_labels);
2798 if (Ustrcmp(name, "config") == 0)
2800 print_config(f.admin_user, no_labels);
2804 if (Ustrcmp(name, "routers") == 0)
2809 else if (Ustrcmp(name, "transports") == 0)
2811 type = US"transport";
2814 else if (Ustrcmp(name, "authenticators") == 0)
2816 type = US"authenticator";
2819 else if (Ustrcmp(name, "macros") == 0)
2824 else if (Ustrcmp(name, "router_list") == 0)
2830 else if (Ustrcmp(name, "transport_list") == 0)
2832 type = US"transport";
2836 else if (Ustrcmp(name, "authenticator_list") == 0)
2838 type = US"authenticator";
2842 else if (Ustrcmp(name, "macro_list") == 0)
2848 else if (Ustrcmp(name, "environment") == 0)
2853 for (p = USS environ; *p; p++) ;
2854 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2856 for (p = USS environ; *p; p++)
2859 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2867 return print_ol(find_option(name,
2868 optionlist_config, nelem(optionlist_config)),
2869 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2872 /* Handle the options for a router or transport. Skip options that are flagged
2873 as hidden. Some of these are options with names starting with '*', used for
2874 internal alternative representations of other options (which the printing
2875 function will sort out). Others are synonyms kept for backward compatibility.
2878 if (Ustrcmp(type, "router") == 0)
2880 d = (driver_instance *)routers;
2881 ol2 = optionlist_routers;
2882 size = optionlist_routers_size;
2884 else if (Ustrcmp(type, "transport") == 0)
2886 d = (driver_instance *)transports;
2887 ol2 = optionlist_transports;
2888 size = optionlist_transports_size;
2890 else if (Ustrcmp(type, "authenticator") == 0)
2892 d = (driver_instance *)auths;
2893 ol2 = optionlist_auths;
2894 size = optionlist_auths_size;
2897 else if (Ustrcmp(type, "macro") == 0)
2899 /* People store passwords in macros and they were previously not available
2900 for printing. So we have an admin_users restriction. */
2903 fprintf(stderr, "exim: permission denied\n");
2906 for (macro_item * m = macros; m; m = m->next)
2907 if (!name || Ustrcmp(name, m->name) == 0)
2910 printf("%s\n", CS m->name);
2912 printf("%s\n", CS m->replacement);
2914 printf("%s=%s\n", CS m->name, CS m->replacement);
2918 if (!name) return TRUE;
2920 printf("%s %s not found\n", type, name);
2926 for (; d; d = d->next) printf("%s\n", CS d->name);
2930 /* Either search for a given driver, or print all of them */
2932 for (; d; d = d->next)
2936 printf("\n%s %s:\n", d->name, type);
2937 else if (Ustrcmp(d->name, name) != 0) continue;
2939 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2940 if (!(ol->type & opt_hidden))
2941 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2943 for (optionlist * ol = d->info->options;
2944 ol < d->info->options + *(d->info->options_count); ol++)
2945 if (!(ol->type & opt_hidden))
2946 rc |= print_ol(ol, US ol->name, d, d->info->options,
2947 *d->info->options_count, no_labels);
2949 if (name) return rc;
2951 if (!name) return TRUE;
2953 printf("%s %s not found\n", type, name);
2959 /*************************************************
2960 * Read a named list item *
2961 *************************************************/
2963 /* This function reads a name and a list (i.e. string). The name is used to
2964 save the list in a tree, sorted by its name. Each entry also has a number,
2965 which can be used for caching tests, but if the string contains any expansion
2966 items other than $key, the number is set negative to inhibit caching. This
2967 mechanism is used for domain, host, and address lists that are referenced by
2971 anchorp points to the tree anchor
2972 numberp points to the current number for this tree
2973 max the maximum number permitted
2974 s the text of the option line, starting immediately after the name
2976 tname the name of the list type, for messages
2982 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2985 BOOL forcecache = FALSE;
2988 namedlist_block *nb = store_get(sizeof(namedlist_block), FALSE);
2990 if (Ustrncmp(s, "_cache", 6) == 0)
2997 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2999 if (*numberp >= max)
3000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3003 while (isspace(*s)) s++;
3005 while (isalnum(*s) || *s == '_') s++;
3006 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3007 Ustrncpy(t->name, ss, s-ss);
3009 while (isspace(*s)) s++;
3011 if (!tree_insertnode(anchorp, t))
3012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3013 "duplicate name \"%s\" for a named %s", t->name, tname);
3016 nb->number = *numberp;
3019 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3020 "missing '=' after \"%s\"", t->name);
3021 while (isspace(*s)) s++;
3022 nb->string = read_string(s, t->name);
3023 nb->cache_data = NULL;
3025 /* Check the string for any expansions; if any are found, mark this list
3026 uncacheable unless the user has explicited forced caching. */
3028 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3034 /*************************************************
3035 * Unpick data for a rate limit *
3036 *************************************************/
3038 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3042 s string, in the form t,b,f,l
3043 where t is the threshold (integer)
3044 b is the initial delay (time)
3045 f is the multiplicative factor (fixed point)
3046 k is the maximum time (time)
3047 threshold where to store threshold
3048 base where to store base in milliseconds
3049 factor where to store factor in milliseconds
3050 limit where to store limit
3052 Returns: nothing (panics on error)
3056 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3059 uschar bstring[16], lstring[16];
3061 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3062 factor, lstring) == 4)
3064 *base = readconf_readtime(bstring, 0, TRUE);
3065 *limit = readconf_readtime(lstring, 0, TRUE);
3066 if (*base >= 0 && *limit >= 0) return;
3068 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3074 /*************************************************
3075 * Drop privs for checking TLS config *
3076 *************************************************/
3078 /* We want to validate TLS options during readconf, but do not want to be
3079 root when we call into the TLS library, in case of library linkage errors
3080 which cause segfaults; before this check, those were always done as the Exim
3081 runtime user and it makes sense to continue with that.
3083 Assumes: tls_require_ciphers has been set, if it will be
3084 exim_user has been set, if it will be
3085 exim_group has been set, if it will be
3087 Returns: bool for "okay"; false will cause caller to immediately exit.
3092 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3094 const uschar *errmsg;
3097 void (*oldsignal)(int);
3099 /* If TLS will never be used, no point checking ciphers */
3101 if ( !tls_advertise_hosts
3102 || !*tls_advertise_hosts
3103 || Ustrcmp(tls_advertise_hosts, ":") == 0
3106 else if (!nowarn && !tls_certificate)
3107 log_write(0, LOG_MAIN,
3108 "Warning: No server certificate defined; will use a selfsigned one.\n"
3109 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3111 oldsignal = signal(SIGCHLD, SIG_DFL);
3114 if ((pid = fork()) < 0)
3115 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3119 /* in some modes, will have dropped privilege already */
3121 exim_setugid(exim_uid, exim_gid, FALSE,
3122 US"calling tls_validate_require_cipher");
3124 if ((errmsg = tls_validate_require_cipher()))
3125 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3126 "tls_require_ciphers invalid: %s", errmsg);
3128 exim_underbar_exit(0);
3132 rc = waitpid(pid, &status, 0);
3133 } while (rc < 0 && errno == EINTR);
3136 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3139 signal(SIGCHLD, oldsignal);
3143 #endif /*DISABLE_TLS*/
3148 /*************************************************
3149 * Read main configuration options *
3150 *************************************************/
3152 /* This function is the first to be called for configuration reading. It
3153 opens the configuration file and reads general configuration settings until
3154 it reaches the end of the configuration section. The file is then left open so
3155 that the remaining configuration data can subsequently be read if needed for
3158 The configuration file must be owned either by root or exim, and be writeable
3159 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3160 in the config file, so the test is done on the compiled in values. A slight
3161 anomaly, to be carefully documented.
3163 The name of the configuration file is taken from a list that is included in the
3164 binary of Exim. It can be altered from the command line, but if that is done,
3165 root privilege is immediately withdrawn unless the caller is root or exim.
3166 The first file on the list that exists is used.
3168 For use on multiple systems that share file systems, first look for a
3169 configuration file whose name has the current node name on the end. If that is
3170 not found, try the generic name. For really contorted configurations, that run
3171 multiple Exims with different uid settings, first try adding the effective uid
3172 before the node name. These complications are going to waste resources on most
3173 systems. Therefore they are available only when requested by compile-time
3177 readconf_main(BOOL nowarn)
3180 struct stat statbuf;
3181 uschar *s, *filename;
3182 const uschar *list = config_main_filelist;
3184 /* Loop through the possible file names */
3186 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3189 /* Cut out all the fancy processing unless specifically wanted */
3191 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3192 uschar *suffix = filename + Ustrlen(filename);
3194 /* Try for the node-specific file if a node name exists */
3196 #ifdef CONFIGURE_FILE_USE_NODE
3198 if (uname(&uts) >= 0)
3200 #ifdef CONFIGURE_FILE_USE_EUID
3201 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3202 config_file = Ufopen(filename, "rb");
3203 if (config_file == NULL)
3204 #endif /* CONFIGURE_FILE_USE_EUID */
3206 sprintf(CS suffix, ".%.256s", uts.nodename);
3207 config_file = Ufopen(filename, "rb");
3210 #endif /* CONFIGURE_FILE_USE_NODE */
3212 /* Otherwise, try the generic name, possibly with the euid added */
3214 #ifdef CONFIGURE_FILE_USE_EUID
3215 if (config_file == NULL)
3217 sprintf(CS suffix, ".%ld", (long int)original_euid);
3218 config_file = Ufopen(filename, "rb");
3220 #endif /* CONFIGURE_FILE_USE_EUID */
3222 /* Finally, try the unadorned name */
3224 if (config_file == NULL)
3227 config_file = Ufopen(filename, "rb");
3229 #else /* if neither defined */
3231 /* This is the common case when the fancy processing is not included. */
3233 config_file = Ufopen(filename, "rb");
3236 /* If the file does not exist, continue to try any others. For any other
3237 error, break out (and die). */
3239 if (config_file != NULL || errno != ENOENT) break;
3242 /* On success, save the name for verification; config_filename is used when
3243 logging configuration errors (it changes for .included files) whereas
3244 config_main_filename is the name shown by -bP. Failure to open a configuration
3245 file is a serious disaster. */
3249 uschar *last_slash = Ustrrchr(filename, '/');
3250 config_filename = config_main_filename = string_copy(filename);
3252 /* The config_main_directory we need for the $config_dir expansion.
3253 config_main_filename we need for $config_file expansion.
3254 And config_dir is the directory of the current configuration, used for
3255 relative .includes. We do need to know it's name, as we change our working
3258 if (filename[0] == '/')
3259 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3262 /* relative configuration file name: working dir + / + basename(filename) */
3264 uschar buf[PATH_MAX];
3267 if (os_getcwd(buf, PATH_MAX) == NULL)
3269 perror("exim: getcwd");
3272 g = string_cat(NULL, buf);
3274 /* If the dir does not end with a "/", append one */
3275 if (g->s[g->ptr-1] != '/')
3276 g = string_catn(g, US"/", 1);
3278 /* If the config file contains a "/", extract the directory part */
3280 g = string_catn(g, filename, last_slash - filename);
3282 config_main_directory = string_from_gstring(g);
3284 config_directory = config_main_directory;
3288 if (filename == NULL)
3289 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3290 "%s", config_main_filelist);
3292 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3293 "configuration file %s", filename));
3296 /* Now, once we found and opened our configuration file, we change the directory
3297 to a safe place. Later we change to $spool_directory. */
3299 if (Uchdir("/") < 0)
3301 perror("exim: chdir `/': ");
3305 /* Check the status of the file we have opened, if we have retained root
3306 privileges and the file isn't /dev/null (which *should* be 0666). */
3308 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3310 if (fstat(fileno(config_file), &statbuf) != 0)
3311 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3314 if ((statbuf.st_uid != root_uid /* owner not root */
3315 #ifdef CONFIGURE_OWNER
3316 && statbuf.st_uid != config_uid /* owner not the special one */
3319 (statbuf.st_gid != root_gid /* group not root & */
3320 #ifdef CONFIGURE_GROUP
3321 && statbuf.st_gid != config_gid /* group not the special one */
3323 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3325 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3327 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3328 "wrong owner, group, or mode", big_buffer);
3331 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3332 This assumes we will need this much storage to handle all the allocations
3333 during startup; it won't help when .include is being used. When it does, it
3334 will cut down on the number of store blocks (and malloc calls, and sbrk
3335 syscalls). It also assume we're on the relevant pool. */
3337 if (statbuf.st_size > 8192)
3339 rmark r = store_mark();
3340 store_get((int)statbuf.st_size, FALSE);
3344 /* Process the main configuration settings. They all begin with a lower case
3345 letter. If we see something starting with an upper case letter, it is taken as
3346 a macro definition. */
3348 while ((s = get_config_line()))
3350 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3351 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3352 "found unexpected BOM (Byte Order Mark)");
3355 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3357 else if (Ustrncmp(s, "domainlist", 10) == 0)
3358 read_named_list(&domainlist_anchor, &domainlist_count,
3359 MAX_NAMED_LIST, s+10, US"domain list");
3361 else if (Ustrncmp(s, "hostlist", 8) == 0)
3362 read_named_list(&hostlist_anchor, &hostlist_count,
3363 MAX_NAMED_LIST, s+8, US"host list");
3365 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3366 read_named_list(&addresslist_anchor, &addresslist_count,
3367 MAX_NAMED_LIST, s+11, US"address list");
3369 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3370 read_named_list(&localpartlist_anchor, &localpartlist_count,
3371 MAX_NAMED_LIST, s+13, US"local part list");
3374 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3375 NULL, US"main option \"%s\" unknown");
3379 /* If local_sender_retain is set, local_from_check must be unset. */
3381 if (local_sender_retain && local_from_check)
3382 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3383 "local_sender_retain are set; this combination is not allowed");
3385 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3388 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3390 /* The max retry interval must not be greater than 24 hours. */
3392 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3394 /* remote_max_parallel must be > 0 */
3396 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3398 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3399 start of a new SMTP message. */
3401 freeze_tell_config = freeze_tell;
3403 /* The primary host name may be required for expansion of spool_directory
3404 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3405 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3406 canonize it. Some people like upper case letters in their host names, so we
3407 don't force the case. */
3409 if (primary_hostname == NULL)
3411 const uschar *hostname;
3413 if (uname(&uts) < 0)
3414 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3415 hostname = US uts.nodename;
3417 if (Ustrchr(hostname, '.') == NULL)
3420 struct hostent *hostdata;
3423 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3424 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3425 MCL_DOMAIN, TRUE, NULL) != OK))
3434 #if HAVE_GETIPNODEBYNAME
3436 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3438 hostdata = gethostbyname2(CS hostname, af);
3441 hostdata = gethostbyname(CS hostname);
3444 if (hostdata != NULL)
3446 hostname = US hostdata->h_name;
3450 if (af == AF_INET) break;
3455 primary_hostname = string_copy(hostname);
3458 /* Set up default value for smtp_active_hostname */
3460 smtp_active_hostname = primary_hostname;
3462 /* If spool_directory wasn't set in the build-time configuration, it must have
3463 got set above. Of course, writing to the log may not work if log_file_path is
3464 not set, but it will at least get to syslog or somewhere, with any luck. */
3466 if (*spool_directory == 0)
3467 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3470 /* Expand the spool directory name; it may, for example, contain the primary
3471 host name. Same comment about failure. */
3473 s = expand_string(spool_directory);
3475 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3476 "\"%s\": %s", spool_directory, expand_string_message);
3477 spool_directory = s;
3479 /* Expand log_file_path, which must contain "%s" in any component that isn't
3480 the null string or "syslog". It is also allowed to contain one instance of %D
3481 or %M. However, it must NOT contain % followed by anything else. */
3483 if (*log_file_path != 0)
3485 const uschar *ss, *sss;
3486 int sep = ':'; /* Fixed for log file path */
3487 s = expand_string(log_file_path);
3489 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3490 "\"%s\": %s", log_file_path, expand_string_message);
3493 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3496 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3497 t = Ustrstr(sss, "%s");
3499 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3500 "contain \"%%s\"", sss);
3502 t = Ustrchr(sss, '%');
3505 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3506 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3507 "unexpected \"%%\" character", s);
3514 /* Interpret syslog_facility into an integer argument for 'ident' param to
3515 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3518 if (syslog_facility_str)
3521 uschar *s = syslog_facility_str;
3523 if ((Ustrlen(syslog_facility_str) >= 4) &&
3524 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3527 for (i = 0; i < syslog_list_size; i++)
3528 if (strcmpic(s, syslog_list[i].name) == 0)
3530 syslog_facility = syslog_list[i].value;
3534 if (i >= syslog_list_size)
3535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3536 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3539 /* Expand pid_file_path */
3541 if (*pid_file_path != 0)
3543 if (!(s = expand_string(pid_file_path)))
3544 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3545 "\"%s\": %s", pid_file_path, expand_string_message);
3549 /* Set default value of process_log_path */
3551 if (!process_log_path || *process_log_path =='\0')
3552 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3554 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3557 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3559 /* Unpick the SMTP rate limiting options, if set */
3561 if (smtp_ratelimit_mail)
3562 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3563 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3565 if (smtp_ratelimit_rcpt)
3566 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3567 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3569 /* The qualify domains default to the primary host name */
3571 if (!qualify_domain_sender)
3572 qualify_domain_sender = primary_hostname;
3573 if (!qualify_domain_recipient)
3574 qualify_domain_recipient = qualify_domain_sender;
3576 /* Setting system_filter_user in the configuration sets the gid as well if a
3577 name is given, but a numerical value does not. */
3579 if (system_filter_uid_set && !system_filter_gid_set)
3581 struct passwd *pw = getpwuid(system_filter_uid);
3583 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3584 (long int)system_filter_uid);
3585 system_filter_gid = pw->pw_gid;
3586 system_filter_gid_set = TRUE;
3589 /* If the errors_reply_to field is set, check that it is syntactically valid
3590 and ensure it contains a domain. */
3592 if (errors_reply_to)
3595 int start, end, domain;
3596 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3597 &start, &end, &domain, FALSE);
3600 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3601 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3604 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3605 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3608 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3609 smtp_accept_max must also be set. */
3611 if (smtp_accept_max == 0 &&
3612 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3613 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3614 "smtp_accept_max must be set if smtp_accept_queue or "
3615 "smtp_accept_max_per_host is set");
3617 /* Set up the host number if anything is specified. It is an expanded string
3618 so that it can be computed from the host name, for example. We do this last
3619 so as to ensure that everything else is set up before the expansion. */
3621 if (host_number_string)
3625 uschar *s = expand_string(host_number_string);
3628 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3629 "failed to expand localhost_number \"%s\": %s",
3630 host_number_string, expand_string_message);
3631 n = Ustrtol(s, &end, 0);
3632 while (isspace(*end)) end++;
3634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3635 "localhost_number value is not a number: %s", s);
3636 if (n > LOCALHOST_MAX)
3637 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3638 "localhost_number is greater than the maximum allowed value (%d)",
3644 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3646 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3648 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3649 tls_verify_hosts ? "" : "try_");
3651 /* This also checks that the library linkage is working and we can call
3652 routines in it, so call even if tls_require_ciphers is unset */
3653 if (!tls_dropprivs_validate_require_cipher(nowarn))
3656 /* Magic number: at time of writing, 1024 has been the long-standing value
3657 used by so many clients, and what Exim used to use always, that it makes
3658 sense to just min-clamp this max-clamp at that. */
3659 if (tls_dh_max_bits < 1024)
3660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3661 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3663 /* If openssl_options is set, validate it */
3664 if (openssl_options)
3667 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3668 "openssl_options is set but we're using GnuTLS");
3671 if (!tls_openssl_options_parse(openssl_options, &dummy))
3672 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3673 "openssl_options parse error: %s", openssl_options);
3676 #endif /*DISABLE_TLS*/
3678 if (!nowarn && !keep_environment && environ && *environ)
3679 log_write(0, LOG_MAIN,
3680 "Warning: purging the environment.\n"
3681 " Suggested action: use keep_environment.");
3686 /*************************************************
3687 * Initialize one driver *
3688 *************************************************/
3690 /* This is called once the driver's generic options, if any, have been read.
3691 We can now find the driver, set up defaults for the private options, and
3692 unset any "set" bits in the private options table (which might have been
3693 set by another incarnation of the same driver).
3696 d pointer to driver instance block, with generic
3698 drivers_available vector of available drivers
3699 size_of_info size of each block in drivers_available
3700 class class of driver, for error message
3702 Returns: pointer to the driver info block
3705 static driver_info *
3706 init_driver(driver_instance *d, driver_info *drivers_available,
3707 int size_of_info, uschar *class)
3709 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3710 dd = (driver_info *)((US dd) + size_of_info))
3711 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3713 int len = dd->options_len;
3715 d->options_block = store_get(len, FALSE);
3716 memcpy(d->options_block, dd->options_block, len);
3717 for (int i = 0; i < *(dd->options_count); i++)
3718 dd->options[i].type &= ~opt_set;
3722 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3723 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3725 return NULL; /* never obeyed */
3731 /*************************************************
3732 * Initialize driver list *
3733 *************************************************/
3735 /* This function is called for routers, transports, and authentication
3736 mechanisms. It reads the data from the current point in the configuration file
3737 up to the end of the section, and sets up a chain of instance blocks according
3738 to the file's contents. The file will already have been opened by a call to
3739 readconf_main, and must be left open for subsequent reading of further data.
3741 Any errors cause a panic crash. Note that the blocks with names driver_info and
3742 driver_instance must map the first portions of all the _info and _instance
3743 blocks for this shared code to work.
3746 class "router", "transport", or "authenticator"
3747 anchor &routers, &transports, &auths
3748 drivers_available available drivers
3749 size_of_info size of each info block
3750 instance_default points to default data for an instance
3751 instance_size size of instance block
3752 driver_optionlist generic option list
3753 driver_optionlist_count count of generic option list
3759 readconf_driver_init(
3761 driver_instance **anchor,
3762 driver_info *drivers_available,
3764 void *instance_default,
3766 optionlist *driver_optionlist,
3767 int driver_optionlist_count)
3769 driver_instance **p = anchor;
3770 driver_instance *d = NULL;
3773 while ((buffer = get_config_line()) != NULL)
3778 /* Read the first name on the line and test for the start of a new driver. A
3779 macro definition indicates the end of the previous driver. If this isn't the
3780 start of a new driver, the line will be re-read. */
3782 s = readconf_readname(name, sizeof(name), buffer);
3784 /* Handle macro definition, first finishing off the initialization of the
3785 previous driver, if any. */
3787 if (isupper(*name) && *s == '=')
3791 if (!d->driver_name)
3792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3793 "no driver defined for %s \"%s\"", class, d->name);
3797 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3801 /* If the line starts with a name terminated by a colon, we are at the
3802 start of the definition of a new driver. The rest of the line must be
3807 /* Finish off initializing the previous driver. */
3811 if (!d->driver_name)
3812 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3813 "no driver defined for %s \"%s\"", class, d->name);
3817 /* Check that we haven't already got a driver of this name */
3819 for (d = *anchor; d; d = d->next)
3820 if (Ustrcmp(name, d->name) == 0)
3821 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3822 "there are two %ss called \"%s\"", class, name);
3824 /* Set up a new driver instance data block on the chain, with
3825 its default values installed. */
3827 d = store_get(instance_size, FALSE);
3828 memcpy(d, instance_default, instance_size);
3831 d->name = string_copy(name);
3833 /* Clear out the "set" bits in the generic options */
3835 for (int i = 0; i < driver_optionlist_count; i++)
3836 driver_optionlist[i].type &= ~opt_set;
3838 /* Check nothing more on this line, then do the next loop iteration. */
3840 while (isspace(*s)) s++;
3841 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3845 /* Not the start of a new driver. Give an error if we have not set up a
3846 current driver yet. */
3849 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3851 /* First look to see if this is a generic option; if it is "driver",
3852 initialize the driver. If is it not a generic option, we can look for a
3853 private option provided that the driver has been previously set up. */
3855 if (readconf_handle_option(buffer, driver_optionlist,
3856 driver_optionlist_count, d, NULL))
3858 if (!d->info && d->driver_name)
3859 init_driver(d, drivers_available, size_of_info, class);
3862 /* Handle private options - pass the generic block because some may
3863 live therein. A flag with each option indicates if it is in the public
3867 readconf_handle_option(buffer, d->info->options,
3868 *(d->info->options_count), d, US"option \"%s\" unknown");
3870 /* The option is not generic and the driver name has not yet been given. */
3872 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3873 "(\"driver\" must be specified before any private options)", name);
3876 /* Run the initialization function for the final driver. */
3880 if (!d->driver_name)
3881 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3882 "no driver defined for %s \"%s\"", class, d->name);
3889 /*************************************************
3890 * Check driver dependency *
3891 *************************************************/
3893 /* This function is passed a driver instance and a string. It checks whether
3894 any of the string options for the driver contains the given string as an
3898 d points to a driver instance block
3899 s the string to search for
3901 Returns: TRUE if a dependency is found
3905 readconf_depends(driver_instance *d, uschar *s)
3907 int count = *(d->info->options_count);
3910 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3912 void *options_block;
3914 int type = ol->type & opt_mask;
3915 if (type != opt_stringptr) continue;
3916 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3917 value = *(uschar **)(US options_block + (long int)(ol->value));
3918 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3920 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3921 isalnum(ss[Ustrlen(s)])) continue;
3922 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3923 d->name, ol->name, s);
3928 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3935 /*************************************************
3936 * Decode an error type for retries *
3937 *************************************************/
3939 /* This function is global because it is also called from the main
3940 program when testing retry information. It decodes strings such as "quota_7d"
3941 into numerical error codes.
3944 pp points to start of text
3945 p points past end of text
3946 basic_errno points to an int to receive the main error number
3947 more_errno points to an int to receive the secondary error data
3949 Returns: NULL if decoded correctly; else points to error text
3953 readconf_retry_error(const uschar *pp, const uschar *p,
3954 int *basic_errno, int *more_errno)
3957 const uschar *q = pp;
3958 while (q < p && *q != '_') q++;
3961 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3963 *basic_errno = ERRNO_EXIMQUOTA;
3964 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3965 return US"bad time value";
3968 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3970 *basic_errno = ECONNREFUSED;
3973 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3974 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3975 else return US"A or MX expected after \"refused\"";
3979 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3981 *basic_errno = ETIMEDOUT;
3985 int xlen = p - q - 1;
3986 const uschar *x = q + 1;
3988 static uschar *extras[] =
3989 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3990 static int values[] =
3991 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3993 for (i = 0; i < nelem(extras); i++)
3994 if (strncmpic(x, extras[i], xlen) == 0)
3996 *more_errno = values[i];
4000 if (i >= nelem(extras))
4001 if (strncmpic(x, US"DNS", xlen) == 0)
4002 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4003 "available in retry rules (it has never worked) - treated as "
4006 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4010 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4011 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4012 strncmpic(pp, US"data_4", 6) == 0)
4015 int x = 255; /* means "any 4xx code" */
4016 if (p != pp + 8) bad = TRUE; else
4018 int a = pp[6], b = pp[7];
4022 if (isdigit(b)) x += b - '0';
4023 else if (b == 'x') x += 100;
4026 else if (a != 'x' || b != 'x') bad = TRUE;
4030 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4031 "x is literal and d is any digit", pp);
4033 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4034 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4035 *more_errno = x << 8;
4038 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4039 strncmpic(q+1, US"failed", p-q-1) == 0)
4040 *basic_errno = ERRNO_AUTHFAIL;
4042 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4043 *basic_errno = ERRNO_SMTPCLOSED;
4045 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4046 *basic_errno = ERRNO_TLSREQUIRED;
4048 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4049 *basic_errno = ERRNO_UNKNOWNHOST;
4051 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4052 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4060 /*************************************************
4061 * Read retry information *
4062 *************************************************/
4064 /* Each line of retry information contains:
4066 . A domain name pattern or an address pattern;
4068 . An error name, possibly with additional data, or *;
4070 . An optional sequence of retry items, each consisting of an identifying
4071 letter, a cutoff time, and optional parameters.
4073 All this is decoded and placed into a control block. */
4076 /* Subroutine to read an argument, preceded by a comma and terminated
4077 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4078 1 = fixed point number (returned *1000).
4081 paddr pointer to pointer to current character; updated
4082 type 0 => read a time; 1 => read a fixed point number
4084 Returns: time in seconds or fixed point number * 1000
4088 retry_arg(const uschar **paddr, int type)
4090 const uschar *p = *paddr;
4093 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4095 while (isspace(*p)) p++;
4097 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4099 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4100 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4105 case 0: return readconf_readtime(pp, *p, FALSE);
4106 case 1: return readconf_readfixed(pp, *p);
4108 return 0; /* Keep picky compilers happy */
4111 /* The function proper */
4114 readconf_retries(void)
4116 retry_config **chain = &retries;
4120 while ((p = get_config_line()))
4122 retry_rule **rchain;
4126 next = store_get(sizeof(retry_config), FALSE);
4129 chain = &(next->next);
4130 next->basic_errno = next->more_errno = 0;
4131 next->senders = NULL;
4133 rchain = &(next->rules);
4135 next->pattern = string_dequote(&p);
4136 while (isspace(*p)) p++;
4138 while (mac_isgraph(*p)) p++;
4139 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4140 "missing error type in retry rule");
4142 /* Test error names for things we understand. */
4144 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4145 &next->more_errno)))
4146 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4148 /* There may be an optional address list of senders to be used as another
4149 constraint on the rule. This was added later, so the syntax is a bit of a
4150 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4153 while (isspace(*p)) p++;
4154 if (Ustrncmp(p, "senders", 7) == 0)
4157 while (isspace(*p)) p++;
4158 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4159 "\"=\" expected after \"senders\" in retry rule");
4160 while (isspace(*p)) p++;
4161 next->senders = string_dequote(&p);
4164 /* Now the retry rules. Keep the maximum timeout encountered. */
4166 while (isspace(*p)) p++;
4170 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4172 rchain = &(rule->next);
4174 rule->rule = toupper(*p++);
4175 rule->timeout = retry_arg(&p, 0);
4176 if (rule->timeout > retry_maximum_timeout)
4177 retry_maximum_timeout = rule->timeout;
4181 case 'F': /* Fixed interval */
4182 rule->p1 = retry_arg(&p, 0);
4185 case 'G': /* Geometrically increasing intervals */
4186 case 'H': /* Ditto, but with randomness */
4187 rule->p1 = retry_arg(&p, 0);
4188 rule->p2 = retry_arg(&p, 1);
4192 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4196 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4197 (rule->rule != 'F' && rule->p2 < 1000))
4198 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4199 "bad parameters for retry rule");
4201 while (isspace(*p)) p++;
4205 while (isspace(*p)) p++;
4208 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4215 /*************************************************
4216 * Initialize authenticators *
4217 *************************************************/
4219 /* Read the authenticators section of the configuration file.
4228 #ifdef SUPPORT_PIPE_CONNECT
4232 readconf_driver_init(US"authenticator",
4233 (driver_instance **)(&auths), /* chain anchor */
4234 (driver_info *)auths_available, /* available drivers */
4235 sizeof(auth_info), /* size of info block */
4236 &auth_defaults, /* default values for generic options */
4237 sizeof(auth_instance), /* size of instance block */
4238 optionlist_auths, /* generic options */
4239 optionlist_auths_size);
4241 for (auth_instance * au = auths; au; au = au->next)
4243 if (!au->public_name)
4244 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4245 "the %s authenticator", au->name);
4247 for (auth_instance * bu = au->next; bu; bu = bu->next)
4248 if (strcmpic(au->public_name, bu->public_name) == 0)
4249 if ((au->client && bu->client) || (au->server && bu->server))
4250 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4251 "(%s and %s) have the same public name (%s)",
4252 au->client ? US"client" : US"server", au->name, bu->name,
4254 #ifdef SUPPORT_PIPE_CONNECT
4258 #ifdef SUPPORT_PIPE_CONNECT
4259 f.smtp_in_early_pipe_no_auth = nauths > 16;
4266 /*************************************************
4267 * Read ACL information *
4268 *************************************************/
4270 /* If this run of Exim is not doing something that involves receiving a
4271 message, we can just skip over the ACL information. No need to parse it.
4273 First, we have a function for acl_read() to call back to get the next line. We
4274 need to remember the line we passed, because at the end it will contain the
4275 name of the next ACL. */
4277 static uschar *acl_line;
4282 acl_line = get_config_line();
4287 /* Now the main function:
4298 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4301 acl_line = get_config_line();
4309 p = readconf_readname(name, sizeof(name), acl_line);
4310 if (isupper(*name) && *p == '=')
4312 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4313 acl_line = get_config_line();
4317 if (*p != ':' || name[0] == 0)
4318 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4320 node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4321 Ustrcpy(node->name, name);
4322 if (!tree_insertnode(&acl_anchor, node))
4323 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4324 "there are two ACLs called \"%s\"", name);
4326 node->data.ptr = acl_read(acl_callback, &error);
4328 if (node->data.ptr == NULL && error != NULL)
4329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4335 /*************************************************
4336 * Read configuration for local_scan() *
4337 *************************************************/
4339 /* This function is called after "begin local_scan" is encountered in the
4340 configuration file. If the local_scan() function allows for configuration
4341 options, we can process them. Otherwise, we expire in a panic.
4348 local_scan_init(void)
4350 #ifndef LOCAL_SCAN_HAS_OPTIONS
4351 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4352 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4356 while ((p = get_config_line()))
4358 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4359 NULL, US"local_scan option \"%s\" unknown");
4366 /*************************************************
4367 * Read rest of configuration (after main) *
4368 *************************************************/
4370 /* This function reads the rest of the runtime configuration, after the main
4371 configuration. It is called only when actually needed. Each subsequent section
4372 of the configuration starts with a line of the form
4376 where the name is "routers", "transports", etc. A section is terminated by
4377 hitting the next "begin" line, and the next name is left in next_section.
4378 Because it may confuse people as to whether the names are singular or plural,
4379 we add "s" if it's missing. There is always enough room in next_section for
4380 this. This function is basically just a switch.
4386 static uschar *section_list[] = {
4400 while(next_section[0] != 0)
4404 int last = nelem(section_list);
4406 int n = Ustrlen(next_section);
4408 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4412 int c = strcmpic(next_section, section_list[mid]);
4414 if (c > 0) first = mid + 1; else last = mid;
4416 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4417 "\"%.*s\" is not a known configuration section name", n, next_section);
4418 mid = (last + first)/2;
4422 if (((had ^= bit) & bit) == 0)
4423 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4424 "\"%.*s\" section is repeated in the configuration file", n,
4429 case 0: readconf_acl(); break;
4430 case 1: auths_init(); break;
4431 case 2: local_scan_init(); break;
4432 case 3: readconf_retries(); break;
4433 case 4: readconf_rewrites(); break;
4434 case 5: route_init(); break;
4435 case 6: transport_init(); break;
4439 (void)fclose(config_file);
4442 /* Init the storage for the pre-parsed config lines */
4444 readconf_save_config(const uschar *s)
4446 save_config_line(string_sprintf("# Exim Configuration (%s)",
4447 f.running_in_test_harness ? US"X" : s));
4451 save_config_position(const uschar *file, int line)
4453 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4456 /* Append a pre-parsed logical line to the config lines store,
4457 this operates on a global (static) list that holds all the pre-parsed
4458 config lines, we do no further processing here, output formatting and
4459 honouring of <hide> or macros will be done during output */
4462 save_config_line(const uschar* line)
4464 static config_line_item *current;
4465 config_line_item *next;
4467 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4468 next->line = string_copy(line);
4471 if (!config_lines) config_lines = next;
4472 else current->next = next;
4477 /* List the parsed config lines, care about nice formatting and
4478 hide the <hide> values unless we're the admin user */
4480 print_config(BOOL admin, BOOL terse)
4482 const int TS = terse ? 0 : 2;
4485 for (config_line_item * i = config_lines; i; i = i->next)
4490 /* skip over to the first non-space */
4491 for (current = i->line; *current && isspace(*current); ++current)
4494 if (*current == '\0')
4497 /* Collapse runs of spaces. We stop this if we encounter one of the
4498 * following characters: "'$, as this may indicate careful formatting */
4499 for (p = current; *p; ++p)
4502 if (!isspace(*p)) continue;
4503 if (*p != ' ') *p = ' ';
4505 for (next = p; isspace(*next); ++next)
4509 memmove(p+1, next, Ustrlen(next)+1);
4511 if (*next == '"' || *next == '\'' || *next == '$')
4516 if (current[0] == '#')
4519 /* begin lines are left aligned */
4520 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4522 if (!terse) puts("");
4527 /* router/acl/transport block names */
4528 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4530 if (!terse) puts("");
4531 printf("%*s%s\n", TS, "", current);
4535 /* hidden lines (all MACROS or lines prefixed with "hide") */
4537 && ( isupper(*current)
4538 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4542 if ((p = Ustrchr(current, '=')))
4545 printf("%*s%s= %s\n", indent, "", current, hidden);
4547 /* e.g.: hide split_spool_directory */
4549 printf("%*s\n", indent, hidden);
4553 /* rest is public */
4554 printf("%*s%s\n", indent, "", current);
4558 #endif /*!MACRO_PREDEF*/
4561 /* End of readconf.c */