1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar * syslog_facility_str;
22 static void fn_smtp_receive_timeout(const uschar *, const uschar *);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config[] = {
32 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
33 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
34 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
35 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
36 { "accept_8bitmime", opt_bool, &accept_8bitmime },
37 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
41 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
42 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
43 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
44 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
46 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
49 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
51 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
52 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
53 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
54 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
55 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
59 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
60 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
61 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
62 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
64 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
66 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
67 { "add_environment", opt_stringptr, &add_environment },
68 { "admin_groups", opt_gidlist, &admin_groups },
69 { "allow_domain_literals", opt_bool, &allow_domain_literals },
70 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
71 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
72 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
73 { "auto_thaw", opt_time, &auto_thaw },
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr, &av_scanner },
77 { "bi_command", opt_stringptr, &bi_command },
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr, &bmi_config_file },
81 { "bounce_message_file", opt_stringptr, &bounce_message_file },
82 { "bounce_message_text", opt_stringptr, &bounce_message_text },
83 { "bounce_return_body", opt_bool, &bounce_return_body },
84 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
85 { "bounce_return_message", opt_bool, &bounce_return_message },
86 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
87 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
88 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
89 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
90 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
91 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
92 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
93 { "check_log_inodes", opt_int, &check_log_inodes },
94 { "check_log_space", opt_Kint, &check_log_space },
95 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
96 { "check_spool_inodes", opt_int, &check_spool_inodes },
97 { "check_spool_space", opt_Kint, &check_spool_space },
98 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
99 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
100 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
101 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
102 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
103 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
106 { "dccifd_address", opt_stringptr, &dccifd_address },
107 { "dccifd_options", opt_stringptr, &dccifd_options },
109 { "debug_store", opt_bool, &debug_store },
110 { "delay_warning", opt_timelist, &delay_warning },
111 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
112 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
113 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
114 { "delivery_date_remove", opt_bool, &delivery_date_remove },
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool, &disable_fsync },
118 { "disable_ipv6", opt_bool, &disable_ipv6 },
120 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
122 #ifdef EXPERIMENTAL_DMARC
123 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
124 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
125 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
127 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
128 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
129 { "dns_cname_loops", opt_int, &dns_cname_loops },
130 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
131 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
132 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
133 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
134 { "dns_retrans", opt_time, &dns_retrans },
135 { "dns_retry", opt_int, &dns_retry },
136 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
137 { "dns_use_edns0", opt_int, &dns_use_edns0 },
138 /* This option is now a no-op, retained for compatibility */
139 { "drop_cr", opt_bool, &drop_cr },
140 /*********************************************************/
141 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
142 { "dsn_from", opt_stringptr, &dsn_from },
143 { "envelope_to_remove", opt_bool, &envelope_to_remove },
144 { "errors_copy", opt_stringptr, &errors_copy },
145 { "errors_reply_to", opt_stringptr, &errors_reply_to },
146 #ifndef DISABLE_EVENT
147 { "event_action", opt_stringptr, &event_action },
149 { "exim_group", opt_gid, &exim_gid },
150 { "exim_path", opt_stringptr, &exim_path },
151 { "exim_user", opt_uid, &exim_uid },
152 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
153 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
154 { "finduser_retries", opt_int, &finduser_retries },
155 { "freeze_tell", opt_stringptr, &freeze_tell },
156 { "gecos_name", opt_stringptr, &gecos_name },
157 { "gecos_pattern", opt_stringptr, &gecos_pattern },
159 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
160 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
162 { "header_line_maxsize", opt_int, &header_line_maxsize },
163 { "header_maxsize", opt_int, &header_maxsize },
164 { "headers_charset", opt_stringptr, &headers_charset },
165 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
166 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
167 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
168 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
169 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
170 { "hold_domains", opt_stringptr, &hold_domains },
171 { "host_lookup", opt_stringptr, &host_lookup },
172 { "host_lookup_order", opt_stringptr, &host_lookup_order },
173 { "host_reject_connection", opt_stringptr, &host_reject_connection },
174 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
176 { "hosts_proxy", opt_stringptr, &hosts_proxy },
178 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
180 { "ibase_servers", opt_stringptr, &ibase_servers },
182 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
183 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
184 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
185 { "keep_environment", opt_stringptr, &keep_environment },
186 { "keep_malformed", opt_time, &keep_malformed },
188 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
189 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
190 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
191 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
192 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
193 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
194 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
195 { "ldap_start_tls", opt_bool, &eldap_start_tls },
196 { "ldap_version", opt_int, &eldap_version },
198 { "local_from_check", opt_bool, &local_from_check },
199 { "local_from_prefix", opt_stringptr, &local_from_prefix },
200 { "local_from_suffix", opt_stringptr, &local_from_suffix },
201 { "local_interfaces", opt_stringptr, &local_interfaces },
202 #ifdef HAVE_LOCAL_SCAN
203 { "local_scan_timeout", opt_time, &local_scan_timeout },
205 { "local_sender_retain", opt_bool, &local_sender_retain },
206 { "localhost_number", opt_stringptr, &host_number_string },
207 { "log_file_path", opt_stringptr, &log_file_path },
208 { "log_selector", opt_stringptr, &log_selector_string },
209 { "log_timezone", opt_bool, &log_timezone },
210 { "lookup_open_max", opt_int, &lookup_open_max },
211 { "max_username_length", opt_int, &max_username_length },
212 { "message_body_newlines", opt_bool, &message_body_newlines },
213 { "message_body_visible", opt_mkint, &message_body_visible },
214 { "message_id_header_domain", opt_stringptr, &message_id_domain },
215 { "message_id_header_text", opt_stringptr, &message_id_text },
216 { "message_logs", opt_bool, &message_logs },
217 { "message_size_limit", opt_stringptr, &message_size_limit },
218 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
219 { "move_frozen_messages", opt_bool, &move_frozen_messages },
221 { "mua_wrapper", opt_bool, &mua_wrapper },
223 { "mysql_servers", opt_stringptr, &mysql_servers },
225 { "never_users", opt_uidlist, &never_users },
227 { "openssl_options", opt_stringptr, &openssl_options },
230 { "oracle_servers", opt_stringptr, &oracle_servers },
232 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
234 { "perl_at_start", opt_bool, &opt_perl_at_start },
235 { "perl_startup", opt_stringptr, &opt_perl_startup },
236 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
239 { "pgsql_servers", opt_stringptr, &pgsql_servers },
241 { "pid_file_path", opt_stringptr, &pid_file_path },
242 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
244 { "prdr_enable", opt_bool, &prdr_enable },
246 { "preserve_message_logs", opt_bool, &preserve_message_logs },
247 { "primary_hostname", opt_stringptr, &primary_hostname },
248 { "print_topbitchars", opt_bool, &print_topbitchars },
249 { "process_log_path", opt_stringptr, &process_log_path },
250 { "prod_requires_admin", opt_bool, &prod_requires_admin },
251 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
252 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
253 { "queue_domains", opt_stringptr, &queue_domains },
254 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
255 { "queue_only", opt_bool, &queue_only },
256 { "queue_only_file", opt_stringptr, &queue_only_file },
257 { "queue_only_load", opt_fixed, &queue_only_load },
258 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
259 { "queue_only_override", opt_bool, &queue_only_override },
260 { "queue_run_in_order", opt_bool, &queue_run_in_order },
261 { "queue_run_max", opt_stringptr, &queue_run_max },
262 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
263 { "receive_timeout", opt_time, &receive_timeout },
264 { "received_header_text", opt_stringptr, &received_header_text },
265 { "received_headers_max", opt_int, &received_headers_max },
266 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
267 { "recipients_max", opt_int, &recipients_max },
268 { "recipients_max_reject", opt_bool, &recipients_max_reject },
270 { "redis_servers", opt_stringptr, &redis_servers },
272 { "remote_max_parallel", opt_int, &remote_max_parallel },
273 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
274 { "retry_data_expire", opt_time, &retry_data_expire },
275 { "retry_interval_max", opt_time, &retry_interval_max },
276 { "return_path_remove", opt_bool, &return_path_remove },
277 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
278 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
279 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
280 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
281 { "slow_lookup_log", opt_int, &slow_lookup_log },
282 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
283 { "smtp_accept_max", opt_int, &smtp_accept_max },
284 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
285 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
286 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
287 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
288 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
289 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
290 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
291 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
292 { "smtp_banner", opt_stringptr, &smtp_banner },
293 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
294 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
295 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
296 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
297 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
298 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
299 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
300 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
301 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
302 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
303 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
304 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
305 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
306 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
308 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
310 #ifdef WITH_CONTENT_SCAN
311 { "spamd_address", opt_stringptr, &spamd_address },
314 { "spf_guess", opt_stringptr, &spf_guess },
316 { "split_spool_directory", opt_bool, &split_spool_directory },
317 { "spool_directory", opt_stringptr, &spool_directory },
318 { "spool_wireformat", opt_bool, &spool_wireformat },
320 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
322 #ifdef EXPERIMENTAL_SRS
323 { "srs_config", opt_stringptr, &srs_config },
324 { "srs_hashlength", opt_int, &srs_hashlength },
325 { "srs_hashmin", opt_int, &srs_hashmin },
326 { "srs_maxage", opt_int, &srs_maxage },
327 { "srs_secrets", opt_stringptr, &srs_secrets },
328 { "srs_usehash", opt_bool, &srs_usehash },
329 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
331 { "strict_acl_vars", opt_bool, &strict_acl_vars },
332 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
333 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
334 { "syslog_duplication", opt_bool, &syslog_duplication },
335 { "syslog_facility", opt_stringptr, &syslog_facility_str },
336 { "syslog_pid", opt_bool, &syslog_pid },
337 { "syslog_processname", opt_stringptr, &syslog_processname },
338 { "syslog_timestamp", opt_bool, &syslog_timestamp },
339 { "system_filter", opt_stringptr, &system_filter },
340 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
341 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
342 { "system_filter_group", opt_gid, &system_filter_gid },
343 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
344 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
345 { "system_filter_user", opt_uid, &system_filter_uid },
346 { "tcp_nodelay", opt_bool, &tcp_nodelay },
347 #ifdef USE_TCP_WRAPPERS
348 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
350 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
351 { "timezone", opt_stringptr, &timezone_string },
352 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
354 # ifdef EXPERIMENTAL_REQUIRETLS
355 { "tls_advertise_requiretls", opt_stringptr, &tls_advertise_requiretls },
357 { "tls_certificate", opt_stringptr, &tls_certificate },
358 { "tls_crl", opt_stringptr, &tls_crl },
359 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
360 { "tls_dhparam", opt_stringptr, &tls_dhparam },
361 { "tls_eccurve", opt_stringptr, &tls_eccurve },
362 # ifndef DISABLE_OCSP
363 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
365 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
366 { "tls_privatekey", opt_stringptr, &tls_privatekey },
367 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
368 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
369 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
370 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
371 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
373 { "trusted_groups", opt_gidlist, &trusted_groups },
374 { "trusted_users", opt_uidlist, &trusted_users },
375 { "unknown_login", opt_stringptr, &unknown_login },
376 { "unknown_username", opt_stringptr, &unknown_username },
377 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
378 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
379 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
380 { "warn_message_file", opt_stringptr, &warn_message_file },
381 { "write_rejectlog", opt_bool, &write_rejectlog }
385 static int optionlist_config_size = nelem(optionlist_config);
391 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
396 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
402 struct auth_info * ai;
405 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
407 for (ai = auths_available; ai->driver_name[0]; ai++)
409 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
410 builtin_macro_create(buf);
411 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
416 options_logging(void)
421 for (bp = log_options; bp < log_options + log_options_count; bp++)
423 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
424 builtin_macro_create(buf);
429 #else /*!MACRO_PREDEF*/
431 extern char **environ;
433 static void save_config_line(const uschar* line);
434 static void save_config_position(const uschar *file, int line);
435 static void print_config(BOOL admin, BOOL terse);
438 #define CSTATE_STACK_SIZE 10
440 const uschar *config_directory = NULL;
443 /* Structure for chain (stack) of .included files */
445 typedef struct config_file_item {
446 struct config_file_item *next;
447 const uschar *filename;
448 const uschar *directory;
453 /* Structure for chain of configuration lines (-bP config) */
455 typedef struct config_line_item {
456 struct config_line_item *next;
460 static config_line_item* config_lines;
462 /* Structure of table of conditional words and their state transitions */
464 typedef struct cond_item {
472 /* Structure of table of syslog facility names and values */
474 typedef struct syslog_fac_item {
480 static const char * const hidden = "<value not displayable>";
482 /* Static variables */
484 static config_file_item *config_file_stack = NULL; /* For includes */
486 static uschar *syslog_facility_str = NULL;
487 static uschar next_section[24];
488 static uschar time_buffer[24];
490 /* State variables for conditional loading (.ifdef / .else / .endif) */
492 static int cstate = 0;
493 static int cstate_stack_ptr = -1;
494 static int cstate_stack[CSTATE_STACK_SIZE];
496 /* Table of state transitions for handling conditional inclusions. There are
497 four possible state transitions:
501 .elifdef true (or .else)
504 .endif just causes the previous cstate to be popped off the stack */
506 static int next_cstate[3][4] =
508 /* State 0: reading from file, or reading until next .else or .endif */
510 /* State 1: condition failed, skipping until next .else or .endif */
512 /* State 2: skipping until .endif */
516 /* Table of conditionals and the states to set. For each name, there are four
517 values: the length of the name (to save computing it each time), the state to
518 set if a macro was found in the line, the state to set if a macro was not found
519 in the line, and a stack manipulation setting which is:
521 -1 pull state value off the stack
522 0 don't alter the stack
523 +1 push value onto stack, before setting new state
526 static cond_item cond_list[] = {
527 { US"ifdef", 5, 0, 1, 1 },
528 { US"ifndef", 6, 1, 0, 1 },
529 { US"elifdef", 7, 2, 3, 0 },
530 { US"elifndef", 8, 3, 2, 0 },
531 { US"else", 4, 2, 2, 0 },
532 { US"endif", 5, 0, 0, -1 }
535 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
537 /* Table of syslog facility names and their values */
539 static syslog_fac_item syslog_list[] = {
540 { US"mail", LOG_MAIL },
541 { US"user", LOG_USER },
542 { US"news", LOG_NEWS },
543 { US"uucp", LOG_UUCP },
544 { US"local0", LOG_LOCAL0 },
545 { US"local1", LOG_LOCAL1 },
546 { US"local2", LOG_LOCAL2 },
547 { US"local3", LOG_LOCAL3 },
548 { US"local4", LOG_LOCAL4 },
549 { US"local5", LOG_LOCAL5 },
550 { US"local6", LOG_LOCAL6 },
551 { US"local7", LOG_LOCAL7 },
552 { US"daemon", LOG_DAEMON }
555 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
560 /*************************************************
561 * Find the name of an option *
562 *************************************************/
564 /* This function is to aid debugging. Various functions take arguments that are
565 pointer variables in the options table or in option tables for various drivers.
566 For debugging output, it is useful to be able to find the name of the option
567 which is currently being processed. This function finds it, if it exists, by
568 searching the table(s).
570 Arguments: a value that is presumed to be in the table above
571 Returns: the option name, or an empty string
575 readconf_find_option(void *p)
579 transport_instance *t;
581 for (i = 0; i < nelem(optionlist_config); i++)
582 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
584 for (r = routers; r; r = r->next)
586 router_info *ri = r->info;
587 for (i = 0; i < *ri->options_count; i++)
589 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
590 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
591 return US ri->options[i].name;
595 for (t = transports; t; t = t->next)
597 transport_info *ti = t->info;
598 for (i = 0; i < *ti->options_count; i++)
600 optionlist * op = &ti->options[i];
601 if ((op->type & opt_mask) != opt_stringptr) continue;
602 if (p == ( op->type & opt_public
604 : CS t->options_block
606 + (long int)op->value)
617 /*************************************************
618 * Deal with an assignment to a macro *
619 *************************************************/
621 /* We have a new definition; append to the list.
624 name Name of the macro; will be copied
625 val Expansion result for the macro; will be copied
629 macro_create(const uschar * name, const uschar * val, BOOL command_line)
631 macro_item * m = store_get(sizeof(macro_item));
633 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
635 m->command_line = command_line;
636 m->namelen = Ustrlen(name);
637 m->replen = Ustrlen(val);
638 m->name = string_copy(name);
639 m->replacement = string_copy(val);
651 /* This function is called when a line that starts with an upper case letter is
652 encountered. The argument "line" should contain a complete logical line, and
653 start with the first letter of the macro name. The macro name and the
654 replacement text are extracted and stored. Redefinition of existing,
655 non-command line, macros is permitted using '==' instead of '='.
658 s points to the start of the logical line
660 Returns: FALSE iff fatal error
664 macro_read_assignment(uschar *s)
671 while (isalnum(*s) || *s == '_')
673 if (namelen >= sizeof(name) - 1)
675 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
676 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
679 name[namelen++] = *s++;
683 while (isspace(*s)) s++;
686 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
695 while (isspace(*s)) s++;
697 /* If an existing macro of the same name was defined on the command line, we
698 just skip this definition. It's an error to attempt to redefine a macro without
699 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
700 It is also an error to define a macro whose name begins with the name of a
701 previously defined macro. This is the requirement that make using a tree
702 for macros hard; we must check all macros for the substring. Perhaps a
703 sorted list, and a bsearch, would work?
704 Note: it is documented that the other way round works. */
706 for (m = macros; m; m = m->next)
708 if (Ustrcmp(m->name, name) == 0)
710 if (!m->command_line && !redef)
712 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
713 "defined (use \"==\" if you want to redefine it)", name);
719 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
721 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
722 "a macro because previously defined macro \"%s\" is a substring",
727 /* We cannot have this test, because it is documented that a substring
728 macro is permitted (there is even an example).
730 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
731 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
732 * "a macro because it is a substring of previously defined macro \"%s\"",
737 /* Check for an overriding command-line definition. */
739 if (m && m->command_line) return TRUE;
741 /* Redefinition must refer to an existing macro. */
746 m->replen = Ustrlen(s);
747 m->replacement = string_copy(s);
751 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
756 /* We have a new definition. */
758 (void) macro_create(name, s, FALSE);
766 /* Process line for macros. The line is in big_buffer starting at offset len.
767 Expand big_buffer if needed. Handle definitions of new macros, and
768 macro expansions, rewriting the line in the buffer.
771 len Offset in buffer of start of line
772 newlen Pointer to offset of end of line, updated on return
773 macro_found Pointer to return that a macro was expanded
775 Return: pointer to first nonblank char in line
779 macros_expand(int len, int * newlen, BOOL * macro_found)
781 uschar * ss = big_buffer + len;
785 /* Find the true start of the physical line - leading spaces are always
788 while (isspace(*ss)) ss++;
790 /* Process the physical line for macros. If this is the start of the logical
791 line, skip over initial text at the start of the line if it starts with an
792 upper case character followed by a sequence of name characters and an equals
793 sign, because that is the definition of a new macro, and we don't do
794 replacement therein. */
797 if (len == 0 && isupper(*s))
799 while (isalnum(*s) || *s == '_') s++;
800 while (isspace(*s)) s++;
801 if (*s != '=') s = ss; /* Not a macro definition */
804 /* Skip leading chars which cannot start a macro name, to avoid multiple
805 pointless rescans in Ustrstr calls. */
807 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
809 /* For each defined macro, scan the line (from after XXX= if present),
810 replacing all occurrences of the macro. */
812 *macro_found = FALSE;
813 if (*s) for (m = *s == '_' ? macros : macros_user; m; m = m->next)
818 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
822 while ((p = Ustrstr(t, m->name)) != NULL)
826 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, ss);
827 /* Expand the buffer if necessary */
829 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
831 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
832 uschar *newbuffer = store_malloc(newsize);
833 memcpy(newbuffer, big_buffer, *newlen + 1);
834 p = newbuffer + (p - big_buffer);
835 s = newbuffer + (s - big_buffer);
836 ss = newbuffer + (ss - big_buffer);
837 t = newbuffer + (t - big_buffer);
838 big_buffer_size = newsize;
839 store_free(big_buffer);
840 big_buffer = newbuffer;
843 /* Shuffle the remaining characters up or down in the buffer before
844 copying in the replacement text. Don't rescan the replacement for this
848 if ((moveby = m->replen - m->namelen) != 0)
850 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
853 Ustrncpy(p, m->replacement, m->replen);
855 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
860 /* An empty macro replacement at the start of a line could mean that ss no
861 longer points to the first non-blank character. */
863 while (isspace(*ss)) ss++;
867 /*************************************************
868 * Read configuration line *
869 *************************************************/
871 /* A logical line of text is read from the configuration file into the big
872 buffer, taking account of macros, .includes, and continuations. The size of
873 big_buffer is increased if necessary. The count of configuration lines is
874 maintained. Physical input lines starting with # (ignoring leading white space,
875 and after macro replacement) and empty logical lines are always ignored.
876 Leading and trailing spaces are removed.
878 If we hit a line of the form "begin xxxx", the xxxx is placed in the
879 next_section vector, and the function returns NULL, indicating the end of a
880 configuration section. On end-of-file, NULL is returned with next_section
885 Returns: a pointer to the first non-blank in the line,
886 or NULL if eof or end of section is reached
890 get_config_line(void)
892 int startoffset = 0; /* To first non-blank char in logical line */
893 int len = 0; /* Of logical line so far */
898 /* Loop for handling continuation lines, skipping comments, and dealing with
903 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
905 if (config_file_stack != NULL) /* EOF inside .include */
907 (void)fclose(config_file);
908 config_file = config_file_stack->file;
909 config_filename = config_file_stack->filename;
910 config_directory = config_file_stack->directory;
911 config_lineno = config_file_stack->lineno;
912 config_file_stack = config_file_stack->next;
914 save_config_position(config_filename, config_lineno);
918 /* EOF at top level */
920 if (cstate_stack_ptr >= 0)
921 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
922 "Unexpected end of configuration file: .endif missing");
924 if (len != 0) break; /* EOF after continuation */
925 next_section[0] = 0; /* EOF at start of logical line */
930 newlen = len + Ustrlen(big_buffer + len);
932 if (config_lines && config_lineno == 1)
933 save_config_position(config_filename, config_lineno);
935 /* Handle pathologically long physical lines - yes, it did happen - by
936 extending big_buffer at this point. The code also copes with very long
939 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
942 big_buffer_size += BIG_BUFFER_SIZE;
943 newbuffer = store_malloc(big_buffer_size);
945 /* This use of strcpy is OK because we know that the string in the old
946 buffer is shorter than the new buffer. */
948 Ustrcpy(newbuffer, big_buffer);
949 store_free(big_buffer);
950 big_buffer = newbuffer;
951 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
953 newlen += Ustrlen(big_buffer + newlen);
956 ss = macros_expand(len, &newlen, ¯o_found);
958 /* Check for comment lines - these are physical lines. */
960 if (*ss == '#') continue;
962 /* Handle conditionals, which are also applied to physical lines. Conditions
963 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
964 expansion occured on the rest of the line. A preliminary test for the leading
965 '.' saves effort on most lines. */
971 /* Search the list of conditional directives */
973 for (i = 0; i < cond_list_size; i++)
976 cond_item *c = cond_list+i;
977 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
979 /* The following character must be white space or end of string */
981 n = ss[1 + c->namelen];
982 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
984 /* .ifdef and .ifndef push the current state onto the stack, then set
985 a new one from the table. Stack overflow is an error */
989 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
991 ".%s nested too deeply", c->name);
992 cstate_stack[++cstate_stack_ptr] = cstate;
993 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
996 /* For any of the others, stack underflow is an error. The next state
997 comes either from the stack (.endif) or from the table. */
1001 if (cstate_stack_ptr < 0)
1002 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1003 ".%s without matching .ifdef", c->name);
1004 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1005 next_cstate[cstate][macro_found? c->action1 : c->action2];
1008 /* Having dealt with a directive, break the loop */
1013 /* If we have handled a conditional directive, continue with the next
1014 physical line. Otherwise, fall through. */
1016 if (i < cond_list_size) continue;
1019 /* If the conditional state is not 0 (actively using these lines), ignore
1022 if (cstate != 0) continue; /* Conditional skip */
1024 /* Handle .include lines - these are also physical lines. */
1026 if (Ustrncmp(ss, ".include", 8) == 0 &&
1028 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1031 int include_if_exists = isspace(ss[8])? 0 : 10;
1032 config_file_item *save;
1033 struct stat statbuf;
1035 ss += 9 + include_if_exists;
1036 while (isspace(*ss)) ss++;
1037 t = ss + Ustrlen(ss);
1038 while (t > ss && isspace(t[-1])) t--;
1039 if (*ss == '\"' && t[-1] == '\"')
1046 /* We allow relative file names. For security reasons currently
1047 relative names not allowed with .include_if_exists. For .include_if_exists
1048 we need to check the permissions/ownership of the containing folder */
1050 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1051 "absolute path \"%s\"", ss);
1054 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1055 ss = string_from_gstring(g);
1058 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1061 save_config_position(config_filename, config_lineno);
1062 save = store_get(sizeof(config_file_item));
1063 save->next = config_file_stack;
1064 config_file_stack = save;
1065 save->file = config_file;
1066 save->filename = config_filename;
1067 save->directory = config_directory;
1068 save->lineno = config_lineno;
1070 if (!(config_file = Ufopen(ss, "rb")))
1071 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1072 "configuration file %s", ss);
1074 config_filename = string_copy(ss);
1075 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1080 /* If this is the start of the logical line, remember where the non-blank
1081 data starts. Otherwise shuffle down continuation lines to remove leading
1085 startoffset = ss - big_buffer;
1088 s = big_buffer + len;
1091 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1096 /* Accept the new addition to the line. Remove trailing white space. */
1099 while (len > 0 && isspace(big_buffer[len-1])) len--;
1100 big_buffer[len] = 0;
1102 /* We are done if the line does not end in backslash and contains some data.
1103 Empty logical lines are ignored. For continuations, remove the backslash and
1104 go round the loop to read the continuation line. */
1108 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1109 big_buffer[--len] = 0; /* Remove backslash */
1111 } /* Loop for reading multiple physical lines */
1113 /* We now have a logical line. Test for the end of a configuration section (or,
1114 more accurately, for the start of the next section). Place the name of the next
1115 section in next_section, and return NULL. If the name given is longer than
1116 next_section, truncate it. It will be unrecognized later, because all the known
1117 section names do fit. Leave space for pluralizing. */
1119 s = big_buffer + startoffset; /* First non-space character */
1122 save_config_line(s);
1124 if (strncmpic(s, US"begin ", 6) == 0)
1127 while (isspace(*s)) s++;
1128 if (big_buffer + len - s > sizeof(next_section) - 2)
1129 s[sizeof(next_section) - 2] = 0;
1130 Ustrcpy(next_section, s);
1134 /* Return the first non-blank character. */
1141 /*************************************************
1143 *************************************************/
1145 /* The yield is the pointer to the next uschar. Names longer than the
1146 output space are silently truncated. This function is also used from acl.c when
1150 name where to put the name
1154 Returns: new input pointer
1158 readconf_readname(uschar *name, int len, uschar *s)
1161 while (isspace(*s)) s++;
1164 while (isalnum(*s) || *s == '_')
1166 if (p < len-1) name[p++] = *s;
1171 while (isspace(*s)) s++;
1178 /*************************************************
1179 * Read a time value *
1180 *************************************************/
1182 /* This function is also called from outside, to read argument
1183 time values. The format of a time value is:
1185 [<n>w][<n>d][<n>h][<n>m][<n>s]
1187 as long as at least one is present. If a format error is encountered,
1188 return a negative value. The value must be terminated by the given
1193 terminator required terminating character
1194 return_msec if TRUE, allow fractional seconds and return milliseconds
1196 Returns: the time value, or -1 on syntax error
1197 value is seconds if return_msec is FALSE
1198 value is milliseconds if return_msec is TRUE
1202 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1210 if (!isdigit(*s)) return -1;
1211 (void)sscanf(CCS s, "%d%n", &value, &count);
1216 case 'w': value *= 7;
1217 case 'd': value *= 24;
1218 case 'h': value *= 60;
1219 case 'm': value *= 60;
1224 if (!return_msec) return -1;
1225 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1227 if (*s++ != 's') return -1;
1228 yield += (int)(fraction * 1000.0);
1234 if (return_msec) value *= 1000;
1236 if (*s == terminator) return yield;
1238 /* Control never reaches here. */
1243 /*************************************************
1244 * Read a fixed point value *
1245 *************************************************/
1247 /* The value is returned *1000
1251 terminator required terminator
1253 Returns: the value, or -1 on error
1257 readconf_readfixed(const uschar *s, int terminator)
1261 if (!isdigit(*s)) return -1;
1262 (void)sscanf(CS s, "%d%n", &value, &count);
1264 yield = value * 1000;
1268 while (isdigit((*(++s))))
1270 yield += (*s - '0') * m;
1275 return (*s == terminator)? yield : (-1);
1280 /*************************************************
1281 * Find option in list *
1282 *************************************************/
1284 /* The lists are always in order, so binary chop can be used.
1287 name the option name to search for
1288 ol the first entry in the option list
1289 last one more than the offset of the last entry in the option list
1291 Returns: pointer to an option entry, or NULL if not found
1295 find_option(uschar *name, optionlist *ol, int last)
1298 while (last > first)
1300 int middle = (first + last)/2;
1301 int c = Ustrcmp(name, ol[middle].name);
1303 if (c == 0) return ol + middle;
1304 else if (c > 0) first = middle + 1;
1312 /*************************************************
1313 * Find a set flag in option list *
1314 *************************************************/
1316 /* Because some versions of Unix make no restrictions on the values of uids and
1317 gids (even negative ones), we cannot represent "unset" by a special value.
1318 There is therefore a separate boolean variable for each one indicating whether
1319 a value is set or not. This function returns a pointer to the boolean, given
1320 the original option name. It is a major disaster if the flag cannot be found.
1323 name the name of the uid or gid option
1324 oltop points to the start of the relevant option list
1325 last one more than the offset of the last item in the option list
1326 data_block NULL when reading main options => data values in the option
1327 list are absolute addresses; otherwise they are byte offsets
1328 in data_block (used for driver options)
1330 Returns: a pointer to the boolean flag.
1334 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1338 sprintf(CS name2, "*set_%.50s", name);
1339 ol = find_option(name2, oltop, last);
1340 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1341 "Exim internal error: missing set flag for %s", name);
1342 return (data_block == NULL)? (BOOL *)(ol->value) :
1343 (BOOL *)(US data_block + (long int)(ol->value));
1349 /*************************************************
1350 * Output extra characters message and die *
1351 *************************************************/
1353 /* Called when an option line has junk on the end. Sometimes this is because
1354 the sysadmin thinks comments are permitted.
1357 s points to the extra characters
1358 t1..t3 strings to insert in the log message
1360 Returns: doesn't return; dies
1364 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1366 uschar *comment = US"";
1367 if (*s == '#') comment = US" (# is comment only at line start)";
1368 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1369 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1374 /*************************************************
1375 * Read rewrite information *
1376 *************************************************/
1378 /* Each line of rewrite information contains:
1380 . A complete address in the form user@domain, possibly with
1381 leading * for each part; or alternatively, a regex.
1383 . A replacement string (which will be expanded).
1385 . An optional sequence of one-letter flags, indicating which
1386 headers etc. to apply this rule to.
1388 All this is decoded and placed into a control block. The OR of the flags is
1389 maintained in a common word.
1392 p points to the string that makes up the rule
1393 existflags points to the overall flag word
1394 isglobal TRUE if reading global rewrite rules
1396 Returns: the control block for the parsed rule.
1399 static rewrite_rule *
1400 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1402 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1405 next->key = string_dequote(&p);
1407 while (isspace(*p)) p++;
1409 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1410 "missing rewrite replacement string");
1413 next->replacement = string_dequote(&p);
1415 while (*p != 0) switch (*p++)
1417 case ' ': case '\t': break;
1419 case 'q': next->flags |= rewrite_quit; break;
1420 case 'w': next->flags |= rewrite_whole; break;
1422 case 'h': next->flags |= rewrite_all_headers; break;
1423 case 's': next->flags |= rewrite_sender; break;
1424 case 'f': next->flags |= rewrite_from; break;
1425 case 't': next->flags |= rewrite_to; break;
1426 case 'c': next->flags |= rewrite_cc; break;
1427 case 'b': next->flags |= rewrite_bcc; break;
1428 case 'r': next->flags |= rewrite_replyto; break;
1430 case 'E': next->flags |= rewrite_all_envelope; break;
1431 case 'F': next->flags |= rewrite_envfrom; break;
1432 case 'T': next->flags |= rewrite_envto; break;
1434 case 'Q': next->flags |= rewrite_qualify; break;
1435 case 'R': next->flags |= rewrite_repeat; break;
1438 next->flags |= rewrite_smtp;
1439 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1440 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1441 "rewrite rule has the S flag but is not a regular expression");
1445 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1446 "unknown rewrite flag character '%c' "
1447 "(could be missing quotes round replacement item)", p[-1]);
1451 /* If no action flags are set, set all the "normal" rewrites. */
1453 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1454 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1456 /* Remember which exist, for optimization, and return the rule */
1458 *existflags |= next->flags;
1465 /*************************************************
1466 * Read global rewrite information *
1467 *************************************************/
1469 /* Each line is a single rewrite rule; it is parsed into a control block
1470 by readconf_one_rewrite(), and its flags are ORed into the global flag
1471 word rewrite_existflags. */
1474 readconf_rewrites(void)
1476 rewrite_rule **chain = &global_rewrite_rules;
1479 while ((p = get_config_line()) != NULL)
1481 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1483 chain = &(next->next);
1489 /*************************************************
1491 *************************************************/
1493 /* Strings are read into the normal store pool. As long we aren't too
1494 near the end of the current block, the string will just use what is necessary
1495 on the top of the stacking pool, because string_cat() uses the extension
1499 s the rest of the input line
1500 name the option name (for errors)
1502 Returns: pointer to the string
1506 read_string(const uschar *s, const uschar *name)
1511 if (*s != '\"') return string_copy(s);
1514 yield = string_dequote(&s);
1516 if (s == ss+1 || s[-1] != '\"')
1517 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1518 "missing quote at end of string value for %s", name);
1520 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1526 /*************************************************
1527 * Custom-handler options *
1528 *************************************************/
1530 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1533 smtp_receive_timeout_s = string_copy(str);
1536 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1537 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1538 if (smtp_receive_timeout < 0)
1539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1544 /*************************************************
1545 * Handle option line *
1546 *************************************************/
1548 /* This function is called from several places to process a line containing the
1549 setting of an option. The first argument is the line to be decoded; it has been
1550 checked not to be empty and not to start with '#'. Trailing newlines and white
1551 space have been removed. The second argument is a pointer to the list of
1552 variable names that are to be recognized, together with their types and
1553 locations, and the third argument gives the number of entries in the list.
1555 The fourth argument is a pointer to a data block. If it is NULL, then the data
1556 values in the options list are absolute addresses. Otherwise, they are byte
1557 offsets in the data block.
1559 String option data may continue onto several lines; this function reads further
1560 data from config_file if necessary.
1562 The yield of this function is normally zero. If a string continues onto
1563 multiple lines, then the data value is permitted to be followed by a comma
1564 or a semicolon (for use in drivers) and the yield is that character.
1567 buffer contains the configuration line to be handled
1568 oltop points to the start of the relevant option list
1569 last one more than the offset of the last item in the option list
1570 data_block NULL when reading main options => data values in the option
1571 list are absolute addresses; otherwise they are byte offsets
1572 in data_block when they have opt_public set; otherwise
1573 they are byte offsets in data_block->options_block.
1574 unknown_txt format string to use in panic message for unknown option;
1575 must contain %s for option name
1576 if given as NULL, don't panic on unknown option
1578 Returns: TRUE if an option was read successfully,
1579 FALSE false for an unknown option if unknown_txt == NULL,
1580 otherwise panic and die on an unknown option
1584 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1585 void *data_block, uschar *unknown_txt)
1589 int n, count, type, value;
1593 BOOL boolvalue = TRUE;
1594 BOOL freesptr = TRUE;
1595 optionlist *ol, *ol2;
1599 uschar *inttype = US"";
1602 uschar **str_target;
1606 /* There may be leading spaces; thereafter, we expect an option name starting
1609 while (isspace(*s)) s++;
1611 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1613 /* Read the name of the option, and skip any subsequent white space. If
1614 it turns out that what we read was "hide", set the flag indicating that
1615 this is a secure option, and loop to read the next word. */
1617 for (n = 0; n < 2; n++)
1619 while (isalnum(*s) || *s == '_')
1621 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1625 while (isspace(*s)) s++;
1626 if (Ustrcmp(name, "hide") != 0) break;
1627 issecure = opt_secure;
1631 /* Deal with "no_" or "not_" here for booleans */
1633 if (Ustrncmp(name, "no_", 3) == 0)
1639 if (Ustrncmp(name, "not_", 4) == 0)
1645 /* Search the list for the given name. A non-existent name, or an option that
1646 is set twice, is a disaster. */
1648 if (!(ol = find_option(name + offset, oltop, last)))
1650 if (unknown_txt == NULL) return FALSE;
1651 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1654 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1655 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1656 "\"%s\" option set for the second time", name);
1658 ol->type |= opt_set | issecure;
1659 type = ol->type & opt_mask;
1661 /* Types with data values must be followed by '='; the "no[t]_" prefix
1662 applies only to boolean values. */
1664 if (type < opt_bool || type > opt_bool_last)
1667 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1668 "negation prefix applied to a non-boolean option");
1670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1671 "unexpected end of line (data missing) after %s", name);
1673 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1676 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1677 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1678 ultimately expands to one of those values. */
1680 else if (*s != 0 && (offset != 0 || *s != '='))
1681 extra_chars_error(s, US"boolean option ", name, US"");
1683 /* Skip white space after = */
1685 if (*s == '=') while (isspace((*(++s))));
1687 /* If there is a data block and the opt_public flag is not set, change
1688 the data block pointer to the private options block. */
1690 if (data_block != NULL && (ol->type & opt_public) == 0)
1691 data_block = (void *)(((driver_instance *)data_block)->options_block);
1693 /* Now get the data according to the type. */
1697 /* If a string value is not enclosed in quotes, it consists of
1698 the rest of the current line, verbatim. Otherwise, string escapes
1701 A transport is specified as a string, which is then looked up in the
1702 list of transports. A search type is specified as one of a number of
1705 A set or rewrite rules for a driver is specified as a string, which is
1706 then parsed into a suitable chain of control blocks.
1708 Uids and gids are specified as strings which are then looked up in the
1709 passwd file. Lists of uids and gids are similarly specified as colon-
1710 separated strings. */
1715 case opt_expand_uid:
1716 case opt_expand_gid:
1721 reset_point = sptr = read_string(s, name);
1723 /* Having read a string, we now have several different ways of using it,
1724 depending on the data type, so do another switch. If keeping the actual
1725 string is not required (because it is interpreted), freesptr is set TRUE,
1726 and at the end we reset the pool. */
1730 /* If this was a string, set the variable to point to the new string,
1731 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1732 rules, we still keep the string (for printing), and parse the rules into a
1733 control block and flags word. */
1736 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1738 if (ol->type & opt_rep_con)
1740 uschar * saved_condition;
1741 /* We already have a condition, we're conducting a crude hack to let
1742 multiple condition rules be chained together, despite storing them in
1744 *str_target = string_copy_malloc( (saved_condition = *str_target)
1745 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1746 saved_condition, sptr)
1748 /* TODO(pdp): there is a memory leak here and just below
1749 when we set 3 or more conditions; I still don't
1750 understand the store mechanism enough to know
1751 what's the safe way to free content from an earlier store.
1752 AFAICT, stores stack, so freeing an early stored item also stores
1753 all data alloc'd after it. If we knew conditions were adjacent,
1754 we could survive that, but we don't. So I *think* we need to take
1755 another bit from opt_type to indicate "malloced"; this seems like
1756 quite a hack, especially for this one case. It also means that
1757 we can't ever reclaim the store from the *first* condition.
1759 Because we only do this once, near process start-up, I'm prepared to
1760 let this slide for the time being, even though it rankles. */
1762 else if (ol->type & opt_rep_str)
1764 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1765 int sep_i = -(int)sep_o;
1766 const uschar * list = sptr;
1768 gstring * list_o = NULL;
1772 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1773 list_o = string_cat(list_o, *str_target);
1776 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1777 list_o = string_append_listele(list_o, sep_o, s);
1780 *str_target = string_copy_malloc(string_from_gstring(list_o));
1791 *USS (US data_block + (long int)(ol->value)) = sptr;
1793 *USS (ol->value) = sptr;
1795 if (type == opt_rewrite)
1800 rewrite_rule **chain;
1803 sprintf(CS name2, "*%.50s_rules", name);
1804 ol2 = find_option(name2, oltop, last);
1805 sprintf(CS name2, "*%.50s_flags", name);
1806 ol3 = find_option(name2, oltop, last);
1808 if (ol2 == NULL || ol3 == NULL)
1809 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1810 "rewrite rules not available for driver");
1812 if (data_block == NULL)
1814 chain = (rewrite_rule **)(ol2->value);
1815 flagptr = (int *)(ol3->value);
1819 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1820 flagptr = (int *)(US data_block + (long int)(ol3->value));
1823 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1825 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1827 chain = &(next->next);
1830 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1831 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1832 "non-header rewrite - not allowed at transport time -");
1836 /* If it was an expanded uid, see if there is any expansion to be
1837 done by checking for the presence of a $ character. If there is, save it
1838 in the corresponding *expand_user option field. Otherwise, fall through
1839 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1842 case opt_expand_uid:
1843 sprintf(CS name2, "*expand_%.50s", name);
1844 ol2 = find_option(name2, oltop, last);
1847 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1849 if (data_block == NULL)
1850 *((uschar **)(ol2->value)) = ss;
1852 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1856 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1862 /* Look up a fixed uid, and also make use of the corresponding gid
1863 if a passwd entry is returned and the gid has not been set. */
1866 if (!route_finduser(sptr, &pw, &uid))
1867 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1868 if (data_block == NULL)
1869 *((uid_t *)(ol->value)) = uid;
1871 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1873 /* Set the flag indicating a fixed value is set */
1875 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1877 /* Handle matching gid if we have a passwd entry: done by finding the
1878 same name with terminating "user" changed to "group"; if not found,
1879 ignore. Also ignore if the value is already set. */
1881 if (pw == NULL) break;
1882 Ustrcpy(name+Ustrlen(name)-4, "group");
1883 ol2 = find_option(name, oltop, last);
1884 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1885 (ol2->type & opt_mask) == opt_expand_gid))
1887 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1890 if (data_block == NULL)
1891 *((gid_t *)(ol2->value)) = pw->pw_gid;
1893 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1899 /* If it was an expanded gid, see if there is any expansion to be
1900 done by checking for the presence of a $ character. If there is, save it
1901 in the corresponding *expand_user option field. Otherwise, fall through
1902 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1905 case opt_expand_gid:
1906 sprintf(CS name2, "*expand_%.50s", name);
1907 ol2 = find_option(name2, oltop, last);
1910 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1912 if (data_block == NULL)
1913 *((uschar **)(ol2->value)) = ss;
1915 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1919 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1925 /* Handle freestanding gid */
1928 if (!route_findgroup(sptr, &gid))
1929 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1930 if (data_block == NULL)
1931 *((gid_t *)(ol->value)) = gid;
1933 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1934 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1937 /* If it was a uid list, look up each individual entry, and build
1938 a vector of uids, with a count in the first element. Put the vector
1939 in malloc store so we can free the string. (We are reading into
1940 permanent store already.) */
1948 const uschar *op = expand_string (sptr);
1951 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1952 name, expand_string_message);
1955 if (*p != 0) count++;
1956 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1957 list = store_malloc(count*sizeof(uid_t));
1958 list[ptr++] = (uid_t)(count - 1);
1960 if (data_block == NULL)
1961 *((uid_t **)(ol->value)) = list;
1963 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1969 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1970 if (!route_finduser(big_buffer, NULL, &uid))
1971 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1978 /* If it was a gid list, look up each individual entry, and build
1979 a vector of gids, with a count in the first element. Put the vector
1980 in malloc store so we can free the string. (We are reading into permanent
1989 const uschar *op = expand_string (sptr);
1992 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1993 name, expand_string_message);
1996 if (*p != 0) count++;
1997 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1998 list = store_malloc(count*sizeof(gid_t));
1999 list[ptr++] = (gid_t)(count - 1);
2001 if (data_block == NULL)
2002 *((gid_t **)(ol->value)) = list;
2004 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
2010 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2011 if (!route_findgroup(big_buffer, &gid))
2012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2020 /* Release store if the value of the string doesn't need to be kept. */
2022 if (freesptr) store_reset(reset_point);
2025 /* Expanded boolean: if no characters follow, or if there are no dollar
2026 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2027 save the string for later expansion in the alternate place. */
2029 case opt_expand_bool:
2030 if (*s != 0 && Ustrchr(s, '$') != 0)
2032 sprintf(CS name2, "*expand_%.50s", name);
2033 ol2 = find_option(name2, oltop, last);
2036 reset_point = sptr = read_string(s, name);
2037 if (data_block == NULL)
2038 *((uschar **)(ol2->value)) = sptr;
2040 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2047 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2048 look for yes/not/true/false. Some booleans are stored in a single bit in
2049 a single int. There's a special fudge for verify settings; without a suffix
2050 they set both xx_sender and xx_recipient. The table points to the sender
2051 value; search subsequently for the recipient. There's another special case:
2052 opt_bool_set also notes when a boolean has been set. */
2056 case opt_bool_verify:
2060 s = readconf_readname(name2, 64, s);
2061 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2063 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2065 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2066 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2067 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2068 US"for boolean option ", name);
2071 /* Handle single-bit type. */
2073 if (type == opt_bit)
2075 int bit = 1 << ((ol->type >> 16) & 31);
2076 int *ptr = (data_block == NULL)?
2077 (int *)(ol->value) :
2078 (int *)(US data_block + (long int)ol->value);
2079 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2083 /* Handle full BOOL types */
2085 if (data_block == NULL)
2086 *((BOOL *)(ol->value)) = boolvalue;
2088 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2092 if (type == opt_bool_verify)
2094 sprintf(CS name2, "%.50s_recipient", name + offset);
2095 ol2 = find_option(name2, oltop, last);
2098 if (data_block == NULL)
2099 *((BOOL *)(ol2->value)) = boolvalue;
2101 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2105 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2107 else if (type == opt_bool_set)
2109 sprintf(CS name2, "*set_%.50s", name + offset);
2110 ol2 = find_option(name2, oltop, last);
2113 if (data_block == NULL)
2114 *((BOOL *)(ol2->value)) = TRUE;
2116 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2125 inttype = US"octal ";
2127 /* Integer: a simple(ish) case; allow octal and hex formats, and
2128 suffixes K, M and G. The different types affect output, not input. */
2137 lvalue = strtol(CS s, CSS &endptr, intbase);
2140 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2143 if (errno != ERANGE)
2144 if (tolower(*endptr) == 'k')
2146 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2147 else lvalue *= 1024;
2150 else if (tolower(*endptr) == 'm')
2152 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2154 else lvalue *= 1024*1024;
2157 else if (tolower(*endptr) == 'g')
2159 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2161 else lvalue *= 1024*1024*1024;
2165 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2167 "absolute value of integer \"%s\" is too large (overflow)", s);
2169 while (isspace(*endptr)) endptr++;
2171 extra_chars_error(endptr, inttype, US"integer value for ", name);
2173 value = (int)lvalue;
2176 if (data_block == NULL)
2177 *((int *)(ol->value)) = value;
2179 *((int *)(US data_block + (long int)(ol->value))) = value;
2182 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2184 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2190 value = strtol(CS s, CSS &endptr, intbase);
2193 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2196 if (errno != ERANGE)
2197 if (tolower(*endptr) == 'g')
2199 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2205 else if (tolower(*endptr) == 'm')
2207 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2213 else if (tolower(*endptr) == 'k')
2216 value = (value + 512)/1024;
2218 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2219 "absolute value of integer \"%s\" is too large (overflow)", s);
2221 while (isspace(*endptr)) endptr++;
2223 extra_chars_error(endptr, inttype, US"integer value for ", name);
2226 if (data_block == NULL)
2227 *((int *)(ol->value)) = value;
2229 *((int *)(US data_block + (long int)(ol->value))) = value;
2232 /* Fixed-point number: held to 3 decimal places. */
2235 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2236 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2237 "fixed-point number expected for %s", name);
2239 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2240 "integer \"%s\" is too large (overflow)", s);
2244 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2245 "integer \"%s\" is too large (overflow)", s);
2247 /* We get a coverity error here for using count, as it derived
2248 from the tainted buffer pointed to by s, as parsed by sscanf().
2249 By the definition of sscanf we must be accessing between start
2250 and end of s (assuming it is nul-terminated...) so ignore the error. */
2251 /* coverity[tainted_data] */
2252 if (s[count] == '.')
2255 while (isdigit(s[++count]))
2257 value += (s[count] - '0') * d;
2262 while (isspace(s[count])) count++;
2265 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2267 if (data_block == NULL)
2268 *((int *)(ol->value)) = value;
2270 *((int *)(US data_block + (long int)(ol->value))) = value;
2273 /* There's a special routine to read time values. */
2276 value = readconf_readtime(s, 0, FALSE);
2278 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2280 if (data_block == NULL)
2281 *((int *)(ol->value)) = value;
2283 *((int *)(US data_block + (long int)(ol->value))) = value;
2286 /* A time list is a list of colon-separated times, with the first
2287 element holding the size of the list and the second the number of
2293 int *list = (data_block == NULL)?
2294 (int *)(ol->value) :
2295 (int *)(US data_block + (long int)(ol->value));
2297 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2300 uschar *snext = Ustrchr(s, ':');
2304 while (ss > s && isspace(ss[-1])) ss--;
2307 value = readconf_readtime(s, terminator, FALSE);
2309 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2311 if (count > 1 && value <= list[count])
2312 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2313 "time value out of order for %s", name);
2314 list[count+1] = value;
2315 if (snext == NULL) break;
2317 while (isspace(*s)) s++;
2320 if (count > list[0] - 2)
2321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2323 if (count > 0 && list[2] == 0) count = 0;
2330 void (*fn)() = ol->value;
2341 /*************************************************
2342 * Print a time value *
2343 *************************************************/
2346 Argument: a time value in seconds
2347 Returns: pointer to a fixed buffer containing the time as a string,
2348 in readconf_readtime() format
2352 readconf_printtime(int t)
2355 uschar *p = time_buffer;
2372 if (w > 0) p += sprintf(CS p, "%dw", w);
2373 if (d > 0) p += sprintf(CS p, "%dd", d);
2374 if (h > 0) p += sprintf(CS p, "%dh", h);
2375 if (m > 0) p += sprintf(CS p, "%dm", m);
2376 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2383 /*************************************************
2384 * Print an individual option value *
2385 *************************************************/
2387 /* This is used by the -bP option, so prints to the standard output.
2388 The entire options list is passed in as an argument, because some options come
2389 in pairs - typically uid/gid settings, which can either be explicit numerical
2390 values, or strings to be expanded later. If the numerical value is unset,
2391 search for "*expand_<name>" to see if there is a string equivalent.
2394 ol option entry, or NULL for an unknown option
2396 options_block NULL for main configuration options; otherwise points to
2397 a driver block; if the option doesn't have opt_public
2398 set, then options_block->options_block is where the item
2400 oltop points to the option list in which ol exists
2401 last one more than the offset of the last entry in optop
2402 no_labels do not show "foo = " at the start.
2404 Returns: boolean success
2408 print_ol(optionlist *ol, uschar *name, void *options_block,
2409 optionlist *oltop, int last, BOOL no_labels)
2422 printf("%s is not a known option\n", name);
2426 /* Non-admin callers cannot see options that have been flagged secure by the
2429 if (!f.admin_user && ol->type & opt_secure)
2432 printf("%s\n", hidden);
2434 printf("%s = %s\n", name, hidden);
2438 /* Else show the value of the option */
2443 if (!(ol->type & opt_public))
2444 options_block = (void *)(((driver_instance *)options_block)->options_block);
2445 value = (void *)(US options_block + (long int)value);
2448 switch(ol->type & opt_mask)
2451 case opt_rewrite: /* Show the text value */
2453 if (!no_labels) printf("%s = ", name);
2454 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2458 if (!no_labels) printf("%s = ", name);
2459 printf("%d\n", *((int *)value));
2464 int x = *((int *)value);
2465 if (x != 0 && (x & 1023) == 0)
2469 if ((x & 1023) == 0)
2474 if (!no_labels) printf("%s = ", name);
2475 printf("%d%c\n", x, c);
2479 if (!no_labels) printf("%s = ", name);
2487 int x = *((int *)value);
2488 if (!no_labels) printf("%s = ", name);
2489 if (x == 0) printf("0\n");
2490 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2491 else printf("%dK\n", x);
2496 if (!no_labels) printf("%s = ", name);
2497 printf("%#o\n", *((int *)value));
2500 /* Can be negative only when "unset", in which case integer */
2504 int x = *((int *)value);
2507 if (x < 0) printf("%s =\n", name); else
2509 if (!no_labels) printf("%s = ", name);
2510 printf("%d.", x/1000);
2523 /* If the numerical value is unset, try for the string value */
2525 case opt_expand_uid:
2526 if (! *get_set_flag(name, oltop, last, options_block))
2528 sprintf(CS name2, "*expand_%.50s", name);
2529 if ((ol2 = find_option(name2, oltop, last)))
2531 void *value2 = ol2->value;
2533 value2 = (void *)(US options_block + (long int)value2);
2535 if (!no_labels) printf("%s = ", name);
2536 printf("%s\n", s ? string_printing(s) : US"");
2541 /* Else fall through */
2544 if (!no_labels) printf("%s = ", name);
2545 if (! *get_set_flag(name, oltop, last, options_block))
2548 if ((pw = getpwuid(*((uid_t *)value))))
2549 printf("%s\n", pw->pw_name);
2551 printf("%ld\n", (long int)(*((uid_t *)value)));
2554 /* If the numerical value is unset, try for the string value */
2556 case opt_expand_gid:
2557 if (! *get_set_flag(name, oltop, last, options_block))
2559 sprintf(CS name2, "*expand_%.50s", name);
2560 if ( (ol2 = find_option(name2, oltop, last))
2561 && (ol2->type & opt_mask) == opt_stringptr)
2563 void *value2 = ol2->value;
2565 value2 = (void *)(US options_block + (long int)value2);
2567 if (!no_labels) printf("%s = ", name);
2568 printf("%s\n", s ? string_printing(s) : US"");
2573 /* Else fall through */
2576 if (!no_labels) printf("%s = ", name);
2577 if (! *get_set_flag(name, oltop, last, options_block))
2580 if ((gr = getgrgid(*((int *)value))))
2581 printf("%s\n", gr->gr_name);
2583 printf("%ld\n", (long int)(*((int *)value)));
2587 uidlist = *((uid_t **)value);
2588 if (!no_labels) printf("%s =", name);
2592 uschar sep = no_labels ? '\0' : ' ';
2593 for (i = 1; i <= (int)(uidlist[0]); i++)
2595 uschar *name = NULL;
2596 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2597 if (sep != '\0') printf("%c", sep);
2598 if (name) printf("%s", name);
2599 else printf("%ld", (long int)(uidlist[i]));
2607 gidlist = *((gid_t **)value);
2608 if (!no_labels) printf("%s =", name);
2612 uschar sep = no_labels ? '\0' : ' ';
2613 for (i = 1; i <= (int)(gidlist[0]); i++)
2615 uschar *name = NULL;
2616 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2617 if (sep != '\0') printf("%c", sep);
2618 if (name) printf("%s", name);
2619 else printf("%ld", (long int)(gidlist[i]));
2627 if (!no_labels) printf("%s = ", name);
2628 printf("%s\n", readconf_printtime(*((int *)value)));
2634 int *list = (int *)value;
2635 if (!no_labels) printf("%s = ", name);
2636 for (i = 0; i < list[1]; i++)
2637 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2643 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2647 case opt_expand_bool:
2648 sprintf(CS name2, "*expand_%.50s", name);
2649 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2651 void *value2 = ol2->value;
2653 value2 = (void *)(US options_block + (long int)value2);
2657 if (!no_labels) printf("%s = ", name);
2658 printf("%s\n", string_printing(s));
2661 /* s == NULL => string not set; fall through */
2667 case opt_bool_verify:
2669 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2677 /*************************************************
2678 * Print value from main configuration *
2679 *************************************************/
2681 /* This function, called as a result of encountering the -bP option,
2682 causes the value of any main configuration variable to be output if the
2683 second argument is NULL. There are some special values:
2685 all print all main configuration options
2686 config_file print the name of the configuration file
2687 (configure_file will still work, for backward
2689 routers print the routers' configurations
2690 transports print the transports' configuration
2691 authenticators print the authenticators' configuration
2692 macros print the macros' configuration
2693 router_list print a list of router names
2694 transport_list print a list of transport names
2695 authenticator_list print a list of authentication mechanism names
2696 macro_list print a list of macro names
2697 +name print a named list item
2698 local_scan print the local_scan options
2699 config print the configuration as it is parsed
2700 environment print the used execution environment
2702 If the second argument is not NULL, it must be one of "router", "transport",
2703 "authenticator" or "macro" in which case the first argument identifies the
2704 driver whose options are to be printed.
2707 name option name if type == NULL; else driver name
2708 type NULL or driver type name, as described above
2709 no_labels avoid the "foo = " at the start of an item
2711 Returns: Boolean success
2715 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2717 BOOL names_only = FALSE;
2719 optionlist *ol2 = NULL;
2720 driver_instance *d = NULL;
2731 static uschar *types[] = { US"address", US"domain", US"host",
2733 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2734 &hostlist_anchor, &localpartlist_anchor };
2736 for (i = 0; i < 4; i++)
2737 if ((t = tree_search(*(anchors[i]), name+1)))
2741 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2743 printf("%slist %s = %s\n", types[i], name+1,
2744 ((namedlist_block *)(t->data.ptr))->string);
2748 printf("no address, domain, host, or local part list called \"%s\" "
2749 "exists\n", name+1);
2754 if ( Ustrcmp(name, "configure_file") == 0
2755 || Ustrcmp(name, "config_file") == 0)
2757 printf("%s\n", CS config_main_filename);
2761 if (Ustrcmp(name, "all") == 0)
2763 for (ol = optionlist_config;
2764 ol < optionlist_config + nelem(optionlist_config); ol++)
2765 if (!(ol->type & opt_hidden))
2766 (void) print_ol(ol, US ol->name, NULL,
2767 optionlist_config, nelem(optionlist_config),
2772 if (Ustrcmp(name, "local_scan") == 0)
2774 #ifndef LOCAL_SCAN_HAS_OPTIONS
2775 printf("local_scan() options are not supported\n");
2778 for (ol = local_scan_options;
2779 ol < local_scan_options + local_scan_options_count; ol++)
2780 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2781 local_scan_options_count, no_labels);
2786 if (Ustrcmp(name, "config") == 0)
2788 print_config(f.admin_user, no_labels);
2792 if (Ustrcmp(name, "routers") == 0)
2797 else if (Ustrcmp(name, "transports") == 0)
2799 type = US"transport";
2802 else if (Ustrcmp(name, "authenticators") == 0)
2804 type = US"authenticator";
2807 else if (Ustrcmp(name, "macros") == 0)
2812 else if (Ustrcmp(name, "router_list") == 0)
2818 else if (Ustrcmp(name, "transport_list") == 0)
2820 type = US"transport";
2824 else if (Ustrcmp(name, "authenticator_list") == 0)
2826 type = US"authenticator";
2830 else if (Ustrcmp(name, "macro_list") == 0)
2836 else if (Ustrcmp(name, "environment") == 0)
2841 for (p = USS environ; *p; p++) ;
2842 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2844 for (p = USS environ; *p; p++)
2847 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2855 return print_ol(find_option(name,
2856 optionlist_config, nelem(optionlist_config)),
2857 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2860 /* Handle the options for a router or transport. Skip options that are flagged
2861 as hidden. Some of these are options with names starting with '*', used for
2862 internal alternative representations of other options (which the printing
2863 function will sort out). Others are synonyms kept for backward compatibility.
2866 if (Ustrcmp(type, "router") == 0)
2868 d = (driver_instance *)routers;
2869 ol2 = optionlist_routers;
2870 size = optionlist_routers_size;
2872 else if (Ustrcmp(type, "transport") == 0)
2874 d = (driver_instance *)transports;
2875 ol2 = optionlist_transports;
2876 size = optionlist_transports_size;
2878 else if (Ustrcmp(type, "authenticator") == 0)
2880 d = (driver_instance *)auths;
2881 ol2 = optionlist_auths;
2882 size = optionlist_auths_size;
2885 else if (Ustrcmp(type, "macro") == 0)
2887 /* People store passwords in macros and they were previously not available
2888 for printing. So we have an admin_users restriction. */
2891 fprintf(stderr, "exim: permission denied\n");
2894 for (m = macros; m; m = m->next)
2895 if (!name || Ustrcmp(name, m->name) == 0)
2898 printf("%s\n", CS m->name);
2900 printf("%s\n", CS m->replacement);
2902 printf("%s=%s\n", CS m->name, CS m->replacement);
2906 if (!name) return TRUE;
2908 printf("%s %s not found\n", type, name);
2914 for (; d; d = d->next) printf("%s\n", CS d->name);
2918 /* Either search for a given driver, or print all of them */
2920 for (; d; d = d->next)
2924 printf("\n%s %s:\n", d->name, type);
2925 else if (Ustrcmp(d->name, name) != 0) continue;
2927 for (ol = ol2; ol < ol2 + size; ol++)
2928 if (!(ol->type & opt_hidden))
2929 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2931 for (ol = d->info->options;
2932 ol < d->info->options + *(d->info->options_count); ol++)
2933 if (!(ol->type & opt_hidden))
2934 rc |= print_ol(ol, US ol->name, d, d->info->options,
2935 *d->info->options_count, no_labels);
2937 if (name) return rc;
2939 if (!name) return TRUE;
2941 printf("%s %s not found\n", type, name);
2947 /*************************************************
2948 * Read a named list item *
2949 *************************************************/
2951 /* This function reads a name and a list (i.e. string). The name is used to
2952 save the list in a tree, sorted by its name. Each entry also has a number,
2953 which can be used for caching tests, but if the string contains any expansion
2954 items other than $key, the number is set negative to inhibit caching. This
2955 mechanism is used for domain, host, and address lists that are referenced by
2959 anchorp points to the tree anchor
2960 numberp points to the current number for this tree
2961 max the maximum number permitted
2962 s the text of the option line, starting immediately after the name
2964 tname the name of the list type, for messages
2970 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2973 BOOL forcecache = FALSE;
2976 namedlist_block *nb = store_get(sizeof(namedlist_block));
2978 if (Ustrncmp(s, "_cache", 6) == 0)
2985 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2987 if (*numberp >= max)
2988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2991 while (isspace(*s)) s++;
2993 while (isalnum(*s) || *s == '_') s++;
2994 t = store_get(sizeof(tree_node) + s-ss);
2995 Ustrncpy(t->name, ss, s-ss);
2997 while (isspace(*s)) s++;
2999 if (!tree_insertnode(anchorp, t))
3000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3001 "duplicate name \"%s\" for a named %s", t->name, tname);
3004 nb->number = *numberp;
3007 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3008 "missing '=' after \"%s\"", t->name);
3009 while (isspace(*s)) s++;
3010 nb->string = read_string(s, t->name);
3011 nb->cache_data = NULL;
3013 /* Check the string for any expansions; if any are found, mark this list
3014 uncacheable unless the user has explicited forced caching. */
3016 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3022 /*************************************************
3023 * Unpick data for a rate limit *
3024 *************************************************/
3026 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3030 s string, in the form t,b,f,l
3031 where t is the threshold (integer)
3032 b is the initial delay (time)
3033 f is the multiplicative factor (fixed point)
3034 k is the maximum time (time)
3035 threshold where to store threshold
3036 base where to store base in milliseconds
3037 factor where to store factor in milliseconds
3038 limit where to store limit
3040 Returns: nothing (panics on error)
3044 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3047 uschar bstring[16], lstring[16];
3049 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3050 factor, lstring) == 4)
3052 *base = readconf_readtime(bstring, 0, TRUE);
3053 *limit = readconf_readtime(lstring, 0, TRUE);
3054 if (*base >= 0 && *limit >= 0) return;
3056 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3062 /*************************************************
3063 * Drop privs for checking TLS config *
3064 *************************************************/
3066 /* We want to validate TLS options during readconf, but do not want to be
3067 root when we call into the TLS library, in case of library linkage errors
3068 which cause segfaults; before this check, those were always done as the Exim
3069 runtime user and it makes sense to continue with that.
3071 Assumes: tls_require_ciphers has been set, if it will be
3072 exim_user has been set, if it will be
3073 exim_group has been set, if it will be
3075 Returns: bool for "okay"; false will cause caller to immediately exit.
3080 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3082 const uschar *errmsg;
3085 void (*oldsignal)(int);
3087 /* If TLS will never be used, no point checking ciphers */
3089 if ( !tls_advertise_hosts
3090 || !*tls_advertise_hosts
3091 || Ustrcmp(tls_advertise_hosts, ":") == 0
3094 else if (!nowarn && !tls_certificate)
3095 log_write(0, LOG_MAIN,
3096 "Warning: No server certificate defined; will use a selfsigned one.\n"
3097 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3099 oldsignal = signal(SIGCHLD, SIG_DFL);
3102 if ((pid = fork()) < 0)
3103 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3107 /* in some modes, will have dropped privilege already */
3109 exim_setugid(exim_uid, exim_gid, FALSE,
3110 US"calling tls_validate_require_cipher");
3112 if ((errmsg = tls_validate_require_cipher()))
3113 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3114 "tls_require_ciphers invalid: %s", errmsg);
3120 rc = waitpid(pid, &status, 0);
3121 } while (rc < 0 && errno == EINTR);
3124 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3127 signal(SIGCHLD, oldsignal);
3131 #endif /* SUPPORT_TLS */
3136 /*************************************************
3137 * Read main configuration options *
3138 *************************************************/
3140 /* This function is the first to be called for configuration reading. It
3141 opens the configuration file and reads general configuration settings until
3142 it reaches the end of the configuration section. The file is then left open so
3143 that the remaining configuration data can subsequently be read if needed for
3146 The configuration file must be owned either by root or exim, and be writeable
3147 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3148 in the config file, so the test is done on the compiled in values. A slight
3149 anomaly, to be carefully documented.
3151 The name of the configuration file is taken from a list that is included in the
3152 binary of Exim. It can be altered from the command line, but if that is done,
3153 root privilege is immediately withdrawn unless the caller is root or exim.
3154 The first file on the list that exists is used.
3156 For use on multiple systems that share file systems, first look for a
3157 configuration file whose name has the current node name on the end. If that is
3158 not found, try the generic name. For really contorted configurations, that run
3159 multiple Exims with different uid settings, first try adding the effective uid
3160 before the node name. These complications are going to waste resources on most
3161 systems. Therefore they are available only when requested by compile-time
3165 readconf_main(BOOL nowarn)
3168 struct stat statbuf;
3169 uschar *s, *filename;
3170 const uschar *list = config_main_filelist;
3172 /* Loop through the possible file names */
3174 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3177 /* Cut out all the fancy processing unless specifically wanted */
3179 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3180 uschar *suffix = filename + Ustrlen(filename);
3182 /* Try for the node-specific file if a node name exists */
3184 #ifdef CONFIGURE_FILE_USE_NODE
3186 if (uname(&uts) >= 0)
3188 #ifdef CONFIGURE_FILE_USE_EUID
3189 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3190 config_file = Ufopen(filename, "rb");
3191 if (config_file == NULL)
3192 #endif /* CONFIGURE_FILE_USE_EUID */
3194 sprintf(CS suffix, ".%.256s", uts.nodename);
3195 config_file = Ufopen(filename, "rb");
3198 #endif /* CONFIGURE_FILE_USE_NODE */
3200 /* Otherwise, try the generic name, possibly with the euid added */
3202 #ifdef CONFIGURE_FILE_USE_EUID
3203 if (config_file == NULL)
3205 sprintf(CS suffix, ".%ld", (long int)original_euid);
3206 config_file = Ufopen(filename, "rb");
3208 #endif /* CONFIGURE_FILE_USE_EUID */
3210 /* Finally, try the unadorned name */
3212 if (config_file == NULL)
3215 config_file = Ufopen(filename, "rb");
3217 #else /* if neither defined */
3219 /* This is the common case when the fancy processing is not included. */
3221 config_file = Ufopen(filename, "rb");
3224 /* If the file does not exist, continue to try any others. For any other
3225 error, break out (and die). */
3227 if (config_file != NULL || errno != ENOENT) break;
3230 /* On success, save the name for verification; config_filename is used when
3231 logging configuration errors (it changes for .included files) whereas
3232 config_main_filename is the name shown by -bP. Failure to open a configuration
3233 file is a serious disaster. */
3237 uschar *last_slash = Ustrrchr(filename, '/');
3238 config_filename = config_main_filename = string_copy(filename);
3240 /* The config_main_directory we need for the $config_dir expansion.
3241 config_main_filename we need for $config_file expansion.
3242 And config_dir is the directory of the current configuration, used for
3243 relative .includes. We do need to know it's name, as we change our working
3246 if (filename[0] == '/')
3247 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3250 /* relative configuration file name: working dir + / + basename(filename) */
3252 uschar buf[PATH_MAX];
3255 if (os_getcwd(buf, PATH_MAX) == NULL)
3257 perror("exim: getcwd");
3260 g = string_cat(NULL, buf);
3262 /* If the dir does not end with a "/", append one */
3263 if (g->s[g->ptr-1] != '/')
3264 g = string_catn(g, US"/", 1);
3266 /* If the config file contains a "/", extract the directory part */
3268 g = string_catn(g, filename, last_slash - filename);
3270 config_main_directory = string_from_gstring(g);
3272 config_directory = config_main_directory;
3276 if (filename == NULL)
3277 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3278 "%s", config_main_filelist);
3280 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3281 "configuration file %s", filename));
3284 /* Now, once we found and opened our configuration file, we change the directory
3285 to a safe place. Later we change to $spool_directory. */
3287 if (Uchdir("/") < 0)
3289 perror("exim: chdir `/': ");
3293 /* Check the status of the file we have opened, if we have retained root
3294 privileges and the file isn't /dev/null (which *should* be 0666). */
3296 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3298 if (fstat(fileno(config_file), &statbuf) != 0)
3299 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3302 if ((statbuf.st_uid != root_uid /* owner not root */
3303 #ifdef CONFIGURE_OWNER
3304 && statbuf.st_uid != config_uid /* owner not the special one */
3307 (statbuf.st_gid != root_gid /* group not root & */
3308 #ifdef CONFIGURE_GROUP
3309 && statbuf.st_gid != config_gid /* group not the special one */
3311 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3313 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3316 "wrong owner, group, or mode", big_buffer);
3319 /* Process the main configuration settings. They all begin with a lower case
3320 letter. If we see something starting with an upper case letter, it is taken as
3321 a macro definition. */
3323 while ((s = get_config_line()))
3325 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3326 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3327 "found unexpected BOM (Byte Order Mark)");
3330 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3332 else if (Ustrncmp(s, "domainlist", 10) == 0)
3333 read_named_list(&domainlist_anchor, &domainlist_count,
3334 MAX_NAMED_LIST, s+10, US"domain list");
3336 else if (Ustrncmp(s, "hostlist", 8) == 0)
3337 read_named_list(&hostlist_anchor, &hostlist_count,
3338 MAX_NAMED_LIST, s+8, US"host list");
3340 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3341 read_named_list(&addresslist_anchor, &addresslist_count,
3342 MAX_NAMED_LIST, s+11, US"address list");
3344 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3345 read_named_list(&localpartlist_anchor, &localpartlist_count,
3346 MAX_NAMED_LIST, s+13, US"local part list");
3349 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3350 NULL, US"main option \"%s\" unknown");
3354 /* If local_sender_retain is set, local_from_check must be unset. */
3356 if (local_sender_retain && local_from_check)
3357 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3358 "local_sender_retain are set; this combination is not allowed");
3360 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3363 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3365 /* The max retry interval must not be greater than 24 hours. */
3367 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3369 /* remote_max_parallel must be > 0 */
3371 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3373 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3374 start of a new SMTP message. */
3376 freeze_tell_config = freeze_tell;
3378 /* The primary host name may be required for expansion of spool_directory
3379 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3380 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3381 canonize it. Some people like upper case letters in their host names, so we
3382 don't force the case. */
3384 if (primary_hostname == NULL)
3386 const uschar *hostname;
3388 if (uname(&uts) < 0)
3389 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3390 hostname = US uts.nodename;
3392 if (Ustrchr(hostname, '.') == NULL)
3395 struct hostent *hostdata;
3398 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3399 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3400 MCL_DOMAIN, TRUE, NULL) != OK))
3409 #if HAVE_GETIPNODEBYNAME
3411 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3413 hostdata = gethostbyname2(CS hostname, af);
3416 hostdata = gethostbyname(CS hostname);
3419 if (hostdata != NULL)
3421 hostname = US hostdata->h_name;
3425 if (af == AF_INET) break;
3430 primary_hostname = string_copy(hostname);
3433 /* Set up default value for smtp_active_hostname */
3435 smtp_active_hostname = primary_hostname;
3437 /* If spool_directory wasn't set in the build-time configuration, it must have
3438 got set above. Of course, writing to the log may not work if log_file_path is
3439 not set, but it will at least get to syslog or somewhere, with any luck. */
3441 if (*spool_directory == 0)
3442 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3445 /* Expand the spool directory name; it may, for example, contain the primary
3446 host name. Same comment about failure. */
3448 s = expand_string(spool_directory);
3450 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3451 "\"%s\": %s", spool_directory, expand_string_message);
3452 spool_directory = s;
3454 /* Expand log_file_path, which must contain "%s" in any component that isn't
3455 the null string or "syslog". It is also allowed to contain one instance of %D
3456 or %M. However, it must NOT contain % followed by anything else. */
3458 if (*log_file_path != 0)
3460 const uschar *ss, *sss;
3461 int sep = ':'; /* Fixed for log file path */
3462 s = expand_string(log_file_path);
3464 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3465 "\"%s\": %s", log_file_path, expand_string_message);
3468 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3471 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3472 t = Ustrstr(sss, "%s");
3474 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3475 "contain \"%%s\"", sss);
3477 t = Ustrchr(sss, '%');
3480 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3481 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3482 "unexpected \"%%\" character", s);
3489 /* Interpret syslog_facility into an integer argument for 'ident' param to
3490 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3493 if (syslog_facility_str)
3496 uschar *s = syslog_facility_str;
3498 if ((Ustrlen(syslog_facility_str) >= 4) &&
3499 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3502 for (i = 0; i < syslog_list_size; i++)
3503 if (strcmpic(s, syslog_list[i].name) == 0)
3505 syslog_facility = syslog_list[i].value;
3509 if (i >= syslog_list_size)
3510 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3511 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3514 /* Expand pid_file_path */
3516 if (*pid_file_path != 0)
3518 if (!(s = expand_string(pid_file_path)))
3519 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3520 "\"%s\": %s", pid_file_path, expand_string_message);
3524 /* Set default value of process_log_path */
3526 if (!process_log_path || *process_log_path =='\0')
3527 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3529 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3532 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3534 /* Unpick the SMTP rate limiting options, if set */
3536 if (smtp_ratelimit_mail)
3537 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3538 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3540 if (smtp_ratelimit_rcpt)
3541 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3542 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3544 /* The qualify domains default to the primary host name */
3546 if (!qualify_domain_sender)
3547 qualify_domain_sender = primary_hostname;
3548 if (!qualify_domain_recipient)
3549 qualify_domain_recipient = qualify_domain_sender;
3551 /* Setting system_filter_user in the configuration sets the gid as well if a
3552 name is given, but a numerical value does not. */
3554 if (system_filter_uid_set && !system_filter_gid_set)
3556 struct passwd *pw = getpwuid(system_filter_uid);
3558 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3559 (long int)system_filter_uid);
3560 system_filter_gid = pw->pw_gid;
3561 system_filter_gid_set = TRUE;
3564 /* If the errors_reply_to field is set, check that it is syntactically valid
3565 and ensure it contains a domain. */
3567 if (errors_reply_to)
3570 int start, end, domain;
3571 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3572 &start, &end, &domain, FALSE);
3575 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3576 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3579 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3580 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3583 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3584 smtp_accept_max must also be set. */
3586 if (smtp_accept_max == 0 &&
3587 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3589 "smtp_accept_max must be set if smtp_accept_queue or "
3590 "smtp_accept_max_per_host is set");
3592 /* Set up the host number if anything is specified. It is an expanded string
3593 so that it can be computed from the host name, for example. We do this last
3594 so as to ensure that everything else is set up before the expansion. */
3596 if (host_number_string)
3600 uschar *s = expand_string(host_number_string);
3603 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3604 "failed to expand localhost_number \"%s\": %s",
3605 host_number_string, expand_string_message);
3606 n = Ustrtol(s, &end, 0);
3607 while (isspace(*end)) end++;
3609 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3610 "localhost_number value is not a number: %s", s);
3611 if (n > LOCALHOST_MAX)
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3613 "localhost_number is greater than the maximum allowed value (%d)",
3619 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3621 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3622 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3623 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3624 tls_verify_hosts ? "" : "try_");
3626 /* This also checks that the library linkage is working and we can call
3627 routines in it, so call even if tls_require_ciphers is unset */
3628 if (!tls_dropprivs_validate_require_cipher(nowarn))
3631 /* Magic number: at time of writing, 1024 has been the long-standing value
3632 used by so many clients, and what Exim used to use always, that it makes
3633 sense to just min-clamp this max-clamp at that. */
3634 if (tls_dh_max_bits < 1024)
3635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3636 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3638 /* If openssl_options is set, validate it */
3639 if (openssl_options)
3642 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3643 "openssl_options is set but we're using GnuTLS");
3646 if (!tls_openssl_options_parse(openssl_options, &dummy))
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3648 "openssl_options parse error: %s", openssl_options);
3651 #endif /*SUPPORT_TLS*/
3653 if (!nowarn && !keep_environment && environ && *environ)
3654 log_write(0, LOG_MAIN,
3655 "Warning: purging the environment.\n"
3656 " Suggested action: use keep_environment.");
3661 /*************************************************
3662 * Initialize one driver *
3663 *************************************************/
3665 /* This is called once the driver's generic options, if any, have been read.
3666 We can now find the driver, set up defaults for the private options, and
3667 unset any "set" bits in the private options table (which might have been
3668 set by another incarnation of the same driver).
3671 d pointer to driver instance block, with generic
3673 drivers_available vector of available drivers
3674 size_of_info size of each block in drivers_available
3675 class class of driver, for error message
3677 Returns: pointer to the driver info block
3680 static driver_info *
3681 init_driver(driver_instance *d, driver_info *drivers_available,
3682 int size_of_info, uschar *class)
3686 for (dd = drivers_available; dd->driver_name[0] != 0;
3687 dd = (driver_info *)((US dd) + size_of_info))
3689 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3692 int len = dd->options_len;
3694 d->options_block = store_get(len);
3695 memcpy(d->options_block, dd->options_block, len);
3696 for (i = 0; i < *(dd->options_count); i++)
3697 dd->options[i].type &= ~opt_set;
3702 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3703 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3705 return NULL; /* never obeyed */
3711 /*************************************************
3712 * Initialize driver list *
3713 *************************************************/
3715 /* This function is called for routers, transports, and authentication
3716 mechanisms. It reads the data from the current point in the configuration file
3717 up to the end of the section, and sets up a chain of instance blocks according
3718 to the file's contents. The file will already have been opened by a call to
3719 readconf_main, and must be left open for subsequent reading of further data.
3721 Any errors cause a panic crash. Note that the blocks with names driver_info and
3722 driver_instance must map the first portions of all the _info and _instance
3723 blocks for this shared code to work.
3726 class "router", "transport", or "authenticator"
3727 anchor &routers, &transports, &auths
3728 drivers_available available drivers
3729 size_of_info size of each info block
3730 instance_default points to default data for an instance
3731 instance_size size of instance block
3732 driver_optionlist generic option list
3733 driver_optionlist_count count of generic option list
3739 readconf_driver_init(
3741 driver_instance **anchor,
3742 driver_info *drivers_available,
3744 void *instance_default,
3746 optionlist *driver_optionlist,
3747 int driver_optionlist_count)
3749 driver_instance **p = anchor;
3750 driver_instance *d = NULL;
3753 while ((buffer = get_config_line()) != NULL)
3758 /* Read the first name on the line and test for the start of a new driver. A
3759 macro definition indicates the end of the previous driver. If this isn't the
3760 start of a new driver, the line will be re-read. */
3762 s = readconf_readname(name, sizeof(name), buffer);
3764 /* Handle macro definition, first finishing off the initialization of the
3765 previous driver, if any. */
3767 if (isupper(*name) && *s == '=')
3771 if (!d->driver_name)
3772 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3773 "no driver defined for %s \"%s\"", class, d->name);
3777 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3781 /* If the line starts with a name terminated by a colon, we are at the
3782 start of the definition of a new driver. The rest of the line must be
3789 /* Finish off initializing the previous driver. */
3793 if (!d->driver_name)
3794 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3795 "no driver defined for %s \"%s\"", class, d->name);
3799 /* Check that we haven't already got a driver of this name */
3801 for (d = *anchor; d; d = d->next)
3802 if (Ustrcmp(name, d->name) == 0)
3803 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3804 "there are two %ss called \"%s\"", class, name);
3806 /* Set up a new driver instance data block on the chain, with
3807 its default values installed. */
3809 d = store_get(instance_size);
3810 memcpy(d, instance_default, instance_size);
3813 d->name = string_copy(name);
3815 /* Clear out the "set" bits in the generic options */
3817 for (i = 0; i < driver_optionlist_count; i++)
3818 driver_optionlist[i].type &= ~opt_set;
3820 /* Check nothing more on this line, then do the next loop iteration. */
3822 while (isspace(*s)) s++;
3823 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3827 /* Not the start of a new driver. Give an error if we have not set up a
3828 current driver yet. */
3831 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3833 /* First look to see if this is a generic option; if it is "driver",
3834 initialize the driver. If is it not a generic option, we can look for a
3835 private option provided that the driver has been previously set up. */
3837 if (readconf_handle_option(buffer, driver_optionlist,
3838 driver_optionlist_count, d, NULL))
3840 if (!d->info && d->driver_name)
3841 init_driver(d, drivers_available, size_of_info, class);
3844 /* Handle private options - pass the generic block because some may
3845 live therein. A flag with each option indicates if it is in the public
3849 readconf_handle_option(buffer, d->info->options,
3850 *(d->info->options_count), d, US"option \"%s\" unknown");
3852 /* The option is not generic and the driver name has not yet been given. */
3854 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3855 "(\"driver\" must be specified before any private options)", name);
3858 /* Run the initialization function for the final driver. */
3862 if (!d->driver_name)
3863 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3864 "no driver defined for %s \"%s\"", class, d->name);
3871 /*************************************************
3872 * Check driver dependency *
3873 *************************************************/
3875 /* This function is passed a driver instance and a string. It checks whether
3876 any of the string options for the driver contains the given string as an
3880 d points to a driver instance block
3881 s the string to search for
3883 Returns: TRUE if a dependency is found
3887 readconf_depends(driver_instance *d, uschar *s)
3889 int count = *(d->info->options_count);
3893 for (ol = d->info->options; ol < d->info->options + count; ol++)
3895 void *options_block;
3897 int type = ol->type & opt_mask;
3898 if (type != opt_stringptr) continue;
3899 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3900 value = *(uschar **)(US options_block + (long int)(ol->value));
3901 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3903 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3904 isalnum(ss[Ustrlen(s)])) continue;
3905 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3906 d->name, ol->name, s);
3911 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3918 /*************************************************
3919 * Decode an error type for retries *
3920 *************************************************/
3922 /* This function is global because it is also called from the main
3923 program when testing retry information. It decodes strings such as "quota_7d"
3924 into numerical error codes.
3927 pp points to start of text
3928 p points past end of text
3929 basic_errno points to an int to receive the main error number
3930 more_errno points to an int to receive the secondary error data
3932 Returns: NULL if decoded correctly; else points to error text
3936 readconf_retry_error(const uschar *pp, const uschar *p,
3937 int *basic_errno, int *more_errno)
3940 const uschar *q = pp;
3941 while (q < p && *q != '_') q++;
3944 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3946 *basic_errno = ERRNO_EXIMQUOTA;
3947 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3948 return US"bad time value";
3951 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3953 *basic_errno = ECONNREFUSED;
3956 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3957 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3958 else return US"A or MX expected after \"refused\"";
3962 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3964 *basic_errno = ETIMEDOUT;
3968 int xlen = p - q - 1;
3969 const uschar *x = q + 1;
3971 static uschar *extras[] =
3972 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3973 static int values[] =
3974 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3976 for (i = 0; i < nelem(extras); i++)
3977 if (strncmpic(x, extras[i], xlen) == 0)
3979 *more_errno = values[i];
3983 if (i >= nelem(extras))
3984 if (strncmpic(x, US"DNS", xlen) == 0)
3985 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3986 "available in retry rules (it has never worked) - treated as "
3989 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3993 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3994 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3995 strncmpic(pp, US"data_4", 6) == 0)
3998 int x = 255; /* means "any 4xx code" */
3999 if (p != pp + 8) bad = TRUE; else
4001 int a = pp[6], b = pp[7];
4005 if (isdigit(b)) x += b - '0';
4006 else if (b == 'x') x += 100;
4009 else if (a != 'x' || b != 'x') bad = TRUE;
4013 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4014 "x is literal and d is any digit", pp);
4016 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4017 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4018 *more_errno = x << 8;
4021 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4022 strncmpic(q+1, US"failed", p-q-1) == 0)
4023 *basic_errno = ERRNO_AUTHFAIL;
4025 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4026 *basic_errno = ERRNO_SMTPCLOSED;
4028 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4029 *basic_errno = ERRNO_TLSREQUIRED;
4031 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4032 *basic_errno = ERRNO_UNKNOWNHOST;
4034 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4035 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4043 /*************************************************
4044 * Read retry information *
4045 *************************************************/
4047 /* Each line of retry information contains:
4049 . A domain name pattern or an address pattern;
4051 . An error name, possibly with additional data, or *;
4053 . An optional sequence of retry items, each consisting of an identifying
4054 letter, a cutoff time, and optional parameters.
4056 All this is decoded and placed into a control block. */
4059 /* Subroutine to read an argument, preceded by a comma and terminated
4060 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4061 1 = fixed point number (returned *1000).
4064 paddr pointer to pointer to current character; updated
4065 type 0 => read a time; 1 => read a fixed point number
4067 Returns: time in seconds or fixed point number * 1000
4071 retry_arg(const uschar **paddr, int type)
4073 const uschar *p = *paddr;
4076 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4078 while (isspace(*p)) p++;
4080 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4082 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4083 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4088 case 0: return readconf_readtime(pp, *p, FALSE);
4089 case 1: return readconf_readfixed(pp, *p);
4091 return 0; /* Keep picky compilers happy */
4094 /* The function proper */
4097 readconf_retries(void)
4099 retry_config **chain = &retries;
4103 while ((p = get_config_line()))
4105 retry_rule **rchain;
4109 next = store_get(sizeof(retry_config));
4112 chain = &(next->next);
4113 next->basic_errno = next->more_errno = 0;
4114 next->senders = NULL;
4116 rchain = &(next->rules);
4118 next->pattern = string_dequote(&p);
4119 while (isspace(*p)) p++;
4121 while (mac_isgraph(*p)) p++;
4122 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4123 "missing error type in retry rule");
4125 /* Test error names for things we understand. */
4127 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4128 &next->more_errno)))
4129 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4131 /* There may be an optional address list of senders to be used as another
4132 constraint on the rule. This was added later, so the syntax is a bit of a
4133 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4136 while (isspace(*p)) p++;
4137 if (Ustrncmp(p, "senders", 7) == 0)
4140 while (isspace(*p)) p++;
4141 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4142 "\"=\" expected after \"senders\" in retry rule");
4143 while (isspace(*p)) p++;
4144 next->senders = string_dequote(&p);
4147 /* Now the retry rules. Keep the maximum timeout encountered. */
4149 while (isspace(*p)) p++;
4153 retry_rule *rule = store_get(sizeof(retry_rule));
4155 rchain = &(rule->next);
4157 rule->rule = toupper(*p++);
4158 rule->timeout = retry_arg(&p, 0);
4159 if (rule->timeout > retry_maximum_timeout)
4160 retry_maximum_timeout = rule->timeout;
4164 case 'F': /* Fixed interval */
4165 rule->p1 = retry_arg(&p, 0);
4168 case 'G': /* Geometrically increasing intervals */
4169 case 'H': /* Ditto, but with randomness */
4170 rule->p1 = retry_arg(&p, 0);
4171 rule->p2 = retry_arg(&p, 1);
4175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4179 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4180 (rule->rule != 'F' && rule->p2 < 1000))
4181 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4182 "bad parameters for retry rule");
4184 while (isspace(*p)) p++;
4188 while (isspace(*p)) p++;
4191 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4198 /*************************************************
4199 * Initialize authenticators *
4200 *************************************************/
4202 /* Read the authenticators section of the configuration file.
4211 auth_instance *au, *bu;
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 (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 (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,
4241 /*************************************************
4242 * Read ACL information *
4243 *************************************************/
4245 /* If this run of Exim is not doing something that involves receiving a
4246 message, we can just skip over the ACL information. No need to parse it.
4248 First, we have a function for acl_read() to call back to get the next line. We
4249 need to remember the line we passed, because at the end it will contain the
4250 name of the next ACL. */
4252 static uschar *acl_line;
4257 acl_line = get_config_line();
4262 /* Now the main function:
4273 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4276 acl_line = get_config_line();
4284 p = readconf_readname(name, sizeof(name), acl_line);
4285 if (isupper(*name) && *p == '=')
4287 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4288 acl_line = get_config_line();
4292 if (*p != ':' || name[0] == 0)
4293 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4295 node = store_get(sizeof(tree_node) + Ustrlen(name));
4296 Ustrcpy(node->name, name);
4297 if (!tree_insertnode(&acl_anchor, node))
4298 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4299 "there are two ACLs called \"%s\"", name);
4301 node->data.ptr = acl_read(acl_callback, &error);
4303 if (node->data.ptr == NULL && error != NULL)
4304 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4310 /*************************************************
4311 * Read configuration for local_scan() *
4312 *************************************************/
4314 /* This function is called after "begin local_scan" is encountered in the
4315 configuration file. If the local_scan() function allows for configuration
4316 options, we can process them. Otherwise, we expire in a panic.
4323 local_scan_init(void)
4325 #ifndef LOCAL_SCAN_HAS_OPTIONS
4326 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4327 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4331 while ((p = get_config_line()))
4333 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4334 NULL, US"local_scan option \"%s\" unknown");
4341 /*************************************************
4342 * Read rest of configuration (after main) *
4343 *************************************************/
4345 /* This function reads the rest of the runtime configuration, after the main
4346 configuration. It is called only when actually needed. Each subsequent section
4347 of the configuration starts with a line of the form
4351 where the name is "routers", "transports", etc. A section is terminated by
4352 hitting the next "begin" line, and the next name is left in next_section.
4353 Because it may confuse people as to whether the names are singular or plural,
4354 we add "s" if it's missing. There is always enough room in next_section for
4355 this. This function is basically just a switch.
4361 static uschar *section_list[] = {
4375 while(next_section[0] != 0)
4379 int last = nelem(section_list);
4381 int n = Ustrlen(next_section);
4383 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4387 int c = strcmpic(next_section, section_list[mid]);
4389 if (c > 0) first = mid + 1; else last = mid;
4391 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4392 "\"%.*s\" is not a known configuration section name", n, next_section);
4393 mid = (last + first)/2;
4397 if (((had ^= bit) & bit) == 0)
4398 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4399 "\"%.*s\" section is repeated in the configuration file", n,
4404 case 0: readconf_acl(); break;
4405 case 1: auths_init(); break;
4406 case 2: local_scan_init(); break;
4407 case 3: readconf_retries(); break;
4408 case 4: readconf_rewrites(); break;
4409 case 5: route_init(); break;
4410 case 6: transport_init(); break;
4414 (void)fclose(config_file);
4417 /* Init the storage for the pre-parsed config lines */
4419 readconf_save_config(const uschar *s)
4421 save_config_line(string_sprintf("# Exim Configuration (%s)",
4422 f.running_in_test_harness ? US"X" : s));
4426 save_config_position(const uschar *file, int line)
4428 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4431 /* Append a pre-parsed logical line to the config lines store,
4432 this operates on a global (static) list that holds all the pre-parsed
4433 config lines, we do no further processing here, output formatting and
4434 honouring of <hide> or macros will be done during output */
4437 save_config_line(const uschar* line)
4439 static config_line_item *current;
4440 config_line_item *next;
4442 next = (config_line_item*) store_get(sizeof(config_line_item));
4443 next->line = string_copy(line);
4446 if (!config_lines) config_lines = next;
4447 else current->next = next;
4452 /* List the parsed config lines, care about nice formatting and
4453 hide the <hide> values unless we're the admin user */
4455 print_config(BOOL admin, BOOL terse)
4457 config_line_item *i;
4458 const int TS = terse ? 0 : 2;
4461 for (i = config_lines; i; i = i->next)
4466 /* skip over to the first non-space */
4467 for (current = i->line; *current && isspace(*current); ++current)
4470 if (*current == '\0')
4473 /* Collapse runs of spaces. We stop this if we encounter one of the
4474 * following characters: "'$, as this may indicate careful formatting */
4475 for (p = current; *p; ++p)
4478 if (!isspace(*p)) continue;
4479 if (*p != ' ') *p = ' ';
4481 for (next = p; isspace(*next); ++next)
4485 memmove(p+1, next, Ustrlen(next)+1);
4487 if (*next == '"' || *next == '\'' || *next == '$')
4492 if (current[0] == '#')
4495 /* begin lines are left aligned */
4496 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4498 if (!terse) puts("");
4503 /* router/acl/transport block names */
4504 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4506 if (!terse) puts("");
4507 printf("%*s%s\n", TS, "", current);
4511 /* hidden lines (all MACROS or lines prefixed with "hide") */
4513 && ( isupper(*current)
4514 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4518 if ((p = Ustrchr(current, '=')))
4521 printf("%*s%s= %s\n", indent, "", current, hidden);
4523 /* e.g.: hide split_spool_directory */
4525 printf("%*s\n", indent, hidden);
4529 /* rest is public */
4530 printf("%*s%s\n", indent, "", current);
4534 #endif /*!MACRO_PREDEF*/
4537 /* End of readconf.c */