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 # ifdef EXPERIMENTAL_TLS_RESUME
371 { "tls_resumption_hosts", opt_stringptr, &tls_resumption_hosts },
373 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
374 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
375 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
377 { "trusted_groups", opt_gidlist, &trusted_groups },
378 { "trusted_users", opt_uidlist, &trusted_users },
379 { "unknown_login", opt_stringptr, &unknown_login },
380 { "unknown_username", opt_stringptr, &unknown_username },
381 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
382 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
383 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
384 { "warn_message_file", opt_stringptr, &warn_message_file },
385 { "write_rejectlog", opt_bool, &write_rejectlog }
389 static int optionlist_config_size = nelem(optionlist_config);
396 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
401 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
409 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
411 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
413 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
414 builtin_macro_create(buf);
415 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
420 options_logging(void)
424 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
426 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
427 builtin_macro_create(buf);
432 #else /*!MACRO_PREDEF*/
434 extern char **environ;
436 static void save_config_line(const uschar* line);
437 static void save_config_position(const uschar *file, int line);
438 static void print_config(BOOL admin, BOOL terse);
441 #define CSTATE_STACK_SIZE 10
443 const uschar *config_directory = NULL;
446 /* Structure for chain (stack) of .included files */
448 typedef struct config_file_item {
449 struct config_file_item *next;
450 const uschar *filename;
451 const uschar *directory;
456 /* Structure for chain of configuration lines (-bP config) */
458 typedef struct config_line_item {
459 struct config_line_item *next;
463 static config_line_item* config_lines;
465 /* Structure of table of conditional words and their state transitions */
467 typedef struct cond_item {
475 /* Structure of table of syslog facility names and values */
477 typedef struct syslog_fac_item {
483 static const char * const hidden = "<value not displayable>";
485 /* Static variables */
487 static config_file_item *config_file_stack = NULL; /* For includes */
489 static uschar *syslog_facility_str = NULL;
490 static uschar next_section[24];
491 static uschar time_buffer[24];
493 /* State variables for conditional loading (.ifdef / .else / .endif) */
495 static int cstate = 0;
496 static int cstate_stack_ptr = -1;
497 static int cstate_stack[CSTATE_STACK_SIZE];
499 /* Table of state transitions for handling conditional inclusions. There are
500 four possible state transitions:
504 .elifdef true (or .else)
507 .endif just causes the previous cstate to be popped off the stack */
509 static int next_cstate[3][4] =
511 /* State 0: reading from file, or reading until next .else or .endif */
513 /* State 1: condition failed, skipping until next .else or .endif */
515 /* State 2: skipping until .endif */
519 /* Table of conditionals and the states to set. For each name, there are four
520 values: the length of the name (to save computing it each time), the state to
521 set if a macro was found in the line, the state to set if a macro was not found
522 in the line, and a stack manipulation setting which is:
524 -1 pull state value off the stack
525 0 don't alter the stack
526 +1 push value onto stack, before setting new state
529 static cond_item cond_list[] = {
530 { US"ifdef", 5, 0, 1, 1 },
531 { US"ifndef", 6, 1, 0, 1 },
532 { US"elifdef", 7, 2, 3, 0 },
533 { US"elifndef", 8, 3, 2, 0 },
534 { US"else", 4, 2, 2, 0 },
535 { US"endif", 5, 0, 0, -1 }
538 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
540 /* Table of syslog facility names and their values */
542 static syslog_fac_item syslog_list[] = {
543 { US"mail", LOG_MAIL },
544 { US"user", LOG_USER },
545 { US"news", LOG_NEWS },
546 { US"uucp", LOG_UUCP },
547 { US"local0", LOG_LOCAL0 },
548 { US"local1", LOG_LOCAL1 },
549 { US"local2", LOG_LOCAL2 },
550 { US"local3", LOG_LOCAL3 },
551 { US"local4", LOG_LOCAL4 },
552 { US"local5", LOG_LOCAL5 },
553 { US"local6", LOG_LOCAL6 },
554 { US"local7", LOG_LOCAL7 },
555 { US"daemon", LOG_DAEMON }
558 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
561 #define opt_fn_print BIT(0)
562 #define opt_fn_print_label BIT(1)
565 /*************************************************
566 * Find the name of an option *
567 *************************************************/
569 /* This function is to aid debugging. Various functions take arguments that are
570 pointer variables in the options table or in option tables for various drivers.
571 For debugging output, it is useful to be able to find the name of the option
572 which is currently being processed. This function finds it, if it exists, by
573 searching the table(s).
575 Arguments: a value that is presumed to be in the table above
576 Returns: the option name, or an empty string
580 readconf_find_option(void *p)
582 for (int i = 0; i < nelem(optionlist_config); i++)
583 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
585 for (router_instance * r = routers; r; r = r->next)
587 router_info *ri = r->info;
588 for (int i = 0; i < *ri->options_count; i++)
590 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
591 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
592 return US ri->options[i].name;
596 for (transport_instance * t = transports; t; t = t->next)
598 transport_info *ti = t->info;
599 for (int i = 0; i < *ti->options_count; i++)
601 optionlist * op = &ti->options[i];
602 if ((op->type & opt_mask) != opt_stringptr) continue;
603 if (p == ( op->type & opt_public
605 : CS t->options_block
607 + (long int)op->value)
618 /*************************************************
619 * Deal with an assignment to a macro *
620 *************************************************/
622 /* We have a new definition; append to the list.
625 name Name of the macro; will be copied
626 val Expansion result for the macro; will be copied
630 macro_create(const uschar * name, const uschar * val, BOOL command_line)
632 macro_item * m = store_get(sizeof(macro_item));
634 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
636 m->command_line = command_line;
637 m->namelen = Ustrlen(name);
638 m->replen = Ustrlen(val);
639 m->name = string_copy(name);
640 m->replacement = string_copy(val);
652 /* This function is called when a line that starts with an upper case letter is
653 encountered. The argument "line" should contain a complete logical line, and
654 start with the first letter of the macro name. The macro name and the
655 replacement text are extracted and stored. Redefinition of existing,
656 non-command line, macros is permitted using '==' instead of '='.
659 s points to the start of the logical line
661 Returns: FALSE iff fatal error
665 macro_read_assignment(uschar *s)
672 while (isalnum(*s) || *s == '_')
674 if (namelen >= sizeof(name) - 1)
676 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
677 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
680 name[namelen++] = *s++;
684 while (isspace(*s)) s++;
687 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
696 while (isspace(*s)) s++;
698 /* If an existing macro of the same name was defined on the command line, we
699 just skip this definition. It's an error to attempt to redefine a macro without
700 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
701 It is also an error to define a macro whose name begins with the name of a
702 previously defined macro. This is the requirement that make using a tree
703 for macros hard; we must check all macros for the substring. Perhaps a
704 sorted list, and a bsearch, would work?
705 Note: it is documented that the other way round works. */
707 for (m = macros; m; m = m->next)
709 if (Ustrcmp(m->name, name) == 0)
711 if (!m->command_line && !redef)
713 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
714 "defined (use \"==\" if you want to redefine it)", name);
720 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
722 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
723 "a macro because previously defined macro \"%s\" is a substring",
728 /* We cannot have this test, because it is documented that a substring
729 macro is permitted (there is even an example).
731 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
732 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
733 * "a macro because it is a substring of previously defined macro \"%s\"",
738 /* Check for an overriding command-line definition. */
740 if (m && m->command_line) return TRUE;
742 /* Redefinition must refer to an existing macro. */
747 m->replen = Ustrlen(s);
748 m->replacement = string_copy(s);
752 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
757 /* We have a new definition. */
759 (void) macro_create(name, s, FALSE);
767 /* Process line for macros. The line is in big_buffer starting at offset len.
768 Expand big_buffer if needed. Handle definitions of new macros, and
769 macro expansions, rewriting the line in the buffer.
772 len Offset in buffer of start of line
773 newlen Pointer to offset of end of line, updated on return
774 macro_found Pointer to return that a macro was expanded
776 Return: pointer to first nonblank char in line
780 macros_expand(int len, int * newlen, BOOL * macro_found)
782 uschar * ss = big_buffer + len;
785 /* Find the true start of the physical line - leading spaces are always
788 while (isspace(*ss)) ss++;
790 /* Process the physical line for macros. If this is the start of the logical
791 line, skip over initial text at the start of the line if it starts with an
792 upper case character followed by a sequence of name characters and an equals
793 sign, because that is the definition of a new macro, and we don't do
794 replacement therein. */
797 if (len == 0 && isupper(*s))
799 while (isalnum(*s) || *s == '_') s++;
800 while (isspace(*s)) s++;
801 if (*s != '=') s = ss; /* Not a macro definition */
804 /* Skip leading chars which cannot start a macro name, to avoid multiple
805 pointless rescans in Ustrstr calls. */
807 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
809 /* For each defined macro, scan the line (from after XXX= if present),
810 replacing all occurrences of the macro. */
812 *macro_found = FALSE;
813 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
818 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
822 while ((p = Ustrstr(t, m->name)) != NULL)
826 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
827 m->name, (int) Ustrlen(ss)-1, ss);
828 /* Expand the buffer if necessary */
830 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
832 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
833 uschar *newbuffer = store_malloc(newsize);
834 memcpy(newbuffer, big_buffer, *newlen + 1);
835 p = newbuffer + (p - big_buffer);
836 s = newbuffer + (s - big_buffer);
837 ss = newbuffer + (ss - big_buffer);
838 t = newbuffer + (t - big_buffer);
839 big_buffer_size = newsize;
840 store_free(big_buffer);
841 big_buffer = newbuffer;
844 /* Shuffle the remaining characters up or down in the buffer before
845 copying in the replacement text. Don't rescan the replacement for this
849 if ((moveby = m->replen - m->namelen) != 0)
851 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
854 Ustrncpy(p, m->replacement, m->replen);
856 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
861 /* An empty macro replacement at the start of a line could mean that ss no
862 longer points to the first non-blank character. */
864 while (isspace(*ss)) ss++;
868 /*************************************************
869 * Read configuration line *
870 *************************************************/
872 /* A logical line of text is read from the configuration file into the big
873 buffer, taking account of macros, .includes, and continuations. The size of
874 big_buffer is increased if necessary. The count of configuration lines is
875 maintained. Physical input lines starting with # (ignoring leading white space,
876 and after macro replacement) and empty logical lines are always ignored.
877 Leading and trailing spaces are removed.
879 If we hit a line of the form "begin xxxx", the xxxx is placed in the
880 next_section vector, and the function returns NULL, indicating the end of a
881 configuration section. On end-of-file, NULL is returned with next_section
886 Returns: a pointer to the first non-blank in the line,
887 or NULL if eof or end of section is reached
891 get_config_line(void)
893 int startoffset = 0; /* To first non-blank char in logical line */
894 int len = 0; /* Of logical line so far */
899 /* Loop for handling continuation lines, skipping comments, and dealing with
904 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
906 if (config_file_stack != NULL) /* EOF inside .include */
908 (void)fclose(config_file);
909 config_file = config_file_stack->file;
910 config_filename = config_file_stack->filename;
911 config_directory = config_file_stack->directory;
912 config_lineno = config_file_stack->lineno;
913 config_file_stack = config_file_stack->next;
915 save_config_position(config_filename, config_lineno);
919 /* EOF at top level */
921 if (cstate_stack_ptr >= 0)
922 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
923 "Unexpected end of configuration file: .endif missing");
925 if (len != 0) break; /* EOF after continuation */
926 next_section[0] = 0; /* EOF at start of logical line */
931 newlen = len + Ustrlen(big_buffer + len);
933 if (config_lines && config_lineno == 1)
934 save_config_position(config_filename, config_lineno);
936 /* Handle pathologically long physical lines - yes, it did happen - by
937 extending big_buffer at this point. The code also copes with very long
940 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
943 big_buffer_size += BIG_BUFFER_SIZE;
944 newbuffer = store_malloc(big_buffer_size);
946 /* This use of strcpy is OK because we know that the string in the old
947 buffer is shorter than the new buffer. */
949 Ustrcpy(newbuffer, big_buffer);
950 store_free(big_buffer);
951 big_buffer = newbuffer;
952 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
954 newlen += Ustrlen(big_buffer + newlen);
957 ss = macros_expand(len, &newlen, ¯o_found);
959 /* Check for comment lines - these are physical lines. */
961 if (*ss == '#') continue;
963 /* Handle conditionals, which are also applied to physical lines. Conditions
964 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
965 expansion occurred on the rest of the line. A preliminary test for the leading
966 '.' saves effort on most lines. */
972 /* Search the list of conditional directives */
974 for (i = 0; i < cond_list_size; i++)
977 cond_item *c = cond_list+i;
978 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
980 /* The following character must be white space or end of string */
982 n = ss[1 + c->namelen];
983 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
985 /* .ifdef and .ifndef push the current state onto the stack, then set
986 a new one from the table. Stack overflow is an error */
990 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
992 ".%s nested too deeply", c->name);
993 cstate_stack[++cstate_stack_ptr] = cstate;
994 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
997 /* For any of the others, stack underflow is an error. The next state
998 comes either from the stack (.endif) or from the table. */
1002 if (cstate_stack_ptr < 0)
1003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1004 ".%s without matching .ifdef", c->name);
1005 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1006 next_cstate[cstate][macro_found? c->action1 : c->action2];
1009 /* Having dealt with a directive, break the loop */
1014 /* If we have handled a conditional directive, continue with the next
1015 physical line. Otherwise, fall through. */
1017 if (i < cond_list_size) continue;
1020 /* If the conditional state is not 0 (actively using these lines), ignore
1023 if (cstate != 0) continue; /* Conditional skip */
1025 /* Handle .include lines - these are also physical lines. */
1027 if (Ustrncmp(ss, ".include", 8) == 0 &&
1029 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1032 int include_if_exists = isspace(ss[8])? 0 : 10;
1033 config_file_item *save;
1034 struct stat statbuf;
1036 ss += 9 + include_if_exists;
1037 while (isspace(*ss)) ss++;
1038 t = ss + Ustrlen(ss);
1039 while (t > ss && isspace(t[-1])) t--;
1040 if (*ss == '\"' && t[-1] == '\"')
1047 /* We allow relative file names. For security reasons currently
1048 relative names not allowed with .include_if_exists. For .include_if_exists
1049 we need to check the permissions/ownership of the containing folder */
1051 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1052 "absolute path \"%s\"", ss);
1055 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1056 ss = string_from_gstring(g);
1059 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1062 save_config_position(config_filename, config_lineno);
1063 save = store_get(sizeof(config_file_item));
1064 save->next = config_file_stack;
1065 config_file_stack = save;
1066 save->file = config_file;
1067 save->filename = config_filename;
1068 save->directory = config_directory;
1069 save->lineno = config_lineno;
1071 if (!(config_file = Ufopen(ss, "rb")))
1072 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1073 "configuration file %s", ss);
1075 config_filename = string_copy(ss);
1076 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1081 /* If this is the start of the logical line, remember where the non-blank
1082 data starts. Otherwise shuffle down continuation lines to remove leading
1086 startoffset = ss - big_buffer;
1089 s = big_buffer + len;
1092 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1097 /* Accept the new addition to the line. Remove trailing white space. */
1100 while (len > 0 && isspace(big_buffer[len-1])) len--;
1101 big_buffer[len] = 0;
1103 /* We are done if the line does not end in backslash and contains some data.
1104 Empty logical lines are ignored. For continuations, remove the backslash and
1105 go round the loop to read the continuation line. */
1109 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1110 big_buffer[--len] = 0; /* Remove backslash */
1112 } /* Loop for reading multiple physical lines */
1114 /* We now have a logical line. Test for the end of a configuration section (or,
1115 more accurately, for the start of the next section). Place the name of the next
1116 section in next_section, and return NULL. If the name given is longer than
1117 next_section, truncate it. It will be unrecognized later, because all the known
1118 section names do fit. Leave space for pluralizing. */
1120 s = big_buffer + startoffset; /* First non-space character */
1123 save_config_line(s);
1125 if (strncmpic(s, US"begin ", 6) == 0)
1128 while (isspace(*s)) s++;
1129 if (big_buffer + len - s > sizeof(next_section) - 2)
1130 s[sizeof(next_section) - 2] = 0;
1131 Ustrcpy(next_section, s);
1135 /* Return the first non-blank character. */
1142 /*************************************************
1144 *************************************************/
1146 /* The yield is the pointer to the next uschar. Names longer than the
1147 output space are silently truncated. This function is also used from acl.c when
1151 name where to put the name
1155 Returns: new input pointer
1159 readconf_readname(uschar *name, int len, uschar *s)
1162 while (isspace(*s)) s++;
1165 while (isalnum(*s) || *s == '_')
1167 if (p < len-1) name[p++] = *s;
1172 while (isspace(*s)) s++;
1179 /*************************************************
1180 * Read a time value *
1181 *************************************************/
1183 /* This function is also called from outside, to read argument
1184 time values. The format of a time value is:
1186 [<n>w][<n>d][<n>h][<n>m][<n>s]
1188 as long as at least one is present. If a format error is encountered,
1189 return a negative value. The value must be terminated by the given
1194 terminator required terminating character
1195 return_msec if TRUE, allow fractional seconds and return milliseconds
1197 Returns: the time value, or -1 on syntax error
1198 value is seconds if return_msec is FALSE
1199 value is milliseconds if return_msec is TRUE
1203 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1211 if (!isdigit(*s)) return -1;
1212 (void)sscanf(CCS s, "%d%n", &value, &count);
1217 case 'w': value *= 7;
1218 case 'd': value *= 24;
1219 case 'h': value *= 60;
1220 case 'm': value *= 60;
1225 if (!return_msec) return -1;
1226 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1228 if (*s++ != 's') return -1;
1229 yield += (int)(fraction * 1000.0);
1235 if (return_msec) value *= 1000;
1237 if (*s == terminator) return yield;
1239 /* Control never reaches here. */
1244 /*************************************************
1245 * Read a fixed point value *
1246 *************************************************/
1248 /* The value is returned *1000
1252 terminator required terminator
1254 Returns: the value, or -1 on error
1258 readconf_readfixed(const uschar *s, int terminator)
1262 if (!isdigit(*s)) return -1;
1263 (void)sscanf(CS s, "%d%n", &value, &count);
1265 yield = value * 1000;
1269 while (isdigit((*(++s))))
1271 yield += (*s - '0') * m;
1276 return (*s == terminator)? yield : (-1);
1281 /*************************************************
1282 * Find option in list *
1283 *************************************************/
1285 /* The lists are always in order, so binary chop can be used.
1288 name the option name to search for
1289 ol the first entry in the option list
1290 last one more than the offset of the last entry in the option list
1292 Returns: pointer to an option entry, or NULL if not found
1296 find_option(uschar *name, optionlist *ol, int last)
1299 while (last > first)
1301 int middle = (first + last)/2;
1302 int c = Ustrcmp(name, ol[middle].name);
1304 if (c == 0) return ol + middle;
1305 else if (c > 0) first = middle + 1;
1313 /*************************************************
1314 * Find a set flag in option list *
1315 *************************************************/
1317 /* Because some versions of Unix make no restrictions on the values of uids and
1318 gids (even negative ones), we cannot represent "unset" by a special value.
1319 There is therefore a separate boolean variable for each one indicating whether
1320 a value is set or not. This function returns a pointer to the boolean, given
1321 the original option name. It is a major disaster if the flag cannot be found.
1324 name the name of the uid or gid option
1325 oltop points to the start of the relevant option list
1326 last one more than the offset of the last item in the option list
1327 data_block NULL when reading main options => data values in the option
1328 list are absolute addresses; otherwise they are byte offsets
1329 in data_block (used for driver options)
1331 Returns: a pointer to the boolean flag.
1335 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1339 sprintf(CS name2, "*set_%.50s", name);
1340 ol = find_option(name2, oltop, last);
1341 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1342 "Exim internal error: missing set flag for %s", name);
1343 return (data_block == NULL)? (BOOL *)(ol->value) :
1344 (BOOL *)(US data_block + (long int)(ol->value));
1350 /*************************************************
1351 * Output extra characters message and die *
1352 *************************************************/
1354 /* Called when an option line has junk on the end. Sometimes this is because
1355 the sysadmin thinks comments are permitted.
1358 s points to the extra characters
1359 t1..t3 strings to insert in the log message
1361 Returns: doesn't return; dies
1365 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1367 uschar *comment = US"";
1368 if (*s == '#') comment = US" (# is comment only at line start)";
1369 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1370 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1375 /*************************************************
1376 * Read rewrite information *
1377 *************************************************/
1379 /* Each line of rewrite information contains:
1381 . A complete address in the form user@domain, possibly with
1382 leading * for each part; or alternatively, a regex.
1384 . A replacement string (which will be expanded).
1386 . An optional sequence of one-letter flags, indicating which
1387 headers etc. to apply this rule to.
1389 All this is decoded and placed into a control block. The OR of the flags is
1390 maintained in a common word.
1393 p points to the string that makes up the rule
1394 existflags points to the overall flag word
1395 isglobal TRUE if reading global rewrite rules
1397 Returns: the control block for the parsed rule.
1400 static rewrite_rule *
1401 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1403 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1406 next->key = string_dequote(&p);
1408 while (isspace(*p)) p++;
1410 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1411 "missing rewrite replacement string");
1414 next->replacement = string_dequote(&p);
1416 while (*p != 0) switch (*p++)
1418 case ' ': case '\t': break;
1420 case 'q': next->flags |= rewrite_quit; break;
1421 case 'w': next->flags |= rewrite_whole; break;
1423 case 'h': next->flags |= rewrite_all_headers; break;
1424 case 's': next->flags |= rewrite_sender; break;
1425 case 'f': next->flags |= rewrite_from; break;
1426 case 't': next->flags |= rewrite_to; break;
1427 case 'c': next->flags |= rewrite_cc; break;
1428 case 'b': next->flags |= rewrite_bcc; break;
1429 case 'r': next->flags |= rewrite_replyto; break;
1431 case 'E': next->flags |= rewrite_all_envelope; break;
1432 case 'F': next->flags |= rewrite_envfrom; break;
1433 case 'T': next->flags |= rewrite_envto; break;
1435 case 'Q': next->flags |= rewrite_qualify; break;
1436 case 'R': next->flags |= rewrite_repeat; break;
1439 next->flags |= rewrite_smtp;
1440 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1441 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1442 "rewrite rule has the S flag but is not a regular expression");
1446 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1447 "unknown rewrite flag character '%c' "
1448 "(could be missing quotes round replacement item)", p[-1]);
1452 /* If no action flags are set, set all the "normal" rewrites. */
1454 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1455 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1457 /* Remember which exist, for optimization, and return the rule */
1459 *existflags |= next->flags;
1466 /*************************************************
1467 * Read global rewrite information *
1468 *************************************************/
1470 /* Each line is a single rewrite rule; it is parsed into a control block
1471 by readconf_one_rewrite(), and its flags are ORed into the global flag
1472 word rewrite_existflags. */
1475 readconf_rewrites(void)
1477 rewrite_rule **chain = &global_rewrite_rules;
1480 while ((p = get_config_line()) != NULL)
1482 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1484 chain = &(next->next);
1490 /*************************************************
1492 *************************************************/
1494 /* Strings are read into the normal store pool. As long we aren't too
1495 near the end of the current block, the string will just use what is necessary
1496 on the top of the stacking pool, because string_cat() uses the extension
1500 s the rest of the input line
1501 name the option name (for errors)
1503 Returns: pointer to the string
1507 read_string(const uschar *s, const uschar *name)
1512 if (*s != '\"') return string_copy(s);
1515 yield = string_dequote(&s);
1517 if (s == ss+1 || s[-1] != '\"')
1518 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1519 "missing quote at end of string value for %s", name);
1521 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1527 /*************************************************
1528 * Custom-handler options *
1529 *************************************************/
1531 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1533 if (flags & opt_fn_print)
1535 if (flags & opt_fn_print_label) printf("%s = ", name);
1536 printf("%s\n", smtp_receive_timeout_s
1537 ? string_printing2(smtp_receive_timeout_s, FALSE)
1538 : readconf_printtime(smtp_receive_timeout));
1540 else if (*str == '$')
1541 smtp_receive_timeout_s = string_copy(str);
1544 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1545 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1546 if (smtp_receive_timeout < 0)
1547 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1552 /*************************************************
1553 * Handle option line *
1554 *************************************************/
1556 /* This function is called from several places to process a line containing the
1557 setting of an option. The first argument is the line to be decoded; it has been
1558 checked not to be empty and not to start with '#'. Trailing newlines and white
1559 space have been removed. The second argument is a pointer to the list of
1560 variable names that are to be recognized, together with their types and
1561 locations, and the third argument gives the number of entries in the list.
1563 The fourth argument is a pointer to a data block. If it is NULL, then the data
1564 values in the options list are absolute addresses. Otherwise, they are byte
1565 offsets in the data block.
1567 String option data may continue onto several lines; this function reads further
1568 data from config_file if necessary.
1570 The yield of this function is normally zero. If a string continues onto
1571 multiple lines, then the data value is permitted to be followed by a comma
1572 or a semicolon (for use in drivers) and the yield is that character.
1575 buffer contains the configuration line to be handled
1576 oltop points to the start of the relevant option list
1577 last one more than the offset of the last item in the option list
1578 data_block NULL when reading main options => data values in the option
1579 list are absolute addresses; otherwise they are byte offsets
1580 in data_block when they have opt_public set; otherwise
1581 they are byte offsets in data_block->options_block.
1582 unknown_txt format string to use in panic message for unknown option;
1583 must contain %s for option name
1584 if given as NULL, don't panic on unknown option
1586 Returns: TRUE if an option was read successfully,
1587 FALSE false for an unknown option if unknown_txt == NULL,
1588 otherwise panic and die on an unknown option
1592 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1593 void *data_block, uschar *unknown_txt)
1597 int count, type, value;
1601 BOOL boolvalue = TRUE;
1602 BOOL freesptr = TRUE;
1603 optionlist *ol, *ol2;
1607 uschar *inttype = US"";
1610 uschar **str_target;
1614 /* There may be leading spaces; thereafter, we expect an option name starting
1617 while (isspace(*s)) s++;
1619 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1621 /* Read the name of the option, and skip any subsequent white space. If
1622 it turns out that what we read was "hide", set the flag indicating that
1623 this is a secure option, and loop to read the next word. */
1625 for (int n = 0; n < 2; n++)
1627 while (isalnum(*s) || *s == '_')
1629 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1633 while (isspace(*s)) s++;
1634 if (Ustrcmp(name, "hide") != 0) break;
1635 issecure = opt_secure;
1639 /* Deal with "no_" or "not_" here for booleans */
1641 if (Ustrncmp(name, "no_", 3) == 0)
1647 if (Ustrncmp(name, "not_", 4) == 0)
1653 /* Search the list for the given name. A non-existent name, or an option that
1654 is set twice, is a disaster. */
1656 if (!(ol = find_option(name + offset, oltop, last)))
1658 if (unknown_txt == NULL) return FALSE;
1659 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1662 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1663 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1664 "\"%s\" option set for the second time", name);
1666 ol->type |= opt_set | issecure;
1667 type = ol->type & opt_mask;
1669 /* Types with data values must be followed by '='; the "no[t]_" prefix
1670 applies only to boolean values. */
1672 if (type < opt_bool || type > opt_bool_last)
1675 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1676 "negation prefix applied to a non-boolean option");
1678 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1679 "unexpected end of line (data missing) after %s", name);
1681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1684 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1685 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1686 ultimately expands to one of those values. */
1688 else if (*s != 0 && (offset != 0 || *s != '='))
1689 extra_chars_error(s, US"boolean option ", name, US"");
1691 /* Skip white space after = */
1693 if (*s == '=') while (isspace((*(++s))));
1695 /* If there is a data block and the opt_public flag is not set, change
1696 the data block pointer to the private options block. */
1698 if (data_block != NULL && (ol->type & opt_public) == 0)
1699 data_block = (void *)(((driver_instance *)data_block)->options_block);
1701 /* Now get the data according to the type. */
1705 /* If a string value is not enclosed in quotes, it consists of
1706 the rest of the current line, verbatim. Otherwise, string escapes
1709 A transport is specified as a string, which is then looked up in the
1710 list of transports. A search type is specified as one of a number of
1713 A set or rewrite rules for a driver is specified as a string, which is
1714 then parsed into a suitable chain of control blocks.
1716 Uids and gids are specified as strings which are then looked up in the
1717 passwd file. Lists of uids and gids are similarly specified as colon-
1718 separated strings. */
1723 case opt_expand_uid:
1724 case opt_expand_gid:
1729 reset_point = sptr = read_string(s, name);
1731 /* Having read a string, we now have several different ways of using it,
1732 depending on the data type, so do another switch. If keeping the actual
1733 string is not required (because it is interpreted), freesptr is set TRUE,
1734 and at the end we reset the pool. */
1738 /* If this was a string, set the variable to point to the new string,
1739 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1740 rules, we still keep the string (for printing), and parse the rules into a
1741 control block and flags word. */
1744 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1746 if (ol->type & opt_rep_con)
1748 uschar * saved_condition;
1749 /* We already have a condition, we're conducting a crude hack to let
1750 multiple condition rules be chained together, despite storing them in
1752 *str_target = string_copy_malloc( (saved_condition = *str_target)
1753 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1754 saved_condition, sptr)
1756 /* TODO(pdp): there is a memory leak here and just below
1757 when we set 3 or more conditions; I still don't
1758 understand the store mechanism enough to know
1759 what's the safe way to free content from an earlier store.
1760 AFAICT, stores stack, so freeing an early stored item also stores
1761 all data alloc'd after it. If we knew conditions were adjacent,
1762 we could survive that, but we don't. So I *think* we need to take
1763 another bit from opt_type to indicate "malloced"; this seems like
1764 quite a hack, especially for this one case. It also means that
1765 we can't ever reclaim the store from the *first* condition.
1767 Because we only do this once, near process start-up, I'm prepared to
1768 let this slide for the time being, even though it rankles. */
1770 else if (ol->type & opt_rep_str)
1772 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1773 int sep_i = -(int)sep_o;
1774 const uschar * list = sptr;
1776 gstring * list_o = NULL;
1780 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1781 list_o = string_cat(list_o, *str_target);
1784 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1785 list_o = string_append_listele(list_o, sep_o, s);
1788 *str_target = string_copy_malloc(string_from_gstring(list_o));
1799 *USS (US data_block + (long int)(ol->value)) = sptr;
1801 *USS (ol->value) = sptr;
1803 if (type == opt_rewrite)
1808 rewrite_rule **chain;
1811 sprintf(CS name2, "*%.50s_rules", name);
1812 ol2 = find_option(name2, oltop, last);
1813 sprintf(CS name2, "*%.50s_flags", name);
1814 ol3 = find_option(name2, oltop, last);
1816 if (ol2 == NULL || ol3 == NULL)
1817 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1818 "rewrite rules not available for driver");
1820 if (data_block == NULL)
1822 chain = (rewrite_rule **)(ol2->value);
1823 flagptr = (int *)(ol3->value);
1827 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1828 flagptr = (int *)(US data_block + (long int)(ol3->value));
1831 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1833 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1835 chain = &(next->next);
1838 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1839 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1840 "non-header rewrite - not allowed at transport time -");
1844 /* If it was an expanded uid, see if there is any expansion to be
1845 done by checking for the presence of a $ character. If there is, save it
1846 in the corresponding *expand_user option field. Otherwise, fall through
1847 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1850 case opt_expand_uid:
1851 sprintf(CS name2, "*expand_%.50s", name);
1852 ol2 = find_option(name2, oltop, last);
1855 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1857 if (data_block == NULL)
1858 *((uschar **)(ol2->value)) = ss;
1860 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1864 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1870 /* Look up a fixed uid, and also make use of the corresponding gid
1871 if a passwd entry is returned and the gid has not been set. */
1874 if (!route_finduser(sptr, &pw, &uid))
1875 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1876 if (data_block == NULL)
1877 *((uid_t *)(ol->value)) = uid;
1879 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1881 /* Set the flag indicating a fixed value is set */
1883 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1885 /* Handle matching gid if we have a passwd entry: done by finding the
1886 same name with terminating "user" changed to "group"; if not found,
1887 ignore. Also ignore if the value is already set. */
1889 if (pw == NULL) break;
1890 Ustrcpy(name+Ustrlen(name)-4, "group");
1891 ol2 = find_option(name, oltop, last);
1892 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1893 (ol2->type & opt_mask) == opt_expand_gid))
1895 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1898 if (data_block == NULL)
1899 *((gid_t *)(ol2->value)) = pw->pw_gid;
1901 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1907 /* If it was an expanded gid, see if there is any expansion to be
1908 done by checking for the presence of a $ character. If there is, save it
1909 in the corresponding *expand_user option field. Otherwise, fall through
1910 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1913 case opt_expand_gid:
1914 sprintf(CS name2, "*expand_%.50s", name);
1915 ol2 = find_option(name2, oltop, last);
1918 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1920 if (data_block == NULL)
1921 *((uschar **)(ol2->value)) = ss;
1923 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1927 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1933 /* Handle freestanding gid */
1936 if (!route_findgroup(sptr, &gid))
1937 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1938 if (data_block == NULL)
1939 *((gid_t *)(ol->value)) = gid;
1941 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1942 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1945 /* If it was a uid list, look up each individual entry, and build
1946 a vector of uids, with a count in the first element. Put the vector
1947 in malloc store so we can free the string. (We are reading into
1948 permanent store already.) */
1956 const uschar *op = expand_string (sptr);
1959 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1960 name, expand_string_message);
1963 if (*p != 0) count++;
1964 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1965 list = store_malloc(count*sizeof(uid_t));
1966 list[ptr++] = (uid_t)(count - 1);
1968 if (data_block == NULL)
1969 *((uid_t **)(ol->value)) = list;
1971 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1977 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1978 if (!route_finduser(big_buffer, NULL, &uid))
1979 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1986 /* If it was a gid list, look up each individual entry, and build
1987 a vector of gids, with a count in the first element. Put the vector
1988 in malloc store so we can free the string. (We are reading into permanent
1997 const uschar *op = expand_string (sptr);
2000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2001 name, expand_string_message);
2004 if (*p != 0) count++;
2005 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2006 list = store_malloc(count*sizeof(gid_t));
2007 list[ptr++] = (gid_t)(count - 1);
2009 if (data_block == NULL)
2010 *((gid_t **)(ol->value)) = list;
2012 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2018 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2019 if (!route_findgroup(big_buffer, &gid))
2020 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2028 /* Release store if the value of the string doesn't need to be kept. */
2030 if (freesptr) store_reset(reset_point);
2033 /* Expanded boolean: if no characters follow, or if there are no dollar
2034 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2035 save the string for later expansion in the alternate place. */
2037 case opt_expand_bool:
2038 if (*s != 0 && Ustrchr(s, '$') != 0)
2040 sprintf(CS name2, "*expand_%.50s", name);
2041 ol2 = find_option(name2, oltop, last);
2044 reset_point = sptr = read_string(s, name);
2045 if (data_block == NULL)
2046 *((uschar **)(ol2->value)) = sptr;
2048 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2055 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2056 look for yes/not/true/false. Some booleans are stored in a single bit in
2057 a single int. There's a special fudge for verify settings; without a suffix
2058 they set both xx_sender and xx_recipient. The table points to the sender
2059 value; search subsequently for the recipient. There's another special case:
2060 opt_bool_set also notes when a boolean has been set. */
2064 case opt_bool_verify:
2068 s = readconf_readname(name2, 64, s);
2069 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2071 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2073 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2074 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2075 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2076 US"for boolean option ", name);
2079 /* Handle single-bit type. */
2081 if (type == opt_bit)
2083 int bit = 1 << ((ol->type >> 16) & 31);
2084 int *ptr = (data_block == NULL)?
2085 (int *)(ol->value) :
2086 (int *)(US data_block + (long int)ol->value);
2087 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2091 /* Handle full BOOL types */
2093 if (data_block == NULL)
2094 *((BOOL *)(ol->value)) = boolvalue;
2096 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2100 if (type == opt_bool_verify)
2102 sprintf(CS name2, "%.50s_recipient", name + offset);
2103 ol2 = find_option(name2, oltop, last);
2106 if (data_block == NULL)
2107 *((BOOL *)(ol2->value)) = boolvalue;
2109 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2113 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2115 else if (type == opt_bool_set)
2117 sprintf(CS name2, "*set_%.50s", name + offset);
2118 ol2 = find_option(name2, oltop, last);
2121 if (data_block == NULL)
2122 *((BOOL *)(ol2->value)) = TRUE;
2124 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2133 inttype = US"octal ";
2135 /* Integer: a simple(ish) case; allow octal and hex formats, and
2136 suffixes K, M, G, and T. The different types affect output, not input. */
2145 lvalue = strtol(CS s, CSS &endptr, intbase);
2148 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2151 if (errno != ERANGE && *endptr)
2153 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2155 if ((mp = Ustrchr(mp, *endptr)))
2160 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2171 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2172 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2173 "absolute value of integer \"%s\" is too large (overflow)", s);
2175 while (isspace(*endptr)) endptr++;
2177 extra_chars_error(endptr, inttype, US"integer value for ", name);
2179 value = (int)lvalue;
2183 *(int *)(US data_block + (long int)ol->value) = value;
2185 *(int *)ol->value = value;
2188 /* Integer held in K: again, allow formats and suffixes as above. */
2194 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2197 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2200 if (errno != ERANGE && *endptr)
2202 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2204 if ((mp = Ustrchr(mp, *endptr)))
2209 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2218 lvalue = (lvalue + 512)/1024;
2221 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2222 "absolute value of integer \"%s\" is too large (overflow)", s);
2224 while (isspace(*endptr)) endptr++;
2226 extra_chars_error(endptr, inttype, US"integer value for ", name);
2229 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2231 *(int_eximarith_t *)ol->value = lvalue;
2235 /* Fixed-point number: held to 3 decimal places. */
2238 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2239 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2240 "fixed-point number expected for %s", name);
2242 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2243 "integer \"%s\" is too large (overflow)", s);
2247 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2248 "integer \"%s\" is too large (overflow)", s);
2250 /* We get a coverity error here for using count, as it derived
2251 from the tainted buffer pointed to by s, as parsed by sscanf().
2252 By the definition of sscanf we must be accessing between start
2253 and end of s (assuming it is nul-terminated...) so ignore the error. */
2254 /* coverity[tainted_data] */
2255 if (s[count] == '.')
2258 while (isdigit(s[++count]))
2260 value += (s[count] - '0') * d;
2265 while (isspace(s[count])) count++;
2268 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2270 if (data_block == NULL)
2271 *((int *)(ol->value)) = value;
2273 *((int *)(US data_block + (long int)(ol->value))) = value;
2276 /* There's a special routine to read time values. */
2279 value = readconf_readtime(s, 0, FALSE);
2281 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2283 if (data_block == NULL)
2284 *((int *)(ol->value)) = value;
2286 *((int *)(US data_block + (long int)(ol->value))) = value;
2289 /* A time list is a list of colon-separated times, with the first
2290 element holding the size of the list and the second the number of
2296 int *list = (data_block == NULL)?
2297 (int *)(ol->value) :
2298 (int *)(US data_block + (long int)(ol->value));
2300 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2303 uschar *snext = Ustrchr(s, ':');
2307 while (ss > s && isspace(ss[-1])) ss--;
2310 value = readconf_readtime(s, terminator, FALSE);
2312 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2314 if (count > 1 && value <= list[count])
2315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2316 "time value out of order for %s", name);
2317 list[count+1] = value;
2318 if (snext == NULL) break;
2320 while (isspace(*s)) s++;
2323 if (count > list[0] - 2)
2324 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2326 if (count > 0 && list[2] == 0) count = 0;
2333 void (*fn)() = ol->value;
2344 /*************************************************
2345 * Print a time value *
2346 *************************************************/
2349 Argument: a time value in seconds
2350 Returns: pointer to a fixed buffer containing the time as a string,
2351 in readconf_readtime() format
2355 readconf_printtime(int t)
2358 uschar *p = time_buffer;
2375 if (w > 0) p += sprintf(CS p, "%dw", w);
2376 if (d > 0) p += sprintf(CS p, "%dd", d);
2377 if (h > 0) p += sprintf(CS p, "%dh", h);
2378 if (m > 0) p += sprintf(CS p, "%dm", m);
2379 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2386 /*************************************************
2387 * Print an individual option value *
2388 *************************************************/
2390 /* This is used by the -bP option, so prints to the standard output.
2391 The entire options list is passed in as an argument, because some options come
2392 in pairs - typically uid/gid settings, which can either be explicit numerical
2393 values, or strings to be expanded later. If the numerical value is unset,
2394 search for "*expand_<name>" to see if there is a string equivalent.
2397 ol option entry, or NULL for an unknown option
2399 options_block NULL for main configuration options; otherwise points to
2400 a driver block; if the option doesn't have opt_public
2401 set, then options_block->options_block is where the item
2403 oltop points to the option list in which ol exists
2404 last one more than the offset of the last entry in optop
2405 no_labels do not show "foo = " at the start.
2407 Returns: boolean success
2411 print_ol(optionlist *ol, uschar *name, void *options_block,
2412 optionlist *oltop, int last, BOOL no_labels)
2425 printf("%s is not a known option\n", name);
2429 /* Non-admin callers cannot see options that have been flagged secure by the
2432 if (!f.admin_user && ol->type & opt_secure)
2435 printf("%s\n", hidden);
2437 printf("%s = %s\n", name, hidden);
2441 /* Else show the value of the option */
2446 if (!(ol->type & opt_public))
2447 options_block = (void *)(((driver_instance *)options_block)->options_block);
2448 value = (void *)(US options_block + (long int)value);
2451 switch(ol->type & opt_mask)
2454 case opt_rewrite: /* Show the text value */
2456 if (!no_labels) printf("%s = ", name);
2457 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2461 if (!no_labels) printf("%s = ", name);
2462 printf("%d\n", *((int *)value));
2467 int x = *((int *)value);
2468 if (x != 0 && (x & 1023) == 0)
2472 if ((x & 1023) == 0)
2477 if (!no_labels) printf("%s = ", name);
2478 printf("%d%c\n", x, c);
2482 if (!no_labels) printf("%s = ", name);
2490 int_eximarith_t x = *((int_eximarith_t *)value);
2491 if (!no_labels) printf("%s = ", name);
2492 if (x == 0) printf("0\n");
2493 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2494 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2495 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2496 else printf(PR_EXIM_ARITH "K\n", x);
2501 if (!no_labels) printf("%s = ", name);
2502 printf("%#o\n", *((int *)value));
2505 /* Can be negative only when "unset", in which case integer */
2509 int x = *((int *)value);
2512 if (x < 0) printf("%s =\n", name); else
2514 if (!no_labels) printf("%s = ", name);
2515 printf("%d.", x/1000);
2528 /* If the numerical value is unset, try for the string value */
2530 case opt_expand_uid:
2531 if (! *get_set_flag(name, oltop, last, options_block))
2533 sprintf(CS name2, "*expand_%.50s", name);
2534 if ((ol2 = find_option(name2, oltop, last)))
2536 void *value2 = ol2->value;
2538 value2 = (void *)(US options_block + (long int)value2);
2540 if (!no_labels) printf("%s = ", name);
2541 printf("%s\n", s ? string_printing(s) : US"");
2546 /* Else fall through */
2549 if (!no_labels) printf("%s = ", name);
2550 if (! *get_set_flag(name, oltop, last, options_block))
2553 if ((pw = getpwuid(*((uid_t *)value))))
2554 printf("%s\n", pw->pw_name);
2556 printf("%ld\n", (long int)(*((uid_t *)value)));
2559 /* If the numerical value is unset, try for the string value */
2561 case opt_expand_gid:
2562 if (! *get_set_flag(name, oltop, last, options_block))
2564 sprintf(CS name2, "*expand_%.50s", name);
2565 if ( (ol2 = find_option(name2, oltop, last))
2566 && (ol2->type & opt_mask) == opt_stringptr)
2568 void *value2 = ol2->value;
2570 value2 = (void *)(US options_block + (long int)value2);
2572 if (!no_labels) printf("%s = ", name);
2573 printf("%s\n", s ? string_printing(s) : US"");
2578 /* Else fall through */
2581 if (!no_labels) printf("%s = ", name);
2582 if (! *get_set_flag(name, oltop, last, options_block))
2585 if ((gr = getgrgid(*((int *)value))))
2586 printf("%s\n", gr->gr_name);
2588 printf("%ld\n", (long int)(*((int *)value)));
2592 uidlist = *((uid_t **)value);
2593 if (!no_labels) printf("%s =", name);
2596 uschar sep = no_labels ? '\0' : ' ';
2597 for (int i = 1; i <= (int)(uidlist[0]); i++)
2599 uschar *name = NULL;
2600 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2601 if (sep != '\0') printf("%c", sep);
2602 if (name) printf("%s", name);
2603 else printf("%ld", (long int)(uidlist[i]));
2611 gidlist = *((gid_t **)value);
2612 if (!no_labels) printf("%s =", name);
2615 uschar sep = no_labels ? '\0' : ' ';
2616 for (int i = 1; i <= (int)(gidlist[0]); i++)
2618 uschar *name = NULL;
2619 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2620 if (sep != '\0') printf("%c", sep);
2621 if (name) printf("%s", name);
2622 else printf("%ld", (long int)(gidlist[i]));
2630 if (!no_labels) printf("%s = ", name);
2631 printf("%s\n", readconf_printtime(*((int *)value)));
2636 int *list = (int *)value;
2637 if (!no_labels) printf("%s = ", name);
2638 for (int i = 0; i < list[1]; i++)
2639 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2645 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2649 case opt_expand_bool:
2650 sprintf(CS name2, "*expand_%.50s", name);
2651 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2653 void *value2 = ol2->value;
2655 value2 = (void *)(US options_block + (long int)value2);
2659 if (!no_labels) printf("%s = ", name);
2660 printf("%s\n", string_printing(s));
2663 /* s == NULL => string not set; fall through */
2669 case opt_bool_verify:
2671 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2676 void (*fn)() = ol->value;
2677 fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2686 /*************************************************
2687 * Print value from main configuration *
2688 *************************************************/
2690 /* This function, called as a result of encountering the -bP option,
2691 causes the value of any main configuration variable to be output if the
2692 second argument is NULL. There are some special values:
2694 all print all main configuration options
2695 config_file print the name of the configuration file
2696 (configure_file will still work, for backward
2698 routers print the routers' configurations
2699 transports print the transports' configuration
2700 authenticators print the authenticators' configuration
2701 macros print the macros' configuration
2702 router_list print a list of router names
2703 transport_list print a list of transport names
2704 authenticator_list print a list of authentication mechanism names
2705 macro_list print a list of macro names
2706 +name print a named list item
2707 local_scan print the local_scan options
2708 config print the configuration as it is parsed
2709 environment print the used execution environment
2711 If the second argument is not NULL, it must be one of "router", "transport",
2712 "authenticator" or "macro" in which case the first argument identifies the
2713 driver whose options are to be printed.
2716 name option name if type == NULL; else driver name
2717 type NULL or driver type name, as described above
2718 no_labels avoid the "foo = " at the start of an item
2720 Returns: Boolean success
2724 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2726 BOOL names_only = FALSE;
2727 optionlist *ol2 = NULL;
2728 driver_instance *d = NULL;
2737 static uschar *types[] = { US"address", US"domain", US"host",
2739 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2740 &hostlist_anchor, &localpartlist_anchor };
2742 for (int i = 0; i < 4; i++)
2743 if ((t = tree_search(*(anchors[i]), name+1)))
2747 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2749 printf("%slist %s = %s\n", types[i], name+1,
2750 ((namedlist_block *)(t->data.ptr))->string);
2754 printf("no address, domain, host, or local part list called \"%s\" "
2755 "exists\n", name+1);
2760 if ( Ustrcmp(name, "configure_file") == 0
2761 || Ustrcmp(name, "config_file") == 0)
2763 printf("%s\n", CS config_main_filename);
2767 if (Ustrcmp(name, "all") == 0)
2769 for (optionlist * ol = optionlist_config;
2770 ol < optionlist_config + nelem(optionlist_config); ol++)
2771 if (!(ol->type & opt_hidden))
2772 (void) print_ol(ol, US ol->name, NULL,
2773 optionlist_config, nelem(optionlist_config),
2778 if (Ustrcmp(name, "local_scan") == 0)
2780 #ifndef LOCAL_SCAN_HAS_OPTIONS
2781 printf("local_scan() options are not supported\n");
2784 for (optionlist * ol = local_scan_options;
2785 ol < local_scan_options + local_scan_options_count; ol++)
2786 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2787 local_scan_options_count, no_labels);
2792 if (Ustrcmp(name, "config") == 0)
2794 print_config(f.admin_user, no_labels);
2798 if (Ustrcmp(name, "routers") == 0)
2803 else if (Ustrcmp(name, "transports") == 0)
2805 type = US"transport";
2808 else if (Ustrcmp(name, "authenticators") == 0)
2810 type = US"authenticator";
2813 else if (Ustrcmp(name, "macros") == 0)
2818 else if (Ustrcmp(name, "router_list") == 0)
2824 else if (Ustrcmp(name, "transport_list") == 0)
2826 type = US"transport";
2830 else if (Ustrcmp(name, "authenticator_list") == 0)
2832 type = US"authenticator";
2836 else if (Ustrcmp(name, "macro_list") == 0)
2842 else if (Ustrcmp(name, "environment") == 0)
2847 for (p = USS environ; *p; p++) ;
2848 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2850 for (p = USS environ; *p; p++)
2853 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2861 return print_ol(find_option(name,
2862 optionlist_config, nelem(optionlist_config)),
2863 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2866 /* Handle the options for a router or transport. Skip options that are flagged
2867 as hidden. Some of these are options with names starting with '*', used for
2868 internal alternative representations of other options (which the printing
2869 function will sort out). Others are synonyms kept for backward compatibility.
2872 if (Ustrcmp(type, "router") == 0)
2874 d = (driver_instance *)routers;
2875 ol2 = optionlist_routers;
2876 size = optionlist_routers_size;
2878 else if (Ustrcmp(type, "transport") == 0)
2880 d = (driver_instance *)transports;
2881 ol2 = optionlist_transports;
2882 size = optionlist_transports_size;
2884 else if (Ustrcmp(type, "authenticator") == 0)
2886 d = (driver_instance *)auths;
2887 ol2 = optionlist_auths;
2888 size = optionlist_auths_size;
2891 else if (Ustrcmp(type, "macro") == 0)
2893 /* People store passwords in macros and they were previously not available
2894 for printing. So we have an admin_users restriction. */
2897 fprintf(stderr, "exim: permission denied\n");
2900 for (macro_item * m = macros; m; m = m->next)
2901 if (!name || Ustrcmp(name, m->name) == 0)
2904 printf("%s\n", CS m->name);
2906 printf("%s\n", CS m->replacement);
2908 printf("%s=%s\n", CS m->name, CS m->replacement);
2912 if (!name) return TRUE;
2914 printf("%s %s not found\n", type, name);
2920 for (; d; d = d->next) printf("%s\n", CS d->name);
2924 /* Either search for a given driver, or print all of them */
2926 for (; d; d = d->next)
2930 printf("\n%s %s:\n", d->name, type);
2931 else if (Ustrcmp(d->name, name) != 0) continue;
2933 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2934 if (!(ol->type & opt_hidden))
2935 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2937 for (optionlist * ol = d->info->options;
2938 ol < d->info->options + *(d->info->options_count); ol++)
2939 if (!(ol->type & opt_hidden))
2940 rc |= print_ol(ol, US ol->name, d, d->info->options,
2941 *d->info->options_count, no_labels);
2943 if (name) return rc;
2945 if (!name) return TRUE;
2947 printf("%s %s not found\n", type, name);
2953 /*************************************************
2954 * Read a named list item *
2955 *************************************************/
2957 /* This function reads a name and a list (i.e. string). The name is used to
2958 save the list in a tree, sorted by its name. Each entry also has a number,
2959 which can be used for caching tests, but if the string contains any expansion
2960 items other than $key, the number is set negative to inhibit caching. This
2961 mechanism is used for domain, host, and address lists that are referenced by
2965 anchorp points to the tree anchor
2966 numberp points to the current number for this tree
2967 max the maximum number permitted
2968 s the text of the option line, starting immediately after the name
2970 tname the name of the list type, for messages
2976 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2979 BOOL forcecache = FALSE;
2982 namedlist_block *nb = store_get(sizeof(namedlist_block));
2984 if (Ustrncmp(s, "_cache", 6) == 0)
2991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2993 if (*numberp >= max)
2994 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2997 while (isspace(*s)) s++;
2999 while (isalnum(*s) || *s == '_') s++;
3000 t = store_get(sizeof(tree_node) + s-ss);
3001 Ustrncpy(t->name, ss, s-ss);
3003 while (isspace(*s)) s++;
3005 if (!tree_insertnode(anchorp, t))
3006 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3007 "duplicate name \"%s\" for a named %s", t->name, tname);
3010 nb->number = *numberp;
3013 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3014 "missing '=' after \"%s\"", t->name);
3015 while (isspace(*s)) s++;
3016 nb->string = read_string(s, t->name);
3017 nb->cache_data = NULL;
3019 /* Check the string for any expansions; if any are found, mark this list
3020 uncacheable unless the user has explicited forced caching. */
3022 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3028 /*************************************************
3029 * Unpick data for a rate limit *
3030 *************************************************/
3032 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3036 s string, in the form t,b,f,l
3037 where t is the threshold (integer)
3038 b is the initial delay (time)
3039 f is the multiplicative factor (fixed point)
3040 k is the maximum time (time)
3041 threshold where to store threshold
3042 base where to store base in milliseconds
3043 factor where to store factor in milliseconds
3044 limit where to store limit
3046 Returns: nothing (panics on error)
3050 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3053 uschar bstring[16], lstring[16];
3055 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3056 factor, lstring) == 4)
3058 *base = readconf_readtime(bstring, 0, TRUE);
3059 *limit = readconf_readtime(lstring, 0, TRUE);
3060 if (*base >= 0 && *limit >= 0) return;
3062 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3068 /*************************************************
3069 * Drop privs for checking TLS config *
3070 *************************************************/
3072 /* We want to validate TLS options during readconf, but do not want to be
3073 root when we call into the TLS library, in case of library linkage errors
3074 which cause segfaults; before this check, those were always done as the Exim
3075 runtime user and it makes sense to continue with that.
3077 Assumes: tls_require_ciphers has been set, if it will be
3078 exim_user has been set, if it will be
3079 exim_group has been set, if it will be
3081 Returns: bool for "okay"; false will cause caller to immediately exit.
3086 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3088 const uschar *errmsg;
3091 void (*oldsignal)(int);
3093 /* If TLS will never be used, no point checking ciphers */
3095 if ( !tls_advertise_hosts
3096 || !*tls_advertise_hosts
3097 || Ustrcmp(tls_advertise_hosts, ":") == 0
3100 else if (!nowarn && !tls_certificate)
3101 log_write(0, LOG_MAIN,
3102 "Warning: No server certificate defined; will use a selfsigned one.\n"
3103 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3105 oldsignal = signal(SIGCHLD, SIG_DFL);
3108 if ((pid = fork()) < 0)
3109 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3113 /* in some modes, will have dropped privilege already */
3115 exim_setugid(exim_uid, exim_gid, FALSE,
3116 US"calling tls_validate_require_cipher");
3118 if ((errmsg = tls_validate_require_cipher()))
3119 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3120 "tls_require_ciphers invalid: %s", errmsg);
3126 rc = waitpid(pid, &status, 0);
3127 } while (rc < 0 && errno == EINTR);
3130 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3133 signal(SIGCHLD, oldsignal);
3137 #endif /* SUPPORT_TLS */
3142 /*************************************************
3143 * Read main configuration options *
3144 *************************************************/
3146 /* This function is the first to be called for configuration reading. It
3147 opens the configuration file and reads general configuration settings until
3148 it reaches the end of the configuration section. The file is then left open so
3149 that the remaining configuration data can subsequently be read if needed for
3152 The configuration file must be owned either by root or exim, and be writeable
3153 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3154 in the config file, so the test is done on the compiled in values. A slight
3155 anomaly, to be carefully documented.
3157 The name of the configuration file is taken from a list that is included in the
3158 binary of Exim. It can be altered from the command line, but if that is done,
3159 root privilege is immediately withdrawn unless the caller is root or exim.
3160 The first file on the list that exists is used.
3162 For use on multiple systems that share file systems, first look for a
3163 configuration file whose name has the current node name on the end. If that is
3164 not found, try the generic name. For really contorted configurations, that run
3165 multiple Exims with different uid settings, first try adding the effective uid
3166 before the node name. These complications are going to waste resources on most
3167 systems. Therefore they are available only when requested by compile-time
3171 readconf_main(BOOL nowarn)
3174 struct stat statbuf;
3175 uschar *s, *filename;
3176 const uschar *list = config_main_filelist;
3178 /* Loop through the possible file names */
3180 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3183 /* Cut out all the fancy processing unless specifically wanted */
3185 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3186 uschar *suffix = filename + Ustrlen(filename);
3188 /* Try for the node-specific file if a node name exists */
3190 #ifdef CONFIGURE_FILE_USE_NODE
3192 if (uname(&uts) >= 0)
3194 #ifdef CONFIGURE_FILE_USE_EUID
3195 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3196 config_file = Ufopen(filename, "rb");
3197 if (config_file == NULL)
3198 #endif /* CONFIGURE_FILE_USE_EUID */
3200 sprintf(CS suffix, ".%.256s", uts.nodename);
3201 config_file = Ufopen(filename, "rb");
3204 #endif /* CONFIGURE_FILE_USE_NODE */
3206 /* Otherwise, try the generic name, possibly with the euid added */
3208 #ifdef CONFIGURE_FILE_USE_EUID
3209 if (config_file == NULL)
3211 sprintf(CS suffix, ".%ld", (long int)original_euid);
3212 config_file = Ufopen(filename, "rb");
3214 #endif /* CONFIGURE_FILE_USE_EUID */
3216 /* Finally, try the unadorned name */
3218 if (config_file == NULL)
3221 config_file = Ufopen(filename, "rb");
3223 #else /* if neither defined */
3225 /* This is the common case when the fancy processing is not included. */
3227 config_file = Ufopen(filename, "rb");
3230 /* If the file does not exist, continue to try any others. For any other
3231 error, break out (and die). */
3233 if (config_file != NULL || errno != ENOENT) break;
3236 /* On success, save the name for verification; config_filename is used when
3237 logging configuration errors (it changes for .included files) whereas
3238 config_main_filename is the name shown by -bP. Failure to open a configuration
3239 file is a serious disaster. */
3243 uschar *last_slash = Ustrrchr(filename, '/');
3244 config_filename = config_main_filename = string_copy(filename);
3246 /* The config_main_directory we need for the $config_dir expansion.
3247 config_main_filename we need for $config_file expansion.
3248 And config_dir is the directory of the current configuration, used for
3249 relative .includes. We do need to know it's name, as we change our working
3252 if (filename[0] == '/')
3253 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3256 /* relative configuration file name: working dir + / + basename(filename) */
3258 uschar buf[PATH_MAX];
3261 if (os_getcwd(buf, PATH_MAX) == NULL)
3263 perror("exim: getcwd");
3266 g = string_cat(NULL, buf);
3268 /* If the dir does not end with a "/", append one */
3269 if (g->s[g->ptr-1] != '/')
3270 g = string_catn(g, US"/", 1);
3272 /* If the config file contains a "/", extract the directory part */
3274 g = string_catn(g, filename, last_slash - filename);
3276 config_main_directory = string_from_gstring(g);
3278 config_directory = config_main_directory;
3282 if (filename == NULL)
3283 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3284 "%s", config_main_filelist);
3286 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3287 "configuration file %s", filename));
3290 /* Now, once we found and opened our configuration file, we change the directory
3291 to a safe place. Later we change to $spool_directory. */
3293 if (Uchdir("/") < 0)
3295 perror("exim: chdir `/': ");
3299 /* Check the status of the file we have opened, if we have retained root
3300 privileges and the file isn't /dev/null (which *should* be 0666). */
3302 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3304 if (fstat(fileno(config_file), &statbuf) != 0)
3305 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3308 if ((statbuf.st_uid != root_uid /* owner not root */
3309 #ifdef CONFIGURE_OWNER
3310 && statbuf.st_uid != config_uid /* owner not the special one */
3313 (statbuf.st_gid != root_gid /* group not root & */
3314 #ifdef CONFIGURE_GROUP
3315 && statbuf.st_gid != config_gid /* group not the special one */
3317 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3319 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3321 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3322 "wrong owner, group, or mode", big_buffer);
3325 /* Process the main configuration settings. They all begin with a lower case
3326 letter. If we see something starting with an upper case letter, it is taken as
3327 a macro definition. */
3329 while ((s = get_config_line()))
3331 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3333 "found unexpected BOM (Byte Order Mark)");
3336 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3338 else if (Ustrncmp(s, "domainlist", 10) == 0)
3339 read_named_list(&domainlist_anchor, &domainlist_count,
3340 MAX_NAMED_LIST, s+10, US"domain list");
3342 else if (Ustrncmp(s, "hostlist", 8) == 0)
3343 read_named_list(&hostlist_anchor, &hostlist_count,
3344 MAX_NAMED_LIST, s+8, US"host list");
3346 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3347 read_named_list(&addresslist_anchor, &addresslist_count,
3348 MAX_NAMED_LIST, s+11, US"address list");
3350 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3351 read_named_list(&localpartlist_anchor, &localpartlist_count,
3352 MAX_NAMED_LIST, s+13, US"local part list");
3355 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3356 NULL, US"main option \"%s\" unknown");
3360 /* If local_sender_retain is set, local_from_check must be unset. */
3362 if (local_sender_retain && local_from_check)
3363 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3364 "local_sender_retain are set; this combination is not allowed");
3366 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3369 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3371 /* The max retry interval must not be greater than 24 hours. */
3373 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3375 /* remote_max_parallel must be > 0 */
3377 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3379 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3380 start of a new SMTP message. */
3382 freeze_tell_config = freeze_tell;
3384 /* The primary host name may be required for expansion of spool_directory
3385 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3386 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3387 canonize it. Some people like upper case letters in their host names, so we
3388 don't force the case. */
3390 if (primary_hostname == NULL)
3392 const uschar *hostname;
3394 if (uname(&uts) < 0)
3395 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3396 hostname = US uts.nodename;
3398 if (Ustrchr(hostname, '.') == NULL)
3401 struct hostent *hostdata;
3404 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3405 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3406 MCL_DOMAIN, TRUE, NULL) != OK))
3415 #if HAVE_GETIPNODEBYNAME
3417 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3419 hostdata = gethostbyname2(CS hostname, af);
3422 hostdata = gethostbyname(CS hostname);
3425 if (hostdata != NULL)
3427 hostname = US hostdata->h_name;
3431 if (af == AF_INET) break;
3436 primary_hostname = string_copy(hostname);
3439 /* Set up default value for smtp_active_hostname */
3441 smtp_active_hostname = primary_hostname;
3443 /* If spool_directory wasn't set in the build-time configuration, it must have
3444 got set above. Of course, writing to the log may not work if log_file_path is
3445 not set, but it will at least get to syslog or somewhere, with any luck. */
3447 if (*spool_directory == 0)
3448 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3451 /* Expand the spool directory name; it may, for example, contain the primary
3452 host name. Same comment about failure. */
3454 s = expand_string(spool_directory);
3456 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3457 "\"%s\": %s", spool_directory, expand_string_message);
3458 spool_directory = s;
3460 /* Expand log_file_path, which must contain "%s" in any component that isn't
3461 the null string or "syslog". It is also allowed to contain one instance of %D
3462 or %M. However, it must NOT contain % followed by anything else. */
3464 if (*log_file_path != 0)
3466 const uschar *ss, *sss;
3467 int sep = ':'; /* Fixed for log file path */
3468 s = expand_string(log_file_path);
3470 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3471 "\"%s\": %s", log_file_path, expand_string_message);
3474 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3477 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3478 t = Ustrstr(sss, "%s");
3480 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3481 "contain \"%%s\"", sss);
3483 t = Ustrchr(sss, '%');
3486 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3487 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3488 "unexpected \"%%\" character", s);
3495 /* Interpret syslog_facility into an integer argument for 'ident' param to
3496 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3499 if (syslog_facility_str)
3502 uschar *s = syslog_facility_str;
3504 if ((Ustrlen(syslog_facility_str) >= 4) &&
3505 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3508 for (i = 0; i < syslog_list_size; i++)
3509 if (strcmpic(s, syslog_list[i].name) == 0)
3511 syslog_facility = syslog_list[i].value;
3515 if (i >= syslog_list_size)
3516 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3517 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3520 /* Expand pid_file_path */
3522 if (*pid_file_path != 0)
3524 if (!(s = expand_string(pid_file_path)))
3525 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3526 "\"%s\": %s", pid_file_path, expand_string_message);
3530 /* Set default value of process_log_path */
3532 if (!process_log_path || *process_log_path =='\0')
3533 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3535 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3538 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3540 /* Unpick the SMTP rate limiting options, if set */
3542 if (smtp_ratelimit_mail)
3543 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3544 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3546 if (smtp_ratelimit_rcpt)
3547 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3548 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3550 /* The qualify domains default to the primary host name */
3552 if (!qualify_domain_sender)
3553 qualify_domain_sender = primary_hostname;
3554 if (!qualify_domain_recipient)
3555 qualify_domain_recipient = qualify_domain_sender;
3557 /* Setting system_filter_user in the configuration sets the gid as well if a
3558 name is given, but a numerical value does not. */
3560 if (system_filter_uid_set && !system_filter_gid_set)
3562 struct passwd *pw = getpwuid(system_filter_uid);
3564 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3565 (long int)system_filter_uid);
3566 system_filter_gid = pw->pw_gid;
3567 system_filter_gid_set = TRUE;
3570 /* If the errors_reply_to field is set, check that it is syntactically valid
3571 and ensure it contains a domain. */
3573 if (errors_reply_to)
3576 int start, end, domain;
3577 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3578 &start, &end, &domain, FALSE);
3581 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3582 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3585 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3586 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3589 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3590 smtp_accept_max must also be set. */
3592 if (smtp_accept_max == 0 &&
3593 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3594 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3595 "smtp_accept_max must be set if smtp_accept_queue or "
3596 "smtp_accept_max_per_host is set");
3598 /* Set up the host number if anything is specified. It is an expanded string
3599 so that it can be computed from the host name, for example. We do this last
3600 so as to ensure that everything else is set up before the expansion. */
3602 if (host_number_string)
3606 uschar *s = expand_string(host_number_string);
3609 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3610 "failed to expand localhost_number \"%s\": %s",
3611 host_number_string, expand_string_message);
3612 n = Ustrtol(s, &end, 0);
3613 while (isspace(*end)) end++;
3615 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3616 "localhost_number value is not a number: %s", s);
3617 if (n > LOCALHOST_MAX)
3618 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3619 "localhost_number is greater than the maximum allowed value (%d)",
3625 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3627 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3628 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3629 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3630 tls_verify_hosts ? "" : "try_");
3632 /* This also checks that the library linkage is working and we can call
3633 routines in it, so call even if tls_require_ciphers is unset */
3634 if (!tls_dropprivs_validate_require_cipher(nowarn))
3637 /* Magic number: at time of writing, 1024 has been the long-standing value
3638 used by so many clients, and what Exim used to use always, that it makes
3639 sense to just min-clamp this max-clamp at that. */
3640 if (tls_dh_max_bits < 1024)
3641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3642 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3644 /* If openssl_options is set, validate it */
3645 if (openssl_options)
3648 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3649 "openssl_options is set but we're using GnuTLS");
3652 if (!tls_openssl_options_parse(openssl_options, &dummy))
3653 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3654 "openssl_options parse error: %s", openssl_options);
3657 #endif /*SUPPORT_TLS*/
3659 if (!nowarn && !keep_environment && environ && *environ)
3660 log_write(0, LOG_MAIN,
3661 "Warning: purging the environment.\n"
3662 " Suggested action: use keep_environment.");
3667 /*************************************************
3668 * Initialize one driver *
3669 *************************************************/
3671 /* This is called once the driver's generic options, if any, have been read.
3672 We can now find the driver, set up defaults for the private options, and
3673 unset any "set" bits in the private options table (which might have been
3674 set by another incarnation of the same driver).
3677 d pointer to driver instance block, with generic
3679 drivers_available vector of available drivers
3680 size_of_info size of each block in drivers_available
3681 class class of driver, for error message
3683 Returns: pointer to the driver info block
3686 static driver_info *
3687 init_driver(driver_instance *d, driver_info *drivers_available,
3688 int size_of_info, uschar *class)
3690 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3691 dd = (driver_info *)((US dd) + size_of_info))
3692 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3694 int len = dd->options_len;
3696 d->options_block = store_get(len);
3697 memcpy(d->options_block, dd->options_block, len);
3698 for (int i = 0; i < *(dd->options_count); i++)
3699 dd->options[i].type &= ~opt_set;
3703 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3704 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3706 return NULL; /* never obeyed */
3712 /*************************************************
3713 * Initialize driver list *
3714 *************************************************/
3716 /* This function is called for routers, transports, and authentication
3717 mechanisms. It reads the data from the current point in the configuration file
3718 up to the end of the section, and sets up a chain of instance blocks according
3719 to the file's contents. The file will already have been opened by a call to
3720 readconf_main, and must be left open for subsequent reading of further data.
3722 Any errors cause a panic crash. Note that the blocks with names driver_info and
3723 driver_instance must map the first portions of all the _info and _instance
3724 blocks for this shared code to work.
3727 class "router", "transport", or "authenticator"
3728 anchor &routers, &transports, &auths
3729 drivers_available available drivers
3730 size_of_info size of each info block
3731 instance_default points to default data for an instance
3732 instance_size size of instance block
3733 driver_optionlist generic option list
3734 driver_optionlist_count count of generic option list
3740 readconf_driver_init(
3742 driver_instance **anchor,
3743 driver_info *drivers_available,
3745 void *instance_default,
3747 optionlist *driver_optionlist,
3748 int driver_optionlist_count)
3750 driver_instance **p = anchor;
3751 driver_instance *d = NULL;
3754 while ((buffer = get_config_line()) != NULL)
3759 /* Read the first name on the line and test for the start of a new driver. A
3760 macro definition indicates the end of the previous driver. If this isn't the
3761 start of a new driver, the line will be re-read. */
3763 s = readconf_readname(name, sizeof(name), buffer);
3765 /* Handle macro definition, first finishing off the initialization of the
3766 previous driver, if any. */
3768 if (isupper(*name) && *s == '=')
3772 if (!d->driver_name)
3773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3774 "no driver defined for %s \"%s\"", class, d->name);
3778 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3782 /* If the line starts with a name terminated by a colon, we are at the
3783 start of the definition of a new driver. The rest of the line must be
3788 /* Finish off initializing the previous driver. */
3792 if (!d->driver_name)
3793 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3794 "no driver defined for %s \"%s\"", class, d->name);
3798 /* Check that we haven't already got a driver of this name */
3800 for (d = *anchor; d; d = d->next)
3801 if (Ustrcmp(name, d->name) == 0)
3802 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3803 "there are two %ss called \"%s\"", class, name);
3805 /* Set up a new driver instance data block on the chain, with
3806 its default values installed. */
3808 d = store_get(instance_size);
3809 memcpy(d, instance_default, instance_size);
3812 d->name = string_copy(name);
3814 /* Clear out the "set" bits in the generic options */
3816 for (int i = 0; i < driver_optionlist_count; i++)
3817 driver_optionlist[i].type &= ~opt_set;
3819 /* Check nothing more on this line, then do the next loop iteration. */
3821 while (isspace(*s)) s++;
3822 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3826 /* Not the start of a new driver. Give an error if we have not set up a
3827 current driver yet. */
3830 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3832 /* First look to see if this is a generic option; if it is "driver",
3833 initialize the driver. If is it not a generic option, we can look for a
3834 private option provided that the driver has been previously set up. */
3836 if (readconf_handle_option(buffer, driver_optionlist,
3837 driver_optionlist_count, d, NULL))
3839 if (!d->info && d->driver_name)
3840 init_driver(d, drivers_available, size_of_info, class);
3843 /* Handle private options - pass the generic block because some may
3844 live therein. A flag with each option indicates if it is in the public
3848 readconf_handle_option(buffer, d->info->options,
3849 *(d->info->options_count), d, US"option \"%s\" unknown");
3851 /* The option is not generic and the driver name has not yet been given. */
3853 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3854 "(\"driver\" must be specified before any private options)", name);
3857 /* Run the initialization function for the final driver. */
3861 if (!d->driver_name)
3862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3863 "no driver defined for %s \"%s\"", class, d->name);
3870 /*************************************************
3871 * Check driver dependency *
3872 *************************************************/
3874 /* This function is passed a driver instance and a string. It checks whether
3875 any of the string options for the driver contains the given string as an
3879 d points to a driver instance block
3880 s the string to search for
3882 Returns: TRUE if a dependency is found
3886 readconf_depends(driver_instance *d, uschar *s)
3888 int count = *(d->info->options_count);
3891 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3893 void *options_block;
3895 int type = ol->type & opt_mask;
3896 if (type != opt_stringptr) continue;
3897 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3898 value = *(uschar **)(US options_block + (long int)(ol->value));
3899 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3901 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3902 isalnum(ss[Ustrlen(s)])) continue;
3903 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3904 d->name, ol->name, s);
3909 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3916 /*************************************************
3917 * Decode an error type for retries *
3918 *************************************************/
3920 /* This function is global because it is also called from the main
3921 program when testing retry information. It decodes strings such as "quota_7d"
3922 into numerical error codes.
3925 pp points to start of text
3926 p points past end of text
3927 basic_errno points to an int to receive the main error number
3928 more_errno points to an int to receive the secondary error data
3930 Returns: NULL if decoded correctly; else points to error text
3934 readconf_retry_error(const uschar *pp, const uschar *p,
3935 int *basic_errno, int *more_errno)
3938 const uschar *q = pp;
3939 while (q < p && *q != '_') q++;
3942 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3944 *basic_errno = ERRNO_EXIMQUOTA;
3945 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3946 return US"bad time value";
3949 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3951 *basic_errno = ECONNREFUSED;
3954 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3955 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3956 else return US"A or MX expected after \"refused\"";
3960 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3962 *basic_errno = ETIMEDOUT;
3966 int xlen = p - q - 1;
3967 const uschar *x = q + 1;
3969 static uschar *extras[] =
3970 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3971 static int values[] =
3972 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3974 for (i = 0; i < nelem(extras); i++)
3975 if (strncmpic(x, extras[i], xlen) == 0)
3977 *more_errno = values[i];
3981 if (i >= nelem(extras))
3982 if (strncmpic(x, US"DNS", xlen) == 0)
3983 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3984 "available in retry rules (it has never worked) - treated as "
3987 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3991 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3992 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3993 strncmpic(pp, US"data_4", 6) == 0)
3996 int x = 255; /* means "any 4xx code" */
3997 if (p != pp + 8) bad = TRUE; else
3999 int a = pp[6], b = pp[7];
4003 if (isdigit(b)) x += b - '0';
4004 else if (b == 'x') x += 100;
4007 else if (a != 'x' || b != 'x') bad = TRUE;
4011 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4012 "x is literal and d is any digit", pp);
4014 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4015 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4016 *more_errno = x << 8;
4019 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4020 strncmpic(q+1, US"failed", p-q-1) == 0)
4021 *basic_errno = ERRNO_AUTHFAIL;
4023 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4024 *basic_errno = ERRNO_SMTPCLOSED;
4026 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4027 *basic_errno = ERRNO_TLSREQUIRED;
4029 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4030 *basic_errno = ERRNO_UNKNOWNHOST;
4032 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4033 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4041 /*************************************************
4042 * Read retry information *
4043 *************************************************/
4045 /* Each line of retry information contains:
4047 . A domain name pattern or an address pattern;
4049 . An error name, possibly with additional data, or *;
4051 . An optional sequence of retry items, each consisting of an identifying
4052 letter, a cutoff time, and optional parameters.
4054 All this is decoded and placed into a control block. */
4057 /* Subroutine to read an argument, preceded by a comma and terminated
4058 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4059 1 = fixed point number (returned *1000).
4062 paddr pointer to pointer to current character; updated
4063 type 0 => read a time; 1 => read a fixed point number
4065 Returns: time in seconds or fixed point number * 1000
4069 retry_arg(const uschar **paddr, int type)
4071 const uschar *p = *paddr;
4074 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4076 while (isspace(*p)) p++;
4078 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4080 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4081 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4086 case 0: return readconf_readtime(pp, *p, FALSE);
4087 case 1: return readconf_readfixed(pp, *p);
4089 return 0; /* Keep picky compilers happy */
4092 /* The function proper */
4095 readconf_retries(void)
4097 retry_config **chain = &retries;
4101 while ((p = get_config_line()))
4103 retry_rule **rchain;
4107 next = store_get(sizeof(retry_config));
4110 chain = &(next->next);
4111 next->basic_errno = next->more_errno = 0;
4112 next->senders = NULL;
4114 rchain = &(next->rules);
4116 next->pattern = string_dequote(&p);
4117 while (isspace(*p)) p++;
4119 while (mac_isgraph(*p)) p++;
4120 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4121 "missing error type in retry rule");
4123 /* Test error names for things we understand. */
4125 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4126 &next->more_errno)))
4127 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4129 /* There may be an optional address list of senders to be used as another
4130 constraint on the rule. This was added later, so the syntax is a bit of a
4131 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4134 while (isspace(*p)) p++;
4135 if (Ustrncmp(p, "senders", 7) == 0)
4138 while (isspace(*p)) p++;
4139 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4140 "\"=\" expected after \"senders\" in retry rule");
4141 while (isspace(*p)) p++;
4142 next->senders = string_dequote(&p);
4145 /* Now the retry rules. Keep the maximum timeout encountered. */
4147 while (isspace(*p)) p++;
4151 retry_rule *rule = store_get(sizeof(retry_rule));
4153 rchain = &(rule->next);
4155 rule->rule = toupper(*p++);
4156 rule->timeout = retry_arg(&p, 0);
4157 if (rule->timeout > retry_maximum_timeout)
4158 retry_maximum_timeout = rule->timeout;
4162 case 'F': /* Fixed interval */
4163 rule->p1 = retry_arg(&p, 0);
4166 case 'G': /* Geometrically increasing intervals */
4167 case 'H': /* Ditto, but with randomness */
4168 rule->p1 = retry_arg(&p, 0);
4169 rule->p2 = retry_arg(&p, 1);
4173 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4177 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4178 (rule->rule != 'F' && rule->p2 < 1000))
4179 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4180 "bad parameters for retry rule");
4182 while (isspace(*p)) p++;
4186 while (isspace(*p)) p++;
4189 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4196 /*************************************************
4197 * Initialize authenticators *
4198 *************************************************/
4200 /* Read the authenticators section of the configuration file.
4209 #ifdef EXPERIMENTAL_PIPE_CONNECT
4213 readconf_driver_init(US"authenticator",
4214 (driver_instance **)(&auths), /* chain anchor */
4215 (driver_info *)auths_available, /* available drivers */
4216 sizeof(auth_info), /* size of info block */
4217 &auth_defaults, /* default values for generic options */
4218 sizeof(auth_instance), /* size of instance block */
4219 optionlist_auths, /* generic options */
4220 optionlist_auths_size);
4222 for (auth_instance * au = auths; au; au = au->next)
4224 if (!au->public_name)
4225 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4226 "the %s authenticator", au->name);
4228 for (auth_instance * bu = au->next; bu; bu = bu->next)
4229 if (strcmpic(au->public_name, bu->public_name) == 0)
4230 if ((au->client && bu->client) || (au->server && bu->server))
4231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4232 "(%s and %s) have the same public name (%s)",
4233 au->client ? US"client" : US"server", au->name, bu->name,
4235 #ifdef EXPERIMENTAL_PIPE_CONNECT
4239 #ifdef EXPERIMENTAL_PIPE_CONNECT
4240 f.smtp_in_early_pipe_no_auth = nauths > 16;
4247 /*************************************************
4248 * Read ACL information *
4249 *************************************************/
4251 /* If this run of Exim is not doing something that involves receiving a
4252 message, we can just skip over the ACL information. No need to parse it.
4254 First, we have a function for acl_read() to call back to get the next line. We
4255 need to remember the line we passed, because at the end it will contain the
4256 name of the next ACL. */
4258 static uschar *acl_line;
4263 acl_line = get_config_line();
4268 /* Now the main function:
4279 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4282 acl_line = get_config_line();
4290 p = readconf_readname(name, sizeof(name), acl_line);
4291 if (isupper(*name) && *p == '=')
4293 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4294 acl_line = get_config_line();
4298 if (*p != ':' || name[0] == 0)
4299 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4301 node = store_get(sizeof(tree_node) + Ustrlen(name));
4302 Ustrcpy(node->name, name);
4303 if (!tree_insertnode(&acl_anchor, node))
4304 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4305 "there are two ACLs called \"%s\"", name);
4307 node->data.ptr = acl_read(acl_callback, &error);
4309 if (node->data.ptr == NULL && error != NULL)
4310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4316 /*************************************************
4317 * Read configuration for local_scan() *
4318 *************************************************/
4320 /* This function is called after "begin local_scan" is encountered in the
4321 configuration file. If the local_scan() function allows for configuration
4322 options, we can process them. Otherwise, we expire in a panic.
4329 local_scan_init(void)
4331 #ifndef LOCAL_SCAN_HAS_OPTIONS
4332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4333 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4337 while ((p = get_config_line()))
4339 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4340 NULL, US"local_scan option \"%s\" unknown");
4347 /*************************************************
4348 * Read rest of configuration (after main) *
4349 *************************************************/
4351 /* This function reads the rest of the runtime configuration, after the main
4352 configuration. It is called only when actually needed. Each subsequent section
4353 of the configuration starts with a line of the form
4357 where the name is "routers", "transports", etc. A section is terminated by
4358 hitting the next "begin" line, and the next name is left in next_section.
4359 Because it may confuse people as to whether the names are singular or plural,
4360 we add "s" if it's missing. There is always enough room in next_section for
4361 this. This function is basically just a switch.
4367 static uschar *section_list[] = {
4381 while(next_section[0] != 0)
4385 int last = nelem(section_list);
4387 int n = Ustrlen(next_section);
4389 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4393 int c = strcmpic(next_section, section_list[mid]);
4395 if (c > 0) first = mid + 1; else last = mid;
4397 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4398 "\"%.*s\" is not a known configuration section name", n, next_section);
4399 mid = (last + first)/2;
4403 if (((had ^= bit) & bit) == 0)
4404 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4405 "\"%.*s\" section is repeated in the configuration file", n,
4410 case 0: readconf_acl(); break;
4411 case 1: auths_init(); break;
4412 case 2: local_scan_init(); break;
4413 case 3: readconf_retries(); break;
4414 case 4: readconf_rewrites(); break;
4415 case 5: route_init(); break;
4416 case 6: transport_init(); break;
4420 (void)fclose(config_file);
4423 /* Init the storage for the pre-parsed config lines */
4425 readconf_save_config(const uschar *s)
4427 save_config_line(string_sprintf("# Exim Configuration (%s)",
4428 f.running_in_test_harness ? US"X" : s));
4432 save_config_position(const uschar *file, int line)
4434 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4437 /* Append a pre-parsed logical line to the config lines store,
4438 this operates on a global (static) list that holds all the pre-parsed
4439 config lines, we do no further processing here, output formatting and
4440 honouring of <hide> or macros will be done during output */
4443 save_config_line(const uschar* line)
4445 static config_line_item *current;
4446 config_line_item *next;
4448 next = (config_line_item*) store_get(sizeof(config_line_item));
4449 next->line = string_copy(line);
4452 if (!config_lines) config_lines = next;
4453 else current->next = next;
4458 /* List the parsed config lines, care about nice formatting and
4459 hide the <hide> values unless we're the admin user */
4461 print_config(BOOL admin, BOOL terse)
4463 const int TS = terse ? 0 : 2;
4466 for (config_line_item * i = config_lines; i; i = i->next)
4471 /* skip over to the first non-space */
4472 for (current = i->line; *current && isspace(*current); ++current)
4475 if (*current == '\0')
4478 /* Collapse runs of spaces. We stop this if we encounter one of the
4479 * following characters: "'$, as this may indicate careful formatting */
4480 for (p = current; *p; ++p)
4483 if (!isspace(*p)) continue;
4484 if (*p != ' ') *p = ' ';
4486 for (next = p; isspace(*next); ++next)
4490 memmove(p+1, next, Ustrlen(next)+1);
4492 if (*next == '"' || *next == '\'' || *next == '$')
4497 if (current[0] == '#')
4500 /* begin lines are left aligned */
4501 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4503 if (!terse) puts("");
4508 /* router/acl/transport block names */
4509 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4511 if (!terse) puts("");
4512 printf("%*s%s\n", TS, "", current);
4516 /* hidden lines (all MACROS or lines prefixed with "hide") */
4518 && ( isupper(*current)
4519 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4523 if ((p = Ustrchr(current, '=')))
4526 printf("%*s%s= %s\n", indent, "", current, hidden);
4528 /* e.g.: hide split_spool_directory */
4530 printf("%*s\n", indent, hidden);
4534 /* rest is public */
4535 printf("%*s%s\n", indent, "", current);
4539 #endif /*!MACRO_PREDEF*/
4542 /* End of readconf.c */