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 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
153 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
154 { "finduser_retries", opt_int, &finduser_retries },
155 { "freeze_tell", opt_stringptr, &freeze_tell },
156 { "gecos_name", opt_stringptr, &gecos_name },
157 { "gecos_pattern", opt_stringptr, &gecos_pattern },
159 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
160 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
162 { "header_line_maxsize", opt_int, &header_line_maxsize },
163 { "header_maxsize", opt_int, &header_maxsize },
164 { "headers_charset", opt_stringptr, &headers_charset },
165 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
166 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
167 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
168 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
169 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
170 { "hold_domains", opt_stringptr, &hold_domains },
171 { "host_lookup", opt_stringptr, &host_lookup },
172 { "host_lookup_order", opt_stringptr, &host_lookup_order },
173 { "host_reject_connection", opt_stringptr, &host_reject_connection },
174 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
176 { "hosts_proxy", opt_stringptr, &hosts_proxy },
178 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
180 { "ibase_servers", opt_stringptr, &ibase_servers },
182 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
183 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
184 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
185 { "keep_environment", opt_stringptr, &keep_environment },
186 { "keep_malformed", opt_time, &keep_malformed },
188 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
189 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
190 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
191 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
192 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
193 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
194 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
195 { "ldap_start_tls", opt_bool, &eldap_start_tls },
196 { "ldap_version", opt_int, &eldap_version },
198 { "local_from_check", opt_bool, &local_from_check },
199 { "local_from_prefix", opt_stringptr, &local_from_prefix },
200 { "local_from_suffix", opt_stringptr, &local_from_suffix },
201 { "local_interfaces", opt_stringptr, &local_interfaces },
202 #ifdef HAVE_LOCAL_SCAN
203 { "local_scan_timeout", opt_time, &local_scan_timeout },
205 { "local_sender_retain", opt_bool, &local_sender_retain },
206 { "localhost_number", opt_stringptr, &host_number_string },
207 { "log_file_path", opt_stringptr, &log_file_path },
208 { "log_selector", opt_stringptr, &log_selector_string },
209 { "log_timezone", opt_bool, &log_timezone },
210 { "lookup_open_max", opt_int, &lookup_open_max },
211 { "max_username_length", opt_int, &max_username_length },
212 { "message_body_newlines", opt_bool, &message_body_newlines },
213 { "message_body_visible", opt_mkint, &message_body_visible },
214 { "message_id_header_domain", opt_stringptr, &message_id_domain },
215 { "message_id_header_text", opt_stringptr, &message_id_text },
216 { "message_logs", opt_bool, &message_logs },
217 { "message_size_limit", opt_stringptr, &message_size_limit },
218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
219 { "move_frozen_messages", opt_bool, &move_frozen_messages },
221 { "mua_wrapper", opt_bool, &mua_wrapper },
223 { "mysql_servers", opt_stringptr, &mysql_servers },
225 { "never_users", opt_uidlist, &never_users },
227 { "openssl_options", opt_stringptr, &openssl_options },
230 { "oracle_servers", opt_stringptr, &oracle_servers },
232 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
234 { "perl_at_start", opt_bool, &opt_perl_at_start },
235 { "perl_startup", opt_stringptr, &opt_perl_startup },
236 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
239 { "pgsql_servers", opt_stringptr, &pgsql_servers },
241 { "pid_file_path", opt_stringptr, &pid_file_path },
242 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
243 #ifdef EXPERIMENTAL_PIPE_CONNECT
244 { "pipelining_connect_advertise_hosts", opt_stringptr,
245 &pipe_connect_advertise_hosts },
248 { "prdr_enable", opt_bool, &prdr_enable },
250 { "preserve_message_logs", opt_bool, &preserve_message_logs },
251 { "primary_hostname", opt_stringptr, &primary_hostname },
252 { "print_topbitchars", opt_bool, &print_topbitchars },
253 { "process_log_path", opt_stringptr, &process_log_path },
254 { "prod_requires_admin", opt_bool, &prod_requires_admin },
255 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
256 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
257 { "queue_domains", opt_stringptr, &queue_domains },
258 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
259 { "queue_only", opt_bool, &queue_only },
260 { "queue_only_file", opt_stringptr, &queue_only_file },
261 { "queue_only_load", opt_fixed, &queue_only_load },
262 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
263 { "queue_only_override", opt_bool, &queue_only_override },
264 { "queue_run_in_order", opt_bool, &queue_run_in_order },
265 { "queue_run_max", opt_stringptr, &queue_run_max },
266 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
267 { "receive_timeout", opt_time, &receive_timeout },
268 { "received_header_text", opt_stringptr, &received_header_text },
269 { "received_headers_max", opt_int, &received_headers_max },
270 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
271 { "recipients_max", opt_int, &recipients_max },
272 { "recipients_max_reject", opt_bool, &recipients_max_reject },
274 { "redis_servers", opt_stringptr, &redis_servers },
276 { "remote_max_parallel", opt_int, &remote_max_parallel },
277 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
278 { "retry_data_expire", opt_time, &retry_data_expire },
279 { "retry_interval_max", opt_time, &retry_interval_max },
280 { "return_path_remove", opt_bool, &return_path_remove },
281 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
282 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
283 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
284 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
285 { "slow_lookup_log", opt_int, &slow_lookup_log },
286 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
287 { "smtp_accept_max", opt_int, &smtp_accept_max },
288 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
289 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
290 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
291 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
292 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
293 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
294 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
295 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
296 { "smtp_banner", opt_stringptr, &smtp_banner },
297 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
298 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
299 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
300 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
301 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
302 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
303 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
304 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
305 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
306 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
307 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
308 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
309 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
310 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
312 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
314 #ifdef WITH_CONTENT_SCAN
315 { "spamd_address", opt_stringptr, &spamd_address },
318 { "spf_guess", opt_stringptr, &spf_guess },
320 { "split_spool_directory", opt_bool, &split_spool_directory },
321 { "spool_directory", opt_stringptr, &spool_directory },
322 { "spool_wireformat", opt_bool, &spool_wireformat },
324 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
326 #ifdef EXPERIMENTAL_SRS
327 { "srs_config", opt_stringptr, &srs_config },
328 { "srs_hashlength", opt_int, &srs_hashlength },
329 { "srs_hashmin", opt_int, &srs_hashmin },
330 { "srs_maxage", opt_int, &srs_maxage },
331 { "srs_secrets", opt_stringptr, &srs_secrets },
332 { "srs_usehash", opt_bool, &srs_usehash },
333 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
335 { "strict_acl_vars", opt_bool, &strict_acl_vars },
336 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
337 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
338 { "syslog_duplication", opt_bool, &syslog_duplication },
339 { "syslog_facility", opt_stringptr, &syslog_facility_str },
340 { "syslog_pid", opt_bool, &syslog_pid },
341 { "syslog_processname", opt_stringptr, &syslog_processname },
342 { "syslog_timestamp", opt_bool, &syslog_timestamp },
343 { "system_filter", opt_stringptr, &system_filter },
344 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
345 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
346 { "system_filter_group", opt_gid, &system_filter_gid },
347 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
348 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
349 { "system_filter_user", opt_uid, &system_filter_uid },
350 { "tcp_nodelay", opt_bool, &tcp_nodelay },
351 #ifdef USE_TCP_WRAPPERS
352 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
354 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
355 { "timezone", opt_stringptr, &timezone_string },
356 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
358 { "tls_certificate", opt_stringptr, &tls_certificate },
359 { "tls_crl", opt_stringptr, &tls_crl },
360 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
361 { "tls_dhparam", opt_stringptr, &tls_dhparam },
362 { "tls_eccurve", opt_stringptr, &tls_eccurve },
363 # ifndef DISABLE_OCSP
364 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
366 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
367 { "tls_privatekey", opt_stringptr, &tls_privatekey },
368 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
369 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
370 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
371 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
372 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
374 { "trusted_groups", opt_gidlist, &trusted_groups },
375 { "trusted_users", opt_uidlist, &trusted_users },
376 { "unknown_login", opt_stringptr, &unknown_login },
377 { "unknown_username", opt_stringptr, &unknown_username },
378 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
379 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
380 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
381 { "warn_message_file", opt_stringptr, &warn_message_file },
382 { "write_rejectlog", opt_bool, &write_rejectlog }
386 static int optionlist_config_size = nelem(optionlist_config);
393 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
398 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
406 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
408 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
410 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
411 builtin_macro_create(buf);
412 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
417 options_logging(void)
421 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
423 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
424 builtin_macro_create(buf);
429 #else /*!MACRO_PREDEF*/
431 extern char **environ;
433 static void save_config_line(const uschar* line);
434 static void save_config_position(const uschar *file, int line);
435 static void print_config(BOOL admin, BOOL terse);
438 #define CSTATE_STACK_SIZE 10
440 const uschar *config_directory = NULL;
443 /* Structure for chain (stack) of .included files */
445 typedef struct config_file_item {
446 struct config_file_item *next;
447 const uschar *filename;
448 const uschar *directory;
453 /* Structure for chain of configuration lines (-bP config) */
455 typedef struct config_line_item {
456 struct config_line_item *next;
460 static config_line_item* config_lines;
462 /* Structure of table of conditional words and their state transitions */
464 typedef struct cond_item {
472 /* Structure of table of syslog facility names and values */
474 typedef struct syslog_fac_item {
480 static const char * const hidden = "<value not displayable>";
482 /* Static variables */
484 static config_file_item *config_file_stack = NULL; /* For includes */
486 static uschar *syslog_facility_str = NULL;
487 static uschar next_section[24];
488 static uschar time_buffer[24];
490 /* State variables for conditional loading (.ifdef / .else / .endif) */
492 static int cstate = 0;
493 static int cstate_stack_ptr = -1;
494 static int cstate_stack[CSTATE_STACK_SIZE];
496 /* Table of state transitions for handling conditional inclusions. There are
497 four possible state transitions:
501 .elifdef true (or .else)
504 .endif just causes the previous cstate to be popped off the stack */
506 static int next_cstate[3][4] =
508 /* State 0: reading from file, or reading until next .else or .endif */
510 /* State 1: condition failed, skipping until next .else or .endif */
512 /* State 2: skipping until .endif */
516 /* Table of conditionals and the states to set. For each name, there are four
517 values: the length of the name (to save computing it each time), the state to
518 set if a macro was found in the line, the state to set if a macro was not found
519 in the line, and a stack manipulation setting which is:
521 -1 pull state value off the stack
522 0 don't alter the stack
523 +1 push value onto stack, before setting new state
526 static cond_item cond_list[] = {
527 { US"ifdef", 5, 0, 1, 1 },
528 { US"ifndef", 6, 1, 0, 1 },
529 { US"elifdef", 7, 2, 3, 0 },
530 { US"elifndef", 8, 3, 2, 0 },
531 { US"else", 4, 2, 2, 0 },
532 { US"endif", 5, 0, 0, -1 }
535 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
537 /* Table of syslog facility names and their values */
539 static syslog_fac_item syslog_list[] = {
540 { US"mail", LOG_MAIL },
541 { US"user", LOG_USER },
542 { US"news", LOG_NEWS },
543 { US"uucp", LOG_UUCP },
544 { US"local0", LOG_LOCAL0 },
545 { US"local1", LOG_LOCAL1 },
546 { US"local2", LOG_LOCAL2 },
547 { US"local3", LOG_LOCAL3 },
548 { US"local4", LOG_LOCAL4 },
549 { US"local5", LOG_LOCAL5 },
550 { US"local6", LOG_LOCAL6 },
551 { US"local7", LOG_LOCAL7 },
552 { US"daemon", LOG_DAEMON }
555 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
558 #define opt_fn_print BIT(0)
559 #define opt_fn_print_label BIT(1)
562 /*************************************************
563 * Find the name of an option *
564 *************************************************/
566 /* This function is to aid debugging. Various functions take arguments that are
567 pointer variables in the options table or in option tables for various drivers.
568 For debugging output, it is useful to be able to find the name of the option
569 which is currently being processed. This function finds it, if it exists, by
570 searching the table(s).
572 Arguments: a value that is presumed to be in the table above
573 Returns: the option name, or an empty string
577 readconf_find_option(void *p)
579 for (int i = 0; i < nelem(optionlist_config); i++)
580 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
582 for (router_instance * r = routers; r; r = r->next)
584 router_info *ri = r->info;
585 for (int i = 0; i < *ri->options_count; i++)
587 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
588 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
589 return US ri->options[i].name;
593 for (transport_instance * t = transports; t; t = t->next)
595 transport_info *ti = t->info;
596 for (int i = 0; i < *ti->options_count; i++)
598 optionlist * op = &ti->options[i];
599 if ((op->type & opt_mask) != opt_stringptr) continue;
600 if (p == ( op->type & opt_public
602 : CS t->options_block
604 + (long int)op->value)
615 /*************************************************
616 * Deal with an assignment to a macro *
617 *************************************************/
619 /* We have a new definition; append to the list.
622 name Name of the macro; will be copied
623 val Expansion result for the macro; will be copied
627 macro_create(const uschar * name, const uschar * val, BOOL command_line)
629 macro_item * m = store_get(sizeof(macro_item));
631 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
633 m->command_line = command_line;
634 m->namelen = Ustrlen(name);
635 m->replen = Ustrlen(val);
636 m->name = string_copy(name);
637 m->replacement = string_copy(val);
649 /* This function is called when a line that starts with an upper case letter is
650 encountered. The argument "line" should contain a complete logical line, and
651 start with the first letter of the macro name. The macro name and the
652 replacement text are extracted and stored. Redefinition of existing,
653 non-command line, macros is permitted using '==' instead of '='.
656 s points to the start of the logical line
658 Returns: FALSE iff fatal error
662 macro_read_assignment(uschar *s)
669 while (isalnum(*s) || *s == '_')
671 if (namelen >= sizeof(name) - 1)
673 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
674 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
677 name[namelen++] = *s++;
681 while (isspace(*s)) s++;
684 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
693 while (isspace(*s)) s++;
695 /* If an existing macro of the same name was defined on the command line, we
696 just skip this definition. It's an error to attempt to redefine a macro without
697 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
698 It is also an error to define a macro whose name begins with the name of a
699 previously defined macro. This is the requirement that make using a tree
700 for macros hard; we must check all macros for the substring. Perhaps a
701 sorted list, and a bsearch, would work?
702 Note: it is documented that the other way round works. */
704 for (m = macros; m; m = m->next)
706 if (Ustrcmp(m->name, name) == 0)
708 if (!m->command_line && !redef)
710 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
711 "defined (use \"==\" if you want to redefine it)", name);
717 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
719 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
720 "a macro because previously defined macro \"%s\" is a substring",
725 /* We cannot have this test, because it is documented that a substring
726 macro is permitted (there is even an example).
728 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
729 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
730 * "a macro because it is a substring of previously defined macro \"%s\"",
735 /* Check for an overriding command-line definition. */
737 if (m && m->command_line) return TRUE;
739 /* Redefinition must refer to an existing macro. */
744 m->replen = Ustrlen(s);
745 m->replacement = string_copy(s);
749 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
754 /* We have a new definition. */
756 (void) macro_create(name, s, FALSE);
764 /* Process line for macros. The line is in big_buffer starting at offset len.
765 Expand big_buffer if needed. Handle definitions of new macros, and
766 macro expansions, rewriting the line in the buffer.
769 len Offset in buffer of start of line
770 newlen Pointer to offset of end of line, updated on return
771 macro_found Pointer to return that a macro was expanded
773 Return: pointer to first nonblank char in line
777 macros_expand(int len, int * newlen, BOOL * macro_found)
779 uschar * ss = big_buffer + len;
782 /* Find the true start of the physical line - leading spaces are always
785 while (isspace(*ss)) ss++;
787 /* Process the physical line for macros. If this is the start of the logical
788 line, skip over initial text at the start of the line if it starts with an
789 upper case character followed by a sequence of name characters and an equals
790 sign, because that is the definition of a new macro, and we don't do
791 replacement therein. */
794 if (len == 0 && isupper(*s))
796 while (isalnum(*s) || *s == '_') s++;
797 while (isspace(*s)) s++;
798 if (*s != '=') s = ss; /* Not a macro definition */
801 /* Skip leading chars which cannot start a macro name, to avoid multiple
802 pointless rescans in Ustrstr calls. */
804 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
806 /* For each defined macro, scan the line (from after XXX= if present),
807 replacing all occurrences of the macro. */
809 *macro_found = FALSE;
810 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
815 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
819 while ((p = Ustrstr(t, m->name)) != NULL)
823 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
824 m->name, (int) Ustrlen(ss)-1, ss);
825 /* Expand the buffer if necessary */
827 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
829 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
830 uschar *newbuffer = store_malloc(newsize);
831 memcpy(newbuffer, big_buffer, *newlen + 1);
832 p = newbuffer + (p - big_buffer);
833 s = newbuffer + (s - big_buffer);
834 ss = newbuffer + (ss - big_buffer);
835 t = newbuffer + (t - big_buffer);
836 big_buffer_size = newsize;
837 store_free(big_buffer);
838 big_buffer = newbuffer;
841 /* Shuffle the remaining characters up or down in the buffer before
842 copying in the replacement text. Don't rescan the replacement for this
846 if ((moveby = m->replen - m->namelen) != 0)
848 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
851 Ustrncpy(p, m->replacement, m->replen);
853 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
858 /* An empty macro replacement at the start of a line could mean that ss no
859 longer points to the first non-blank character. */
861 while (isspace(*ss)) ss++;
865 /*************************************************
866 * Read configuration line *
867 *************************************************/
869 /* A logical line of text is read from the configuration file into the big
870 buffer, taking account of macros, .includes, and continuations. The size of
871 big_buffer is increased if necessary. The count of configuration lines is
872 maintained. Physical input lines starting with # (ignoring leading white space,
873 and after macro replacement) and empty logical lines are always ignored.
874 Leading and trailing spaces are removed.
876 If we hit a line of the form "begin xxxx", the xxxx is placed in the
877 next_section vector, and the function returns NULL, indicating the end of a
878 configuration section. On end-of-file, NULL is returned with next_section
883 Returns: a pointer to the first non-blank in the line,
884 or NULL if eof or end of section is reached
888 get_config_line(void)
890 int startoffset = 0; /* To first non-blank char in logical line */
891 int len = 0; /* Of logical line so far */
896 /* Loop for handling continuation lines, skipping comments, and dealing with
901 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
903 if (config_file_stack != NULL) /* EOF inside .include */
905 (void)fclose(config_file);
906 config_file = config_file_stack->file;
907 config_filename = config_file_stack->filename;
908 config_directory = config_file_stack->directory;
909 config_lineno = config_file_stack->lineno;
910 config_file_stack = config_file_stack->next;
912 save_config_position(config_filename, config_lineno);
916 /* EOF at top level */
918 if (cstate_stack_ptr >= 0)
919 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
920 "Unexpected end of configuration file: .endif missing");
922 if (len != 0) break; /* EOF after continuation */
923 next_section[0] = 0; /* EOF at start of logical line */
928 newlen = len + Ustrlen(big_buffer + len);
930 if (config_lines && config_lineno == 1)
931 save_config_position(config_filename, config_lineno);
933 /* Handle pathologically long physical lines - yes, it did happen - by
934 extending big_buffer at this point. The code also copes with very long
937 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
940 big_buffer_size += BIG_BUFFER_SIZE;
941 newbuffer = store_malloc(big_buffer_size);
943 /* This use of strcpy is OK because we know that the string in the old
944 buffer is shorter than the new buffer. */
946 Ustrcpy(newbuffer, big_buffer);
947 store_free(big_buffer);
948 big_buffer = newbuffer;
949 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
951 newlen += Ustrlen(big_buffer + newlen);
954 ss = macros_expand(len, &newlen, ¯o_found);
956 /* Check for comment lines - these are physical lines. */
958 if (*ss == '#') continue;
960 /* Handle conditionals, which are also applied to physical lines. Conditions
961 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
962 expansion occurred on the rest of the line. A preliminary test for the leading
963 '.' saves effort on most lines. */
969 /* Search the list of conditional directives */
971 for (i = 0; i < cond_list_size; i++)
974 cond_item *c = cond_list+i;
975 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
977 /* The following character must be white space or end of string */
979 n = ss[1 + c->namelen];
980 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
982 /* .ifdef and .ifndef push the current state onto the stack, then set
983 a new one from the table. Stack overflow is an error */
987 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
989 ".%s nested too deeply", c->name);
990 cstate_stack[++cstate_stack_ptr] = cstate;
991 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
994 /* For any of the others, stack underflow is an error. The next state
995 comes either from the stack (.endif) or from the table. */
999 if (cstate_stack_ptr < 0)
1000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1001 ".%s without matching .ifdef", c->name);
1002 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1003 next_cstate[cstate][macro_found? c->action1 : c->action2];
1006 /* Having dealt with a directive, break the loop */
1011 /* If we have handled a conditional directive, continue with the next
1012 physical line. Otherwise, fall through. */
1014 if (i < cond_list_size) continue;
1017 /* If the conditional state is not 0 (actively using these lines), ignore
1020 if (cstate != 0) continue; /* Conditional skip */
1022 /* Handle .include lines - these are also physical lines. */
1024 if (Ustrncmp(ss, ".include", 8) == 0 &&
1026 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1029 int include_if_exists = isspace(ss[8])? 0 : 10;
1030 config_file_item *save;
1031 struct stat statbuf;
1033 ss += 9 + include_if_exists;
1034 while (isspace(*ss)) ss++;
1035 t = ss + Ustrlen(ss);
1036 while (t > ss && isspace(t[-1])) t--;
1037 if (*ss == '\"' && t[-1] == '\"')
1044 /* We allow relative file names. For security reasons currently
1045 relative names not allowed with .include_if_exists. For .include_if_exists
1046 we need to check the permissions/ownership of the containing folder */
1048 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1049 "absolute path \"%s\"", ss);
1052 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1053 ss = string_from_gstring(g);
1056 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1059 save_config_position(config_filename, config_lineno);
1060 save = store_get(sizeof(config_file_item));
1061 save->next = config_file_stack;
1062 config_file_stack = save;
1063 save->file = config_file;
1064 save->filename = config_filename;
1065 save->directory = config_directory;
1066 save->lineno = config_lineno;
1068 if (!(config_file = Ufopen(ss, "rb")))
1069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1070 "configuration file %s", ss);
1072 config_filename = string_copy(ss);
1073 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1078 /* If this is the start of the logical line, remember where the non-blank
1079 data starts. Otherwise shuffle down continuation lines to remove leading
1083 startoffset = ss - big_buffer;
1086 s = big_buffer + len;
1089 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1094 /* Accept the new addition to the line. Remove trailing white space. */
1097 while (len > 0 && isspace(big_buffer[len-1])) len--;
1098 big_buffer[len] = 0;
1100 /* We are done if the line does not end in backslash and contains some data.
1101 Empty logical lines are ignored. For continuations, remove the backslash and
1102 go round the loop to read the continuation line. */
1106 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1107 big_buffer[--len] = 0; /* Remove backslash */
1109 } /* Loop for reading multiple physical lines */
1111 /* We now have a logical line. Test for the end of a configuration section (or,
1112 more accurately, for the start of the next section). Place the name of the next
1113 section in next_section, and return NULL. If the name given is longer than
1114 next_section, truncate it. It will be unrecognized later, because all the known
1115 section names do fit. Leave space for pluralizing. */
1117 s = big_buffer + startoffset; /* First non-space character */
1120 save_config_line(s);
1122 if (strncmpic(s, US"begin ", 6) == 0)
1125 while (isspace(*s)) s++;
1126 if (big_buffer + len - s > sizeof(next_section) - 2)
1127 s[sizeof(next_section) - 2] = 0;
1128 Ustrcpy(next_section, s);
1132 /* Return the first non-blank character. */
1139 /*************************************************
1141 *************************************************/
1143 /* The yield is the pointer to the next uschar. Names longer than the
1144 output space are silently truncated. This function is also used from acl.c when
1148 name where to put the name
1152 Returns: new input pointer
1156 readconf_readname(uschar *name, int len, uschar *s)
1159 while (isspace(*s)) s++;
1162 while (isalnum(*s) || *s == '_')
1164 if (p < len-1) name[p++] = *s;
1169 while (isspace(*s)) s++;
1176 /*************************************************
1177 * Read a time value *
1178 *************************************************/
1180 /* This function is also called from outside, to read argument
1181 time values. The format of a time value is:
1183 [<n>w][<n>d][<n>h][<n>m][<n>s]
1185 as long as at least one is present. If a format error is encountered,
1186 return a negative value. The value must be terminated by the given
1191 terminator required terminating character
1192 return_msec if TRUE, allow fractional seconds and return milliseconds
1194 Returns: the time value, or -1 on syntax error
1195 value is seconds if return_msec is FALSE
1196 value is milliseconds if return_msec is TRUE
1200 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1208 if (!isdigit(*s)) return -1;
1209 (void)sscanf(CCS s, "%d%n", &value, &count);
1214 case 'w': value *= 7;
1215 case 'd': value *= 24;
1216 case 'h': value *= 60;
1217 case 'm': value *= 60;
1222 if (!return_msec) return -1;
1223 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1225 if (*s++ != 's') return -1;
1226 yield += (int)(fraction * 1000.0);
1232 if (return_msec) value *= 1000;
1234 if (*s == terminator) return yield;
1236 /* Control never reaches here. */
1241 /*************************************************
1242 * Read a fixed point value *
1243 *************************************************/
1245 /* The value is returned *1000
1249 terminator required terminator
1251 Returns: the value, or -1 on error
1255 readconf_readfixed(const uschar *s, int terminator)
1259 if (!isdigit(*s)) return -1;
1260 (void)sscanf(CS s, "%d%n", &value, &count);
1262 yield = value * 1000;
1266 while (isdigit((*(++s))))
1268 yield += (*s - '0') * m;
1273 return (*s == terminator)? yield : (-1);
1278 /*************************************************
1279 * Find option in list *
1280 *************************************************/
1282 /* The lists are always in order, so binary chop can be used.
1285 name the option name to search for
1286 ol the first entry in the option list
1287 last one more than the offset of the last entry in the option list
1289 Returns: pointer to an option entry, or NULL if not found
1293 find_option(uschar *name, optionlist *ol, int last)
1296 while (last > first)
1298 int middle = (first + last)/2;
1299 int c = Ustrcmp(name, ol[middle].name);
1301 if (c == 0) return ol + middle;
1302 else if (c > 0) first = middle + 1;
1310 /*************************************************
1311 * Find a set flag in option list *
1312 *************************************************/
1314 /* Because some versions of Unix make no restrictions on the values of uids and
1315 gids (even negative ones), we cannot represent "unset" by a special value.
1316 There is therefore a separate boolean variable for each one indicating whether
1317 a value is set or not. This function returns a pointer to the boolean, given
1318 the original option name. It is a major disaster if the flag cannot be found.
1321 name the name of the uid or gid option
1322 oltop points to the start of the relevant option list
1323 last one more than the offset of the last item in the option list
1324 data_block NULL when reading main options => data values in the option
1325 list are absolute addresses; otherwise they are byte offsets
1326 in data_block (used for driver options)
1328 Returns: a pointer to the boolean flag.
1332 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1336 sprintf(CS name2, "*set_%.50s", name);
1337 ol = find_option(name2, oltop, last);
1338 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1339 "Exim internal error: missing set flag for %s", name);
1340 return (data_block == NULL)? (BOOL *)(ol->value) :
1341 (BOOL *)(US data_block + (long int)(ol->value));
1347 /*************************************************
1348 * Output extra characters message and die *
1349 *************************************************/
1351 /* Called when an option line has junk on the end. Sometimes this is because
1352 the sysadmin thinks comments are permitted.
1355 s points to the extra characters
1356 t1..t3 strings to insert in the log message
1358 Returns: doesn't return; dies
1362 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1364 uschar *comment = US"";
1365 if (*s == '#') comment = US" (# is comment only at line start)";
1366 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1367 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1372 /*************************************************
1373 * Read rewrite information *
1374 *************************************************/
1376 /* Each line of rewrite information contains:
1378 . A complete address in the form user@domain, possibly with
1379 leading * for each part; or alternatively, a regex.
1381 . A replacement string (which will be expanded).
1383 . An optional sequence of one-letter flags, indicating which
1384 headers etc. to apply this rule to.
1386 All this is decoded and placed into a control block. The OR of the flags is
1387 maintained in a common word.
1390 p points to the string that makes up the rule
1391 existflags points to the overall flag word
1392 isglobal TRUE if reading global rewrite rules
1394 Returns: the control block for the parsed rule.
1397 static rewrite_rule *
1398 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1400 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1403 next->key = string_dequote(&p);
1405 while (isspace(*p)) p++;
1407 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1408 "missing rewrite replacement string");
1411 next->replacement = string_dequote(&p);
1413 while (*p != 0) switch (*p++)
1415 case ' ': case '\t': break;
1417 case 'q': next->flags |= rewrite_quit; break;
1418 case 'w': next->flags |= rewrite_whole; break;
1420 case 'h': next->flags |= rewrite_all_headers; break;
1421 case 's': next->flags |= rewrite_sender; break;
1422 case 'f': next->flags |= rewrite_from; break;
1423 case 't': next->flags |= rewrite_to; break;
1424 case 'c': next->flags |= rewrite_cc; break;
1425 case 'b': next->flags |= rewrite_bcc; break;
1426 case 'r': next->flags |= rewrite_replyto; break;
1428 case 'E': next->flags |= rewrite_all_envelope; break;
1429 case 'F': next->flags |= rewrite_envfrom; break;
1430 case 'T': next->flags |= rewrite_envto; break;
1432 case 'Q': next->flags |= rewrite_qualify; break;
1433 case 'R': next->flags |= rewrite_repeat; break;
1436 next->flags |= rewrite_smtp;
1437 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1438 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1439 "rewrite rule has the S flag but is not a regular expression");
1443 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1444 "unknown rewrite flag character '%c' "
1445 "(could be missing quotes round replacement item)", p[-1]);
1449 /* If no action flags are set, set all the "normal" rewrites. */
1451 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1452 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1454 /* Remember which exist, for optimization, and return the rule */
1456 *existflags |= next->flags;
1463 /*************************************************
1464 * Read global rewrite information *
1465 *************************************************/
1467 /* Each line is a single rewrite rule; it is parsed into a control block
1468 by readconf_one_rewrite(), and its flags are ORed into the global flag
1469 word rewrite_existflags. */
1472 readconf_rewrites(void)
1474 rewrite_rule **chain = &global_rewrite_rules;
1477 while ((p = get_config_line()) != NULL)
1479 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1481 chain = &(next->next);
1487 /*************************************************
1489 *************************************************/
1491 /* Strings are read into the normal store pool. As long we aren't too
1492 near the end of the current block, the string will just use what is necessary
1493 on the top of the stacking pool, because string_cat() uses the extension
1497 s the rest of the input line
1498 name the option name (for errors)
1500 Returns: pointer to the string
1504 read_string(const uschar *s, const uschar *name)
1509 if (*s != '\"') return string_copy(s);
1512 yield = string_dequote(&s);
1514 if (s == ss+1 || s[-1] != '\"')
1515 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1516 "missing quote at end of string value for %s", name);
1518 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1524 /*************************************************
1525 * Custom-handler options *
1526 *************************************************/
1528 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1530 if (flags & opt_fn_print)
1532 if (flags & opt_fn_print_label) printf("%s = ", name);
1533 printf("%s\n", smtp_receive_timeout_s
1534 ? string_printing2(smtp_receive_timeout_s, FALSE)
1535 : readconf_printtime(smtp_receive_timeout));
1537 else if (*str == '$')
1538 smtp_receive_timeout_s = string_copy(str);
1541 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1542 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1543 if (smtp_receive_timeout < 0)
1544 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1549 /*************************************************
1550 * Handle option line *
1551 *************************************************/
1553 /* This function is called from several places to process a line containing the
1554 setting of an option. The first argument is the line to be decoded; it has been
1555 checked not to be empty and not to start with '#'. Trailing newlines and white
1556 space have been removed. The second argument is a pointer to the list of
1557 variable names that are to be recognized, together with their types and
1558 locations, and the third argument gives the number of entries in the list.
1560 The fourth argument is a pointer to a data block. If it is NULL, then the data
1561 values in the options list are absolute addresses. Otherwise, they are byte
1562 offsets in the data block.
1564 String option data may continue onto several lines; this function reads further
1565 data from config_file if necessary.
1567 The yield of this function is normally zero. If a string continues onto
1568 multiple lines, then the data value is permitted to be followed by a comma
1569 or a semicolon (for use in drivers) and the yield is that character.
1572 buffer contains the configuration line to be handled
1573 oltop points to the start of the relevant option list
1574 last one more than the offset of the last item in the option list
1575 data_block NULL when reading main options => data values in the option
1576 list are absolute addresses; otherwise they are byte offsets
1577 in data_block when they have opt_public set; otherwise
1578 they are byte offsets in data_block->options_block.
1579 unknown_txt format string to use in panic message for unknown option;
1580 must contain %s for option name
1581 if given as NULL, don't panic on unknown option
1583 Returns: TRUE if an option was read successfully,
1584 FALSE false for an unknown option if unknown_txt == NULL,
1585 otherwise panic and die on an unknown option
1589 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1590 void *data_block, uschar *unknown_txt)
1594 int count, type, value;
1598 BOOL boolvalue = TRUE;
1599 BOOL freesptr = TRUE;
1600 optionlist *ol, *ol2;
1604 uschar *inttype = US"";
1607 uschar **str_target;
1611 /* There may be leading spaces; thereafter, we expect an option name starting
1614 while (isspace(*s)) s++;
1616 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1618 /* Read the name of the option, and skip any subsequent white space. If
1619 it turns out that what we read was "hide", set the flag indicating that
1620 this is a secure option, and loop to read the next word. */
1622 for (int n = 0; n < 2; n++)
1624 while (isalnum(*s) || *s == '_')
1626 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1630 while (isspace(*s)) s++;
1631 if (Ustrcmp(name, "hide") != 0) break;
1632 issecure = opt_secure;
1636 /* Deal with "no_" or "not_" here for booleans */
1638 if (Ustrncmp(name, "no_", 3) == 0)
1644 if (Ustrncmp(name, "not_", 4) == 0)
1650 /* Search the list for the given name. A non-existent name, or an option that
1651 is set twice, is a disaster. */
1653 if (!(ol = find_option(name + offset, oltop, last)))
1655 if (unknown_txt == NULL) return FALSE;
1656 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1659 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1661 "\"%s\" option set for the second time", name);
1663 ol->type |= opt_set | issecure;
1664 type = ol->type & opt_mask;
1666 /* Types with data values must be followed by '='; the "no[t]_" prefix
1667 applies only to boolean values. */
1669 if (type < opt_bool || type > opt_bool_last)
1672 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1673 "negation prefix applied to a non-boolean option");
1675 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1676 "unexpected end of line (data missing) after %s", name);
1678 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1681 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1682 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1683 ultimately expands to one of those values. */
1685 else if (*s != 0 && (offset != 0 || *s != '='))
1686 extra_chars_error(s, US"boolean option ", name, US"");
1688 /* Skip white space after = */
1690 if (*s == '=') while (isspace((*(++s))));
1692 /* If there is a data block and the opt_public flag is not set, change
1693 the data block pointer to the private options block. */
1695 if (data_block != NULL && (ol->type & opt_public) == 0)
1696 data_block = (void *)(((driver_instance *)data_block)->options_block);
1698 /* Now get the data according to the type. */
1702 /* If a string value is not enclosed in quotes, it consists of
1703 the rest of the current line, verbatim. Otherwise, string escapes
1706 A transport is specified as a string, which is then looked up in the
1707 list of transports. A search type is specified as one of a number of
1710 A set or rewrite rules for a driver is specified as a string, which is
1711 then parsed into a suitable chain of control blocks.
1713 Uids and gids are specified as strings which are then looked up in the
1714 passwd file. Lists of uids and gids are similarly specified as colon-
1715 separated strings. */
1720 case opt_expand_uid:
1721 case opt_expand_gid:
1726 reset_point = sptr = read_string(s, name);
1728 /* Having read a string, we now have several different ways of using it,
1729 depending on the data type, so do another switch. If keeping the actual
1730 string is not required (because it is interpreted), freesptr is set TRUE,
1731 and at the end we reset the pool. */
1735 /* If this was a string, set the variable to point to the new string,
1736 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1737 rules, we still keep the string (for printing), and parse the rules into a
1738 control block and flags word. */
1741 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1743 if (ol->type & opt_rep_con)
1745 uschar * saved_condition;
1746 /* We already have a condition, we're conducting a crude hack to let
1747 multiple condition rules be chained together, despite storing them in
1749 *str_target = string_copy_malloc( (saved_condition = *str_target)
1750 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1751 saved_condition, sptr)
1753 /* TODO(pdp): there is a memory leak here and just below
1754 when we set 3 or more conditions; I still don't
1755 understand the store mechanism enough to know
1756 what's the safe way to free content from an earlier store.
1757 AFAICT, stores stack, so freeing an early stored item also stores
1758 all data alloc'd after it. If we knew conditions were adjacent,
1759 we could survive that, but we don't. So I *think* we need to take
1760 another bit from opt_type to indicate "malloced"; this seems like
1761 quite a hack, especially for this one case. It also means that
1762 we can't ever reclaim the store from the *first* condition.
1764 Because we only do this once, near process start-up, I'm prepared to
1765 let this slide for the time being, even though it rankles. */
1767 else if (ol->type & opt_rep_str)
1769 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1770 int sep_i = -(int)sep_o;
1771 const uschar * list = sptr;
1773 gstring * list_o = NULL;
1777 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1778 list_o = string_cat(list_o, *str_target);
1781 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1782 list_o = string_append_listele(list_o, sep_o, s);
1785 *str_target = string_copy_malloc(string_from_gstring(list_o));
1796 *USS (US data_block + (long int)(ol->value)) = sptr;
1798 *USS (ol->value) = sptr;
1800 if (type == opt_rewrite)
1805 rewrite_rule **chain;
1808 sprintf(CS name2, "*%.50s_rules", name);
1809 ol2 = find_option(name2, oltop, last);
1810 sprintf(CS name2, "*%.50s_flags", name);
1811 ol3 = find_option(name2, oltop, last);
1813 if (ol2 == NULL || ol3 == NULL)
1814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1815 "rewrite rules not available for driver");
1817 if (data_block == NULL)
1819 chain = (rewrite_rule **)(ol2->value);
1820 flagptr = (int *)(ol3->value);
1824 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1825 flagptr = (int *)(US data_block + (long int)(ol3->value));
1828 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1830 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1832 chain = &(next->next);
1835 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1836 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1837 "non-header rewrite - not allowed at transport time -");
1841 /* If it was an expanded uid, see if there is any expansion to be
1842 done by checking for the presence of a $ character. If there is, save it
1843 in the corresponding *expand_user option field. Otherwise, fall through
1844 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1847 case opt_expand_uid:
1848 sprintf(CS name2, "*expand_%.50s", name);
1849 ol2 = find_option(name2, oltop, last);
1852 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1854 if (data_block == NULL)
1855 *((uschar **)(ol2->value)) = ss;
1857 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1861 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1867 /* Look up a fixed uid, and also make use of the corresponding gid
1868 if a passwd entry is returned and the gid has not been set. */
1871 if (!route_finduser(sptr, &pw, &uid))
1872 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1873 if (data_block == NULL)
1874 *((uid_t *)(ol->value)) = uid;
1876 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1878 /* Set the flag indicating a fixed value is set */
1880 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1882 /* Handle matching gid if we have a passwd entry: done by finding the
1883 same name with terminating "user" changed to "group"; if not found,
1884 ignore. Also ignore if the value is already set. */
1886 if (pw == NULL) break;
1887 Ustrcpy(name+Ustrlen(name)-4, "group");
1888 ol2 = find_option(name, oltop, last);
1889 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1890 (ol2->type & opt_mask) == opt_expand_gid))
1892 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1895 if (data_block == NULL)
1896 *((gid_t *)(ol2->value)) = pw->pw_gid;
1898 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1904 /* If it was an expanded gid, see if there is any expansion to be
1905 done by checking for the presence of a $ character. If there is, save it
1906 in the corresponding *expand_user option field. Otherwise, fall through
1907 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1910 case opt_expand_gid:
1911 sprintf(CS name2, "*expand_%.50s", name);
1912 ol2 = find_option(name2, oltop, last);
1915 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1917 if (data_block == NULL)
1918 *((uschar **)(ol2->value)) = ss;
1920 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1924 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1930 /* Handle freestanding gid */
1933 if (!route_findgroup(sptr, &gid))
1934 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1935 if (data_block == NULL)
1936 *((gid_t *)(ol->value)) = gid;
1938 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1939 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1942 /* If it was a uid list, look up each individual entry, and build
1943 a vector of uids, with a count in the first element. Put the vector
1944 in malloc store so we can free the string. (We are reading into
1945 permanent store already.) */
1953 const uschar *op = expand_string (sptr);
1956 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1957 name, expand_string_message);
1960 if (*p != 0) count++;
1961 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1962 list = store_malloc(count*sizeof(uid_t));
1963 list[ptr++] = (uid_t)(count - 1);
1965 if (data_block == NULL)
1966 *((uid_t **)(ol->value)) = list;
1968 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1974 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1975 if (!route_finduser(big_buffer, NULL, &uid))
1976 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1983 /* If it was a gid list, look up each individual entry, and build
1984 a vector of gids, with a count in the first element. Put the vector
1985 in malloc store so we can free the string. (We are reading into permanent
1994 const uschar *op = expand_string (sptr);
1997 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1998 name, expand_string_message);
2001 if (*p != 0) count++;
2002 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2003 list = store_malloc(count*sizeof(gid_t));
2004 list[ptr++] = (gid_t)(count - 1);
2006 if (data_block == NULL)
2007 *((gid_t **)(ol->value)) = list;
2009 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2015 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2016 if (!route_findgroup(big_buffer, &gid))
2017 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2025 /* Release store if the value of the string doesn't need to be kept. */
2027 if (freesptr) store_reset(reset_point);
2030 /* Expanded boolean: if no characters follow, or if there are no dollar
2031 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2032 save the string for later expansion in the alternate place. */
2034 case opt_expand_bool:
2035 if (*s != 0 && Ustrchr(s, '$') != 0)
2037 sprintf(CS name2, "*expand_%.50s", name);
2038 ol2 = find_option(name2, oltop, last);
2041 reset_point = sptr = read_string(s, name);
2042 if (data_block == NULL)
2043 *((uschar **)(ol2->value)) = sptr;
2045 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2052 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2053 look for yes/not/true/false. Some booleans are stored in a single bit in
2054 a single int. There's a special fudge for verify settings; without a suffix
2055 they set both xx_sender and xx_recipient. The table points to the sender
2056 value; search subsequently for the recipient. There's another special case:
2057 opt_bool_set also notes when a boolean has been set. */
2061 case opt_bool_verify:
2065 s = readconf_readname(name2, 64, s);
2066 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2068 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2070 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2071 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2072 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2073 US"for boolean option ", name);
2076 /* Handle single-bit type. */
2078 if (type == opt_bit)
2080 int bit = 1 << ((ol->type >> 16) & 31);
2081 int *ptr = (data_block == NULL)?
2082 (int *)(ol->value) :
2083 (int *)(US data_block + (long int)ol->value);
2084 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2088 /* Handle full BOOL types */
2090 if (data_block == NULL)
2091 *((BOOL *)(ol->value)) = boolvalue;
2093 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2097 if (type == opt_bool_verify)
2099 sprintf(CS name2, "%.50s_recipient", name + offset);
2100 ol2 = find_option(name2, oltop, last);
2103 if (data_block == NULL)
2104 *((BOOL *)(ol2->value)) = boolvalue;
2106 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2110 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2112 else if (type == opt_bool_set)
2114 sprintf(CS name2, "*set_%.50s", name + offset);
2115 ol2 = find_option(name2, oltop, last);
2118 if (data_block == NULL)
2119 *((BOOL *)(ol2->value)) = TRUE;
2121 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2130 inttype = US"octal ";
2132 /* Integer: a simple(ish) case; allow octal and hex formats, and
2133 suffixes K, M, G, and T. The different types affect output, not input. */
2142 lvalue = strtol(CS s, CSS &endptr, intbase);
2145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2148 if (errno != ERANGE && *endptr)
2150 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2152 if ((mp = Ustrchr(mp, *endptr)))
2157 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2168 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2169 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2170 "absolute value of integer \"%s\" is too large (overflow)", s);
2172 while (isspace(*endptr)) endptr++;
2174 extra_chars_error(endptr, inttype, US"integer value for ", name);
2176 value = (int)lvalue;
2180 *(int *)(US data_block + (long int)ol->value) = value;
2182 *(int *)ol->value = value;
2185 /* Integer held in K: again, allow formats and suffixes as above. */
2191 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2194 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2197 if (errno != ERANGE && *endptr)
2199 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2201 if ((mp = Ustrchr(mp, *endptr)))
2206 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2215 lvalue = (lvalue + 512)/1024;
2218 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2219 "absolute value of integer \"%s\" is too large (overflow)", s);
2221 while (isspace(*endptr)) endptr++;
2223 extra_chars_error(endptr, inttype, US"integer value for ", name);
2226 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2228 *(int_eximarith_t *)ol->value = lvalue;
2232 /* Fixed-point number: held to 3 decimal places. */
2235 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2236 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2237 "fixed-point number expected for %s", name);
2239 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2240 "integer \"%s\" is too large (overflow)", s);
2244 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2245 "integer \"%s\" is too large (overflow)", s);
2247 /* We get a coverity error here for using count, as it derived
2248 from the tainted buffer pointed to by s, as parsed by sscanf().
2249 By the definition of sscanf we must be accessing between start
2250 and end of s (assuming it is nul-terminated...) so ignore the error. */
2251 /* coverity[tainted_data] */
2252 if (s[count] == '.')
2255 while (isdigit(s[++count]))
2257 value += (s[count] - '0') * d;
2262 while (isspace(s[count])) count++;
2265 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2267 if (data_block == NULL)
2268 *((int *)(ol->value)) = value;
2270 *((int *)(US data_block + (long int)(ol->value))) = value;
2273 /* There's a special routine to read time values. */
2276 value = readconf_readtime(s, 0, FALSE);
2278 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2280 if (data_block == NULL)
2281 *((int *)(ol->value)) = value;
2283 *((int *)(US data_block + (long int)(ol->value))) = value;
2286 /* A time list is a list of colon-separated times, with the first
2287 element holding the size of the list and the second the number of
2293 int *list = (data_block == NULL)?
2294 (int *)(ol->value) :
2295 (int *)(US data_block + (long int)(ol->value));
2297 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2300 uschar *snext = Ustrchr(s, ':');
2304 while (ss > s && isspace(ss[-1])) ss--;
2307 value = readconf_readtime(s, terminator, FALSE);
2309 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2311 if (count > 1 && value <= list[count])
2312 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2313 "time value out of order for %s", name);
2314 list[count+1] = value;
2315 if (snext == NULL) break;
2317 while (isspace(*s)) s++;
2320 if (count > list[0] - 2)
2321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2323 if (count > 0 && list[2] == 0) count = 0;
2330 void (*fn)() = ol->value;
2341 /*************************************************
2342 * Print a time value *
2343 *************************************************/
2346 Argument: a time value in seconds
2347 Returns: pointer to a fixed buffer containing the time as a string,
2348 in readconf_readtime() format
2352 readconf_printtime(int t)
2355 uschar *p = time_buffer;
2372 if (w > 0) p += sprintf(CS p, "%dw", w);
2373 if (d > 0) p += sprintf(CS p, "%dd", d);
2374 if (h > 0) p += sprintf(CS p, "%dh", h);
2375 if (m > 0) p += sprintf(CS p, "%dm", m);
2376 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2383 /*************************************************
2384 * Print an individual option value *
2385 *************************************************/
2387 /* This is used by the -bP option, so prints to the standard output.
2388 The entire options list is passed in as an argument, because some options come
2389 in pairs - typically uid/gid settings, which can either be explicit numerical
2390 values, or strings to be expanded later. If the numerical value is unset,
2391 search for "*expand_<name>" to see if there is a string equivalent.
2394 ol option entry, or NULL for an unknown option
2396 options_block NULL for main configuration options; otherwise points to
2397 a driver block; if the option doesn't have opt_public
2398 set, then options_block->options_block is where the item
2400 oltop points to the option list in which ol exists
2401 last one more than the offset of the last entry in optop
2402 no_labels do not show "foo = " at the start.
2404 Returns: boolean success
2408 print_ol(optionlist *ol, uschar *name, void *options_block,
2409 optionlist *oltop, int last, BOOL no_labels)
2422 printf("%s is not a known option\n", name);
2426 /* Non-admin callers cannot see options that have been flagged secure by the
2429 if (!f.admin_user && ol->type & opt_secure)
2432 printf("%s\n", hidden);
2434 printf("%s = %s\n", name, hidden);
2438 /* Else show the value of the option */
2443 if (!(ol->type & opt_public))
2444 options_block = (void *)(((driver_instance *)options_block)->options_block);
2445 value = (void *)(US options_block + (long int)value);
2448 switch(ol->type & opt_mask)
2451 case opt_rewrite: /* Show the text value */
2453 if (!no_labels) printf("%s = ", name);
2454 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2458 if (!no_labels) printf("%s = ", name);
2459 printf("%d\n", *((int *)value));
2464 int x = *((int *)value);
2465 if (x != 0 && (x & 1023) == 0)
2469 if ((x & 1023) == 0)
2474 if (!no_labels) printf("%s = ", name);
2475 printf("%d%c\n", x, c);
2479 if (!no_labels) printf("%s = ", name);
2487 int_eximarith_t x = *((int_eximarith_t *)value);
2488 if (!no_labels) printf("%s = ", name);
2489 if (x == 0) printf("0\n");
2490 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2491 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2492 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2493 else printf(PR_EXIM_ARITH "K\n", x);
2498 if (!no_labels) printf("%s = ", name);
2499 printf("%#o\n", *((int *)value));
2502 /* Can be negative only when "unset", in which case integer */
2506 int x = *((int *)value);
2509 if (x < 0) printf("%s =\n", name); else
2511 if (!no_labels) printf("%s = ", name);
2512 printf("%d.", x/1000);
2525 /* If the numerical value is unset, try for the string value */
2527 case opt_expand_uid:
2528 if (! *get_set_flag(name, oltop, last, options_block))
2530 sprintf(CS name2, "*expand_%.50s", name);
2531 if ((ol2 = find_option(name2, oltop, last)))
2533 void *value2 = ol2->value;
2535 value2 = (void *)(US options_block + (long int)value2);
2537 if (!no_labels) printf("%s = ", name);
2538 printf("%s\n", s ? string_printing(s) : US"");
2543 /* Else fall through */
2546 if (!no_labels) printf("%s = ", name);
2547 if (! *get_set_flag(name, oltop, last, options_block))
2550 if ((pw = getpwuid(*((uid_t *)value))))
2551 printf("%s\n", pw->pw_name);
2553 printf("%ld\n", (long int)(*((uid_t *)value)));
2556 /* If the numerical value is unset, try for the string value */
2558 case opt_expand_gid:
2559 if (! *get_set_flag(name, oltop, last, options_block))
2561 sprintf(CS name2, "*expand_%.50s", name);
2562 if ( (ol2 = find_option(name2, oltop, last))
2563 && (ol2->type & opt_mask) == opt_stringptr)
2565 void *value2 = ol2->value;
2567 value2 = (void *)(US options_block + (long int)value2);
2569 if (!no_labels) printf("%s = ", name);
2570 printf("%s\n", s ? string_printing(s) : US"");
2575 /* Else fall through */
2578 if (!no_labels) printf("%s = ", name);
2579 if (! *get_set_flag(name, oltop, last, options_block))
2582 if ((gr = getgrgid(*((int *)value))))
2583 printf("%s\n", gr->gr_name);
2585 printf("%ld\n", (long int)(*((int *)value)));
2589 uidlist = *((uid_t **)value);
2590 if (!no_labels) printf("%s =", name);
2593 uschar sep = no_labels ? '\0' : ' ';
2594 for (int i = 1; i <= (int)(uidlist[0]); i++)
2596 uschar *name = NULL;
2597 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2598 if (sep != '\0') printf("%c", sep);
2599 if (name) printf("%s", name);
2600 else printf("%ld", (long int)(uidlist[i]));
2608 gidlist = *((gid_t **)value);
2609 if (!no_labels) printf("%s =", name);
2612 uschar sep = no_labels ? '\0' : ' ';
2613 for (int i = 1; i <= (int)(gidlist[0]); i++)
2615 uschar *name = NULL;
2616 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2617 if (sep != '\0') printf("%c", sep);
2618 if (name) printf("%s", name);
2619 else printf("%ld", (long int)(gidlist[i]));
2627 if (!no_labels) printf("%s = ", name);
2628 printf("%s\n", readconf_printtime(*((int *)value)));
2633 int *list = (int *)value;
2634 if (!no_labels) printf("%s = ", name);
2635 for (int i = 0; i < list[1]; i++)
2636 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2642 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2646 case opt_expand_bool:
2647 sprintf(CS name2, "*expand_%.50s", name);
2648 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2650 void *value2 = ol2->value;
2652 value2 = (void *)(US options_block + (long int)value2);
2656 if (!no_labels) printf("%s = ", name);
2657 printf("%s\n", string_printing(s));
2660 /* s == NULL => string not set; fall through */
2666 case opt_bool_verify:
2668 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2673 void (*fn)() = ol->value;
2674 fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2683 /*************************************************
2684 * Print value from main configuration *
2685 *************************************************/
2687 /* This function, called as a result of encountering the -bP option,
2688 causes the value of any main configuration variable to be output if the
2689 second argument is NULL. There are some special values:
2691 all print all main configuration options
2692 config_file print the name of the configuration file
2693 (configure_file will still work, for backward
2695 routers print the routers' configurations
2696 transports print the transports' configuration
2697 authenticators print the authenticators' configuration
2698 macros print the macros' configuration
2699 router_list print a list of router names
2700 transport_list print a list of transport names
2701 authenticator_list print a list of authentication mechanism names
2702 macro_list print a list of macro names
2703 +name print a named list item
2704 local_scan print the local_scan options
2705 config print the configuration as it is parsed
2706 environment print the used execution environment
2708 If the second argument is not NULL, it must be one of "router", "transport",
2709 "authenticator" or "macro" in which case the first argument identifies the
2710 driver whose options are to be printed.
2713 name option name if type == NULL; else driver name
2714 type NULL or driver type name, as described above
2715 no_labels avoid the "foo = " at the start of an item
2717 Returns: Boolean success
2721 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2723 BOOL names_only = FALSE;
2724 optionlist *ol2 = NULL;
2725 driver_instance *d = NULL;
2734 static uschar *types[] = { US"address", US"domain", US"host",
2736 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2737 &hostlist_anchor, &localpartlist_anchor };
2739 for (int i = 0; i < 4; i++)
2740 if ((t = tree_search(*(anchors[i]), name+1)))
2744 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2746 printf("%slist %s = %s\n", types[i], name+1,
2747 ((namedlist_block *)(t->data.ptr))->string);
2751 printf("no address, domain, host, or local part list called \"%s\" "
2752 "exists\n", name+1);
2757 if ( Ustrcmp(name, "configure_file") == 0
2758 || Ustrcmp(name, "config_file") == 0)
2760 printf("%s\n", CS config_main_filename);
2764 if (Ustrcmp(name, "all") == 0)
2766 for (optionlist * ol = optionlist_config;
2767 ol < optionlist_config + nelem(optionlist_config); ol++)
2768 if (!(ol->type & opt_hidden))
2769 (void) print_ol(ol, US ol->name, NULL,
2770 optionlist_config, nelem(optionlist_config),
2775 if (Ustrcmp(name, "local_scan") == 0)
2777 #ifndef LOCAL_SCAN_HAS_OPTIONS
2778 printf("local_scan() options are not supported\n");
2781 for (optionlist * ol = local_scan_options;
2782 ol < local_scan_options + local_scan_options_count; ol++)
2783 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2784 local_scan_options_count, no_labels);
2789 if (Ustrcmp(name, "config") == 0)
2791 print_config(f.admin_user, no_labels);
2795 if (Ustrcmp(name, "routers") == 0)
2800 else if (Ustrcmp(name, "transports") == 0)
2802 type = US"transport";
2805 else if (Ustrcmp(name, "authenticators") == 0)
2807 type = US"authenticator";
2810 else if (Ustrcmp(name, "macros") == 0)
2815 else if (Ustrcmp(name, "router_list") == 0)
2821 else if (Ustrcmp(name, "transport_list") == 0)
2823 type = US"transport";
2827 else if (Ustrcmp(name, "authenticator_list") == 0)
2829 type = US"authenticator";
2833 else if (Ustrcmp(name, "macro_list") == 0)
2839 else if (Ustrcmp(name, "environment") == 0)
2844 for (p = USS environ; *p; p++) ;
2845 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2847 for (p = USS environ; *p; p++)
2850 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2858 return print_ol(find_option(name,
2859 optionlist_config, nelem(optionlist_config)),
2860 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2863 /* Handle the options for a router or transport. Skip options that are flagged
2864 as hidden. Some of these are options with names starting with '*', used for
2865 internal alternative representations of other options (which the printing
2866 function will sort out). Others are synonyms kept for backward compatibility.
2869 if (Ustrcmp(type, "router") == 0)
2871 d = (driver_instance *)routers;
2872 ol2 = optionlist_routers;
2873 size = optionlist_routers_size;
2875 else if (Ustrcmp(type, "transport") == 0)
2877 d = (driver_instance *)transports;
2878 ol2 = optionlist_transports;
2879 size = optionlist_transports_size;
2881 else if (Ustrcmp(type, "authenticator") == 0)
2883 d = (driver_instance *)auths;
2884 ol2 = optionlist_auths;
2885 size = optionlist_auths_size;
2888 else if (Ustrcmp(type, "macro") == 0)
2890 /* People store passwords in macros and they were previously not available
2891 for printing. So we have an admin_users restriction. */
2894 fprintf(stderr, "exim: permission denied\n");
2897 for (macro_item * m = macros; m; m = m->next)
2898 if (!name || Ustrcmp(name, m->name) == 0)
2901 printf("%s\n", CS m->name);
2903 printf("%s\n", CS m->replacement);
2905 printf("%s=%s\n", CS m->name, CS m->replacement);
2909 if (!name) return TRUE;
2911 printf("%s %s not found\n", type, name);
2917 for (; d; d = d->next) printf("%s\n", CS d->name);
2921 /* Either search for a given driver, or print all of them */
2923 for (; d; d = d->next)
2927 printf("\n%s %s:\n", d->name, type);
2928 else if (Ustrcmp(d->name, name) != 0) continue;
2930 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2931 if (!(ol->type & opt_hidden))
2932 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2934 for (optionlist * ol = d->info->options;
2935 ol < d->info->options + *(d->info->options_count); ol++)
2936 if (!(ol->type & opt_hidden))
2937 rc |= print_ol(ol, US ol->name, d, d->info->options,
2938 *d->info->options_count, no_labels);
2940 if (name) return rc;
2942 if (!name) return TRUE;
2944 printf("%s %s not found\n", type, name);
2950 /*************************************************
2951 * Read a named list item *
2952 *************************************************/
2954 /* This function reads a name and a list (i.e. string). The name is used to
2955 save the list in a tree, sorted by its name. Each entry also has a number,
2956 which can be used for caching tests, but if the string contains any expansion
2957 items other than $key, the number is set negative to inhibit caching. This
2958 mechanism is used for domain, host, and address lists that are referenced by
2962 anchorp points to the tree anchor
2963 numberp points to the current number for this tree
2964 max the maximum number permitted
2965 s the text of the option line, starting immediately after the name
2967 tname the name of the list type, for messages
2973 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2976 BOOL forcecache = FALSE;
2979 namedlist_block *nb = store_get(sizeof(namedlist_block));
2981 if (Ustrncmp(s, "_cache", 6) == 0)
2988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2990 if (*numberp >= max)
2991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2994 while (isspace(*s)) s++;
2996 while (isalnum(*s) || *s == '_') s++;
2997 t = store_get(sizeof(tree_node) + s-ss);
2998 Ustrncpy(t->name, ss, s-ss);
3000 while (isspace(*s)) s++;
3002 if (!tree_insertnode(anchorp, t))
3003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3004 "duplicate name \"%s\" for a named %s", t->name, tname);
3007 nb->number = *numberp;
3010 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3011 "missing '=' after \"%s\"", t->name);
3012 while (isspace(*s)) s++;
3013 nb->string = read_string(s, t->name);
3014 nb->cache_data = NULL;
3016 /* Check the string for any expansions; if any are found, mark this list
3017 uncacheable unless the user has explicited forced caching. */
3019 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3025 /*************************************************
3026 * Unpick data for a rate limit *
3027 *************************************************/
3029 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3033 s string, in the form t,b,f,l
3034 where t is the threshold (integer)
3035 b is the initial delay (time)
3036 f is the multiplicative factor (fixed point)
3037 k is the maximum time (time)
3038 threshold where to store threshold
3039 base where to store base in milliseconds
3040 factor where to store factor in milliseconds
3041 limit where to store limit
3043 Returns: nothing (panics on error)
3047 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3050 uschar bstring[16], lstring[16];
3052 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3053 factor, lstring) == 4)
3055 *base = readconf_readtime(bstring, 0, TRUE);
3056 *limit = readconf_readtime(lstring, 0, TRUE);
3057 if (*base >= 0 && *limit >= 0) return;
3059 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3065 /*************************************************
3066 * Drop privs for checking TLS config *
3067 *************************************************/
3069 /* We want to validate TLS options during readconf, but do not want to be
3070 root when we call into the TLS library, in case of library linkage errors
3071 which cause segfaults; before this check, those were always done as the Exim
3072 runtime user and it makes sense to continue with that.
3074 Assumes: tls_require_ciphers has been set, if it will be
3075 exim_user has been set, if it will be
3076 exim_group has been set, if it will be
3078 Returns: bool for "okay"; false will cause caller to immediately exit.
3083 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3085 const uschar *errmsg;
3088 void (*oldsignal)(int);
3090 /* If TLS will never be used, no point checking ciphers */
3092 if ( !tls_advertise_hosts
3093 || !*tls_advertise_hosts
3094 || Ustrcmp(tls_advertise_hosts, ":") == 0
3097 else if (!nowarn && !tls_certificate)
3098 log_write(0, LOG_MAIN,
3099 "Warning: No server certificate defined; will use a selfsigned one.\n"
3100 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3102 oldsignal = signal(SIGCHLD, SIG_DFL);
3105 if ((pid = fork()) < 0)
3106 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3110 /* in some modes, will have dropped privilege already */
3112 exim_setugid(exim_uid, exim_gid, FALSE,
3113 US"calling tls_validate_require_cipher");
3115 if ((errmsg = tls_validate_require_cipher()))
3116 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3117 "tls_require_ciphers invalid: %s", errmsg);
3123 rc = waitpid(pid, &status, 0);
3124 } while (rc < 0 && errno == EINTR);
3127 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3130 signal(SIGCHLD, oldsignal);
3134 #endif /* SUPPORT_TLS */
3139 /*************************************************
3140 * Read main configuration options *
3141 *************************************************/
3143 /* This function is the first to be called for configuration reading. It
3144 opens the configuration file and reads general configuration settings until
3145 it reaches the end of the configuration section. The file is then left open so
3146 that the remaining configuration data can subsequently be read if needed for
3149 The configuration file must be owned either by root or exim, and be writeable
3150 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3151 in the config file, so the test is done on the compiled in values. A slight
3152 anomaly, to be carefully documented.
3154 The name of the configuration file is taken from a list that is included in the
3155 binary of Exim. It can be altered from the command line, but if that is done,
3156 root privilege is immediately withdrawn unless the caller is root or exim.
3157 The first file on the list that exists is used.
3159 For use on multiple systems that share file systems, first look for a
3160 configuration file whose name has the current node name on the end. If that is
3161 not found, try the generic name. For really contorted configurations, that run
3162 multiple Exims with different uid settings, first try adding the effective uid
3163 before the node name. These complications are going to waste resources on most
3164 systems. Therefore they are available only when requested by compile-time
3168 readconf_main(BOOL nowarn)
3171 struct stat statbuf;
3172 uschar *s, *filename;
3173 const uschar *list = config_main_filelist;
3175 /* Loop through the possible file names */
3177 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3180 /* Cut out all the fancy processing unless specifically wanted */
3182 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3183 uschar *suffix = filename + Ustrlen(filename);
3185 /* Try for the node-specific file if a node name exists */
3187 #ifdef CONFIGURE_FILE_USE_NODE
3189 if (uname(&uts) >= 0)
3191 #ifdef CONFIGURE_FILE_USE_EUID
3192 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3193 config_file = Ufopen(filename, "rb");
3194 if (config_file == NULL)
3195 #endif /* CONFIGURE_FILE_USE_EUID */
3197 sprintf(CS suffix, ".%.256s", uts.nodename);
3198 config_file = Ufopen(filename, "rb");
3201 #endif /* CONFIGURE_FILE_USE_NODE */
3203 /* Otherwise, try the generic name, possibly with the euid added */
3205 #ifdef CONFIGURE_FILE_USE_EUID
3206 if (config_file == NULL)
3208 sprintf(CS suffix, ".%ld", (long int)original_euid);
3209 config_file = Ufopen(filename, "rb");
3211 #endif /* CONFIGURE_FILE_USE_EUID */
3213 /* Finally, try the unadorned name */
3215 if (config_file == NULL)
3218 config_file = Ufopen(filename, "rb");
3220 #else /* if neither defined */
3222 /* This is the common case when the fancy processing is not included. */
3224 config_file = Ufopen(filename, "rb");
3227 /* If the file does not exist, continue to try any others. For any other
3228 error, break out (and die). */
3230 if (config_file != NULL || errno != ENOENT) break;
3233 /* On success, save the name for verification; config_filename is used when
3234 logging configuration errors (it changes for .included files) whereas
3235 config_main_filename is the name shown by -bP. Failure to open a configuration
3236 file is a serious disaster. */
3240 uschar *last_slash = Ustrrchr(filename, '/');
3241 config_filename = config_main_filename = string_copy(filename);
3243 /* The config_main_directory we need for the $config_dir expansion.
3244 config_main_filename we need for $config_file expansion.
3245 And config_dir is the directory of the current configuration, used for
3246 relative .includes. We do need to know it's name, as we change our working
3249 if (filename[0] == '/')
3250 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3253 /* relative configuration file name: working dir + / + basename(filename) */
3255 uschar buf[PATH_MAX];
3258 if (os_getcwd(buf, PATH_MAX) == NULL)
3260 perror("exim: getcwd");
3263 g = string_cat(NULL, buf);
3265 /* If the dir does not end with a "/", append one */
3266 if (g->s[g->ptr-1] != '/')
3267 g = string_catn(g, US"/", 1);
3269 /* If the config file contains a "/", extract the directory part */
3271 g = string_catn(g, filename, last_slash - filename);
3273 config_main_directory = string_from_gstring(g);
3275 config_directory = config_main_directory;
3279 if (filename == NULL)
3280 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3281 "%s", config_main_filelist);
3283 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3284 "configuration file %s", filename));
3287 /* Now, once we found and opened our configuration file, we change the directory
3288 to a safe place. Later we change to $spool_directory. */
3290 if (Uchdir("/") < 0)
3292 perror("exim: chdir `/': ");
3296 /* Check the status of the file we have opened, if we have retained root
3297 privileges and the file isn't /dev/null (which *should* be 0666). */
3299 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3301 if (fstat(fileno(config_file), &statbuf) != 0)
3302 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3305 if ((statbuf.st_uid != root_uid /* owner not root */
3306 #ifdef CONFIGURE_OWNER
3307 && statbuf.st_uid != config_uid /* owner not the special one */
3310 (statbuf.st_gid != root_gid /* group not root & */
3311 #ifdef CONFIGURE_GROUP
3312 && statbuf.st_gid != config_gid /* group not the special one */
3314 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3316 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3318 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3319 "wrong owner, group, or mode", big_buffer);
3322 /* Process the main configuration settings. They all begin with a lower case
3323 letter. If we see something starting with an upper case letter, it is taken as
3324 a macro definition. */
3326 while ((s = get_config_line()))
3328 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3330 "found unexpected BOM (Byte Order Mark)");
3333 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3335 else if (Ustrncmp(s, "domainlist", 10) == 0)
3336 read_named_list(&domainlist_anchor, &domainlist_count,
3337 MAX_NAMED_LIST, s+10, US"domain list");
3339 else if (Ustrncmp(s, "hostlist", 8) == 0)
3340 read_named_list(&hostlist_anchor, &hostlist_count,
3341 MAX_NAMED_LIST, s+8, US"host list");
3343 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3344 read_named_list(&addresslist_anchor, &addresslist_count,
3345 MAX_NAMED_LIST, s+11, US"address list");
3347 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3348 read_named_list(&localpartlist_anchor, &localpartlist_count,
3349 MAX_NAMED_LIST, s+13, US"local part list");
3352 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3353 NULL, US"main option \"%s\" unknown");
3357 /* If local_sender_retain is set, local_from_check must be unset. */
3359 if (local_sender_retain && local_from_check)
3360 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3361 "local_sender_retain are set; this combination is not allowed");
3363 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3366 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3368 /* The max retry interval must not be greater than 24 hours. */
3370 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3372 /* remote_max_parallel must be > 0 */
3374 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3376 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3377 start of a new SMTP message. */
3379 freeze_tell_config = freeze_tell;
3381 /* The primary host name may be required for expansion of spool_directory
3382 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3383 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3384 canonize it. Some people like upper case letters in their host names, so we
3385 don't force the case. */
3387 if (primary_hostname == NULL)
3389 const uschar *hostname;
3391 if (uname(&uts) < 0)
3392 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3393 hostname = US uts.nodename;
3395 if (Ustrchr(hostname, '.') == NULL)
3398 struct hostent *hostdata;
3401 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3402 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3403 MCL_DOMAIN, TRUE, NULL) != OK))
3412 #if HAVE_GETIPNODEBYNAME
3414 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3416 hostdata = gethostbyname2(CS hostname, af);
3419 hostdata = gethostbyname(CS hostname);
3422 if (hostdata != NULL)
3424 hostname = US hostdata->h_name;
3428 if (af == AF_INET) break;
3433 primary_hostname = string_copy(hostname);
3436 /* Set up default value for smtp_active_hostname */
3438 smtp_active_hostname = primary_hostname;
3440 /* If spool_directory wasn't set in the build-time configuration, it must have
3441 got set above. Of course, writing to the log may not work if log_file_path is
3442 not set, but it will at least get to syslog or somewhere, with any luck. */
3444 if (*spool_directory == 0)
3445 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3448 /* Expand the spool directory name; it may, for example, contain the primary
3449 host name. Same comment about failure. */
3451 s = expand_string(spool_directory);
3453 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3454 "\"%s\": %s", spool_directory, expand_string_message);
3455 spool_directory = s;
3457 /* Expand log_file_path, which must contain "%s" in any component that isn't
3458 the null string or "syslog". It is also allowed to contain one instance of %D
3459 or %M. However, it must NOT contain % followed by anything else. */
3461 if (*log_file_path != 0)
3463 const uschar *ss, *sss;
3464 int sep = ':'; /* Fixed for log file path */
3465 s = expand_string(log_file_path);
3467 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3468 "\"%s\": %s", log_file_path, expand_string_message);
3471 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3474 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3475 t = Ustrstr(sss, "%s");
3477 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3478 "contain \"%%s\"", sss);
3480 t = Ustrchr(sss, '%');
3483 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3484 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3485 "unexpected \"%%\" character", s);
3492 /* Interpret syslog_facility into an integer argument for 'ident' param to
3493 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3496 if (syslog_facility_str)
3499 uschar *s = syslog_facility_str;
3501 if ((Ustrlen(syslog_facility_str) >= 4) &&
3502 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3505 for (i = 0; i < syslog_list_size; i++)
3506 if (strcmpic(s, syslog_list[i].name) == 0)
3508 syslog_facility = syslog_list[i].value;
3512 if (i >= syslog_list_size)
3513 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3514 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3517 /* Expand pid_file_path */
3519 if (*pid_file_path != 0)
3521 if (!(s = expand_string(pid_file_path)))
3522 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3523 "\"%s\": %s", pid_file_path, expand_string_message);
3527 /* Set default value of process_log_path */
3529 if (!process_log_path || *process_log_path =='\0')
3530 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3532 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3535 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3537 /* Unpick the SMTP rate limiting options, if set */
3539 if (smtp_ratelimit_mail)
3540 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3541 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3543 if (smtp_ratelimit_rcpt)
3544 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3545 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3547 /* The qualify domains default to the primary host name */
3549 if (!qualify_domain_sender)
3550 qualify_domain_sender = primary_hostname;
3551 if (!qualify_domain_recipient)
3552 qualify_domain_recipient = qualify_domain_sender;
3554 /* Setting system_filter_user in the configuration sets the gid as well if a
3555 name is given, but a numerical value does not. */
3557 if (system_filter_uid_set && !system_filter_gid_set)
3559 struct passwd *pw = getpwuid(system_filter_uid);
3561 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3562 (long int)system_filter_uid);
3563 system_filter_gid = pw->pw_gid;
3564 system_filter_gid_set = TRUE;
3567 /* If the errors_reply_to field is set, check that it is syntactically valid
3568 and ensure it contains a domain. */
3570 if (errors_reply_to)
3573 int start, end, domain;
3574 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3575 &start, &end, &domain, FALSE);
3578 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3579 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3583 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3586 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3587 smtp_accept_max must also be set. */
3589 if (smtp_accept_max == 0 &&
3590 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3591 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3592 "smtp_accept_max must be set if smtp_accept_queue or "
3593 "smtp_accept_max_per_host is set");
3595 /* Set up the host number if anything is specified. It is an expanded string
3596 so that it can be computed from the host name, for example. We do this last
3597 so as to ensure that everything else is set up before the expansion. */
3599 if (host_number_string)
3603 uschar *s = expand_string(host_number_string);
3606 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3607 "failed to expand localhost_number \"%s\": %s",
3608 host_number_string, expand_string_message);
3609 n = Ustrtol(s, &end, 0);
3610 while (isspace(*end)) end++;
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3613 "localhost_number value is not a number: %s", s);
3614 if (n > LOCALHOST_MAX)
3615 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3616 "localhost_number is greater than the maximum allowed value (%d)",
3622 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3624 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3625 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3626 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3627 tls_verify_hosts ? "" : "try_");
3629 /* This also checks that the library linkage is working and we can call
3630 routines in it, so call even if tls_require_ciphers is unset */
3631 if (!tls_dropprivs_validate_require_cipher(nowarn))
3634 /* Magic number: at time of writing, 1024 has been the long-standing value
3635 used by so many clients, and what Exim used to use always, that it makes
3636 sense to just min-clamp this max-clamp at that. */
3637 if (tls_dh_max_bits < 1024)
3638 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3639 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3641 /* If openssl_options is set, validate it */
3642 if (openssl_options)
3645 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3646 "openssl_options is set but we're using GnuTLS");
3649 if (!tls_openssl_options_parse(openssl_options, &dummy))
3650 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3651 "openssl_options parse error: %s", openssl_options);
3654 #endif /*SUPPORT_TLS*/
3656 if (!nowarn && !keep_environment && environ && *environ)
3657 log_write(0, LOG_MAIN,
3658 "Warning: purging the environment.\n"
3659 " Suggested action: use keep_environment.");
3664 /*************************************************
3665 * Initialize one driver *
3666 *************************************************/
3668 /* This is called once the driver's generic options, if any, have been read.
3669 We can now find the driver, set up defaults for the private options, and
3670 unset any "set" bits in the private options table (which might have been
3671 set by another incarnation of the same driver).
3674 d pointer to driver instance block, with generic
3676 drivers_available vector of available drivers
3677 size_of_info size of each block in drivers_available
3678 class class of driver, for error message
3680 Returns: pointer to the driver info block
3683 static driver_info *
3684 init_driver(driver_instance *d, driver_info *drivers_available,
3685 int size_of_info, uschar *class)
3687 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3688 dd = (driver_info *)((US dd) + size_of_info))
3689 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3691 int len = dd->options_len;
3693 d->options_block = store_get(len);
3694 memcpy(d->options_block, dd->options_block, len);
3695 for (int i = 0; i < *(dd->options_count); i++)
3696 dd->options[i].type &= ~opt_set;
3700 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3701 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3703 return NULL; /* never obeyed */
3709 /*************************************************
3710 * Initialize driver list *
3711 *************************************************/
3713 /* This function is called for routers, transports, and authentication
3714 mechanisms. It reads the data from the current point in the configuration file
3715 up to the end of the section, and sets up a chain of instance blocks according
3716 to the file's contents. The file will already have been opened by a call to
3717 readconf_main, and must be left open for subsequent reading of further data.
3719 Any errors cause a panic crash. Note that the blocks with names driver_info and
3720 driver_instance must map the first portions of all the _info and _instance
3721 blocks for this shared code to work.
3724 class "router", "transport", or "authenticator"
3725 anchor &routers, &transports, &auths
3726 drivers_available available drivers
3727 size_of_info size of each info block
3728 instance_default points to default data for an instance
3729 instance_size size of instance block
3730 driver_optionlist generic option list
3731 driver_optionlist_count count of generic option list
3737 readconf_driver_init(
3739 driver_instance **anchor,
3740 driver_info *drivers_available,
3742 void *instance_default,
3744 optionlist *driver_optionlist,
3745 int driver_optionlist_count)
3747 driver_instance **p = anchor;
3748 driver_instance *d = NULL;
3751 while ((buffer = get_config_line()) != NULL)
3756 /* Read the first name on the line and test for the start of a new driver. A
3757 macro definition indicates the end of the previous driver. If this isn't the
3758 start of a new driver, the line will be re-read. */
3760 s = readconf_readname(name, sizeof(name), buffer);
3762 /* Handle macro definition, first finishing off the initialization of the
3763 previous driver, if any. */
3765 if (isupper(*name) && *s == '=')
3769 if (!d->driver_name)
3770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3771 "no driver defined for %s \"%s\"", class, d->name);
3775 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3779 /* If the line starts with a name terminated by a colon, we are at the
3780 start of the definition of a new driver. The rest of the line must be
3785 /* Finish off initializing the previous driver. */
3789 if (!d->driver_name)
3790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3791 "no driver defined for %s \"%s\"", class, d->name);
3795 /* Check that we haven't already got a driver of this name */
3797 for (d = *anchor; d; d = d->next)
3798 if (Ustrcmp(name, d->name) == 0)
3799 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3800 "there are two %ss called \"%s\"", class, name);
3802 /* Set up a new driver instance data block on the chain, with
3803 its default values installed. */
3805 d = store_get(instance_size);
3806 memcpy(d, instance_default, instance_size);
3809 d->name = string_copy(name);
3811 /* Clear out the "set" bits in the generic options */
3813 for (int i = 0; i < driver_optionlist_count; i++)
3814 driver_optionlist[i].type &= ~opt_set;
3816 /* Check nothing more on this line, then do the next loop iteration. */
3818 while (isspace(*s)) s++;
3819 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3823 /* Not the start of a new driver. Give an error if we have not set up a
3824 current driver yet. */
3827 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3829 /* First look to see if this is a generic option; if it is "driver",
3830 initialize the driver. If is it not a generic option, we can look for a
3831 private option provided that the driver has been previously set up. */
3833 if (readconf_handle_option(buffer, driver_optionlist,
3834 driver_optionlist_count, d, NULL))
3836 if (!d->info && d->driver_name)
3837 init_driver(d, drivers_available, size_of_info, class);
3840 /* Handle private options - pass the generic block because some may
3841 live therein. A flag with each option indicates if it is in the public
3845 readconf_handle_option(buffer, d->info->options,
3846 *(d->info->options_count), d, US"option \"%s\" unknown");
3848 /* The option is not generic and the driver name has not yet been given. */
3850 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3851 "(\"driver\" must be specified before any private options)", name);
3854 /* Run the initialization function for the final driver. */
3858 if (!d->driver_name)
3859 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3860 "no driver defined for %s \"%s\"", class, d->name);
3867 /*************************************************
3868 * Check driver dependency *
3869 *************************************************/
3871 /* This function is passed a driver instance and a string. It checks whether
3872 any of the string options for the driver contains the given string as an
3876 d points to a driver instance block
3877 s the string to search for
3879 Returns: TRUE if a dependency is found
3883 readconf_depends(driver_instance *d, uschar *s)
3885 int count = *(d->info->options_count);
3888 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3890 void *options_block;
3892 int type = ol->type & opt_mask;
3893 if (type != opt_stringptr) continue;
3894 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3895 value = *(uschar **)(US options_block + (long int)(ol->value));
3896 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3898 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3899 isalnum(ss[Ustrlen(s)])) continue;
3900 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3901 d->name, ol->name, s);
3906 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3913 /*************************************************
3914 * Decode an error type for retries *
3915 *************************************************/
3917 /* This function is global because it is also called from the main
3918 program when testing retry information. It decodes strings such as "quota_7d"
3919 into numerical error codes.
3922 pp points to start of text
3923 p points past end of text
3924 basic_errno points to an int to receive the main error number
3925 more_errno points to an int to receive the secondary error data
3927 Returns: NULL if decoded correctly; else points to error text
3931 readconf_retry_error(const uschar *pp, const uschar *p,
3932 int *basic_errno, int *more_errno)
3935 const uschar *q = pp;
3936 while (q < p && *q != '_') q++;
3939 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3941 *basic_errno = ERRNO_EXIMQUOTA;
3942 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3943 return US"bad time value";
3946 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3948 *basic_errno = ECONNREFUSED;
3951 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3952 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3953 else return US"A or MX expected after \"refused\"";
3957 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3959 *basic_errno = ETIMEDOUT;
3963 int xlen = p - q - 1;
3964 const uschar *x = q + 1;
3966 static uschar *extras[] =
3967 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3968 static int values[] =
3969 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3971 for (i = 0; i < nelem(extras); i++)
3972 if (strncmpic(x, extras[i], xlen) == 0)
3974 *more_errno = values[i];
3978 if (i >= nelem(extras))
3979 if (strncmpic(x, US"DNS", xlen) == 0)
3980 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3981 "available in retry rules (it has never worked) - treated as "
3984 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3988 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3989 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3990 strncmpic(pp, US"data_4", 6) == 0)
3993 int x = 255; /* means "any 4xx code" */
3994 if (p != pp + 8) bad = TRUE; else
3996 int a = pp[6], b = pp[7];
4000 if (isdigit(b)) x += b - '0';
4001 else if (b == 'x') x += 100;
4004 else if (a != 'x' || b != 'x') bad = TRUE;
4008 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4009 "x is literal and d is any digit", pp);
4011 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4012 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4013 *more_errno = x << 8;
4016 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4017 strncmpic(q+1, US"failed", p-q-1) == 0)
4018 *basic_errno = ERRNO_AUTHFAIL;
4020 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4021 *basic_errno = ERRNO_SMTPCLOSED;
4023 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4024 *basic_errno = ERRNO_TLSREQUIRED;
4026 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4027 *basic_errno = ERRNO_UNKNOWNHOST;
4029 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4030 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4038 /*************************************************
4039 * Read retry information *
4040 *************************************************/
4042 /* Each line of retry information contains:
4044 . A domain name pattern or an address pattern;
4046 . An error name, possibly with additional data, or *;
4048 . An optional sequence of retry items, each consisting of an identifying
4049 letter, a cutoff time, and optional parameters.
4051 All this is decoded and placed into a control block. */
4054 /* Subroutine to read an argument, preceded by a comma and terminated
4055 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4056 1 = fixed point number (returned *1000).
4059 paddr pointer to pointer to current character; updated
4060 type 0 => read a time; 1 => read a fixed point number
4062 Returns: time in seconds or fixed point number * 1000
4066 retry_arg(const uschar **paddr, int type)
4068 const uschar *p = *paddr;
4071 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4073 while (isspace(*p)) p++;
4075 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4077 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4078 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4083 case 0: return readconf_readtime(pp, *p, FALSE);
4084 case 1: return readconf_readfixed(pp, *p);
4086 return 0; /* Keep picky compilers happy */
4089 /* The function proper */
4092 readconf_retries(void)
4094 retry_config **chain = &retries;
4098 while ((p = get_config_line()))
4100 retry_rule **rchain;
4104 next = store_get(sizeof(retry_config));
4107 chain = &(next->next);
4108 next->basic_errno = next->more_errno = 0;
4109 next->senders = NULL;
4111 rchain = &(next->rules);
4113 next->pattern = string_dequote(&p);
4114 while (isspace(*p)) p++;
4116 while (mac_isgraph(*p)) p++;
4117 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4118 "missing error type in retry rule");
4120 /* Test error names for things we understand. */
4122 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4123 &next->more_errno)))
4124 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4126 /* There may be an optional address list of senders to be used as another
4127 constraint on the rule. This was added later, so the syntax is a bit of a
4128 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4131 while (isspace(*p)) p++;
4132 if (Ustrncmp(p, "senders", 7) == 0)
4135 while (isspace(*p)) p++;
4136 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4137 "\"=\" expected after \"senders\" in retry rule");
4138 while (isspace(*p)) p++;
4139 next->senders = string_dequote(&p);
4142 /* Now the retry rules. Keep the maximum timeout encountered. */
4144 while (isspace(*p)) p++;
4148 retry_rule *rule = store_get(sizeof(retry_rule));
4150 rchain = &(rule->next);
4152 rule->rule = toupper(*p++);
4153 rule->timeout = retry_arg(&p, 0);
4154 if (rule->timeout > retry_maximum_timeout)
4155 retry_maximum_timeout = rule->timeout;
4159 case 'F': /* Fixed interval */
4160 rule->p1 = retry_arg(&p, 0);
4163 case 'G': /* Geometrically increasing intervals */
4164 case 'H': /* Ditto, but with randomness */
4165 rule->p1 = retry_arg(&p, 0);
4166 rule->p2 = retry_arg(&p, 1);
4170 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4174 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4175 (rule->rule != 'F' && rule->p2 < 1000))
4176 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4177 "bad parameters for retry rule");
4179 while (isspace(*p)) p++;
4183 while (isspace(*p)) p++;
4186 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4193 /*************************************************
4194 * Initialize authenticators *
4195 *************************************************/
4197 /* Read the authenticators section of the configuration file.
4206 #ifdef EXPERIMENTAL_PIPE_CONNECT
4210 readconf_driver_init(US"authenticator",
4211 (driver_instance **)(&auths), /* chain anchor */
4212 (driver_info *)auths_available, /* available drivers */
4213 sizeof(auth_info), /* size of info block */
4214 &auth_defaults, /* default values for generic options */
4215 sizeof(auth_instance), /* size of instance block */
4216 optionlist_auths, /* generic options */
4217 optionlist_auths_size);
4219 for (auth_instance * au = auths; au; au = au->next)
4221 if (!au->public_name)
4222 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4223 "the %s authenticator", au->name);
4225 for (auth_instance * bu = au->next; bu; bu = bu->next)
4226 if (strcmpic(au->public_name, bu->public_name) == 0)
4227 if ((au->client && bu->client) || (au->server && bu->server))
4228 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4229 "(%s and %s) have the same public name (%s)",
4230 au->client ? US"client" : US"server", au->name, bu->name,
4232 #ifdef EXPERIMENTAL_PIPE_CONNECT
4236 #ifdef EXPERIMENTAL_PIPE_CONNECT
4237 f.smtp_in_early_pipe_no_auth = nauths > 16;
4244 /*************************************************
4245 * Read ACL information *
4246 *************************************************/
4248 /* If this run of Exim is not doing something that involves receiving a
4249 message, we can just skip over the ACL information. No need to parse it.
4251 First, we have a function for acl_read() to call back to get the next line. We
4252 need to remember the line we passed, because at the end it will contain the
4253 name of the next ACL. */
4255 static uschar *acl_line;
4260 acl_line = get_config_line();
4265 /* Now the main function:
4276 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4279 acl_line = get_config_line();
4287 p = readconf_readname(name, sizeof(name), acl_line);
4288 if (isupper(*name) && *p == '=')
4290 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4291 acl_line = get_config_line();
4295 if (*p != ':' || name[0] == 0)
4296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4298 node = store_get(sizeof(tree_node) + Ustrlen(name));
4299 Ustrcpy(node->name, name);
4300 if (!tree_insertnode(&acl_anchor, node))
4301 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4302 "there are two ACLs called \"%s\"", name);
4304 node->data.ptr = acl_read(acl_callback, &error);
4306 if (node->data.ptr == NULL && error != NULL)
4307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4313 /*************************************************
4314 * Read configuration for local_scan() *
4315 *************************************************/
4317 /* This function is called after "begin local_scan" is encountered in the
4318 configuration file. If the local_scan() function allows for configuration
4319 options, we can process them. Otherwise, we expire in a panic.
4326 local_scan_init(void)
4328 #ifndef LOCAL_SCAN_HAS_OPTIONS
4329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4330 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4334 while ((p = get_config_line()))
4336 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4337 NULL, US"local_scan option \"%s\" unknown");
4344 /*************************************************
4345 * Read rest of configuration (after main) *
4346 *************************************************/
4348 /* This function reads the rest of the runtime configuration, after the main
4349 configuration. It is called only when actually needed. Each subsequent section
4350 of the configuration starts with a line of the form
4354 where the name is "routers", "transports", etc. A section is terminated by
4355 hitting the next "begin" line, and the next name is left in next_section.
4356 Because it may confuse people as to whether the names are singular or plural,
4357 we add "s" if it's missing. There is always enough room in next_section for
4358 this. This function is basically just a switch.
4364 static uschar *section_list[] = {
4378 while(next_section[0] != 0)
4382 int last = nelem(section_list);
4384 int n = Ustrlen(next_section);
4386 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4390 int c = strcmpic(next_section, section_list[mid]);
4392 if (c > 0) first = mid + 1; else last = mid;
4394 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4395 "\"%.*s\" is not a known configuration section name", n, next_section);
4396 mid = (last + first)/2;
4400 if (((had ^= bit) & bit) == 0)
4401 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4402 "\"%.*s\" section is repeated in the configuration file", n,
4407 case 0: readconf_acl(); break;
4408 case 1: auths_init(); break;
4409 case 2: local_scan_init(); break;
4410 case 3: readconf_retries(); break;
4411 case 4: readconf_rewrites(); break;
4412 case 5: route_init(); break;
4413 case 6: transport_init(); break;
4417 (void)fclose(config_file);
4420 /* Init the storage for the pre-parsed config lines */
4422 readconf_save_config(const uschar *s)
4424 save_config_line(string_sprintf("# Exim Configuration (%s)",
4425 f.running_in_test_harness ? US"X" : s));
4429 save_config_position(const uschar *file, int line)
4431 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4434 /* Append a pre-parsed logical line to the config lines store,
4435 this operates on a global (static) list that holds all the pre-parsed
4436 config lines, we do no further processing here, output formatting and
4437 honouring of <hide> or macros will be done during output */
4440 save_config_line(const uschar* line)
4442 static config_line_item *current;
4443 config_line_item *next;
4445 next = (config_line_item*) store_get(sizeof(config_line_item));
4446 next->line = string_copy(line);
4449 if (!config_lines) config_lines = next;
4450 else current->next = next;
4455 /* List the parsed config lines, care about nice formatting and
4456 hide the <hide> values unless we're the admin user */
4458 print_config(BOOL admin, BOOL terse)
4460 const int TS = terse ? 0 : 2;
4463 for (config_line_item * i = config_lines; i; i = i->next)
4468 /* skip over to the first non-space */
4469 for (current = i->line; *current && isspace(*current); ++current)
4472 if (*current == '\0')
4475 /* Collapse runs of spaces. We stop this if we encounter one of the
4476 * following characters: "'$, as this may indicate careful formatting */
4477 for (p = current; *p; ++p)
4480 if (!isspace(*p)) continue;
4481 if (*p != ' ') *p = ' ';
4483 for (next = p; isspace(*next); ++next)
4487 memmove(p+1, next, Ustrlen(next)+1);
4489 if (*next == '"' || *next == '\'' || *next == '$')
4494 if (current[0] == '#')
4497 /* begin lines are left aligned */
4498 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4500 if (!terse) puts("");
4505 /* router/acl/transport block names */
4506 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4508 if (!terse) puts("");
4509 printf("%*s%s\n", TS, "", current);
4513 /* hidden lines (all MACROS or lines prefixed with "hide") */
4515 && ( isupper(*current)
4516 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4520 if ((p = Ustrchr(current, '=')))
4523 printf("%*s%s= %s\n", indent, "", current, hidden);
4525 /* e.g.: hide split_spool_directory */
4527 printf("%*s\n", indent, hidden);
4531 /* rest is public */
4532 printf("%*s%s\n", indent, "", current);
4536 #endif /*!MACRO_PREDEF*/
4539 /* End of readconf.c */