1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 #define READCONF_DEBUG if (FALSE) /* Change to TRUE to enable */
21 static uschar * syslog_facility_str;
22 static void fn_smtp_receive_timeout(const uschar *, const uschar *, unsigned);
24 /*************************************************
25 * Main configuration options *
26 *************************************************/
28 /* The list of options that can be set in the main configuration file. This
29 must be in alphabetic order because it is searched by binary chop. */
31 static optionlist optionlist_config[] = {
32 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
33 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
34 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
35 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
36 { "accept_8bitmime", opt_bool, &accept_8bitmime },
37 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
38 #ifdef WITH_CONTENT_SCAN
39 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
41 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
42 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
43 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
44 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
46 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
49 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
51 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
52 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
53 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
54 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
55 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
56 #ifdef WITH_CONTENT_SCAN
57 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
59 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
60 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
61 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
62 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
64 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
66 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
67 { "add_environment", opt_stringptr, &add_environment },
68 { "admin_groups", opt_gidlist, &admin_groups },
69 { "allow_domain_literals", opt_bool, &allow_domain_literals },
70 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
71 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
72 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
73 { "auto_thaw", opt_time, &auto_thaw },
74 #ifdef WITH_CONTENT_SCAN
75 { "av_scanner", opt_stringptr, &av_scanner },
77 { "bi_command", opt_stringptr, &bi_command },
78 #ifdef EXPERIMENTAL_BRIGHTMAIL
79 { "bmi_config_file", opt_stringptr, &bmi_config_file },
81 { "bounce_message_file", opt_stringptr, &bounce_message_file },
82 { "bounce_message_text", opt_stringptr, &bounce_message_text },
83 { "bounce_return_body", opt_bool, &bounce_return_body },
84 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
85 { "bounce_return_message", opt_bool, &bounce_return_message },
86 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
87 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
88 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
89 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
90 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
91 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
92 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
93 { "check_log_inodes", opt_int, &check_log_inodes },
94 { "check_log_space", opt_Kint, &check_log_space },
95 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
96 { "check_spool_inodes", opt_int, &check_spool_inodes },
97 { "check_spool_space", opt_Kint, &check_spool_space },
98 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
99 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
100 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
101 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
102 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
103 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
104 #ifdef EXPERIMENTAL_DCC
105 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
106 { "dccifd_address", opt_stringptr, &dccifd_address },
107 { "dccifd_options", opt_stringptr, &dccifd_options },
109 { "debug_store", opt_bool, &debug_store },
110 { "delay_warning", opt_timelist, &delay_warning },
111 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
112 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
113 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
114 { "delivery_date_remove", opt_bool, &delivery_date_remove },
115 #ifdef ENABLE_DISABLE_FSYNC
116 { "disable_fsync", opt_bool, &disable_fsync },
118 { "disable_ipv6", opt_bool, &disable_ipv6 },
120 { "dkim_verify_hashes", opt_stringptr, &dkim_verify_hashes },
121 { "dkim_verify_keytypes", opt_stringptr, &dkim_verify_keytypes },
122 { "dkim_verify_minimal", opt_bool, &dkim_verify_minimal },
123 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
126 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
127 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
128 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
130 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
131 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
132 { "dns_cname_loops", opt_int, &dns_cname_loops },
133 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
134 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
135 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
136 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
137 { "dns_retrans", opt_time, &dns_retrans },
138 { "dns_retry", opt_int, &dns_retry },
139 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
140 { "dns_use_edns0", opt_int, &dns_use_edns0 },
141 /* This option is now a no-op, retained for compatibility */
142 { "drop_cr", opt_bool, &drop_cr },
143 /*********************************************************/
144 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
145 { "dsn_from", opt_stringptr, &dsn_from },
146 { "envelope_to_remove", opt_bool, &envelope_to_remove },
147 { "errors_copy", opt_stringptr, &errors_copy },
148 { "errors_reply_to", opt_stringptr, &errors_reply_to },
149 #ifndef DISABLE_EVENT
150 { "event_action", opt_stringptr, &event_action },
152 { "exim_group", opt_gid, &exim_gid },
153 { "exim_path", opt_stringptr, &exim_path },
154 { "exim_user", opt_uid, &exim_uid },
155 { "exim_version", opt_stringptr, &version_string },
156 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
157 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
158 { "finduser_retries", opt_int, &finduser_retries },
159 { "freeze_tell", opt_stringptr, &freeze_tell },
160 { "gecos_name", opt_stringptr, &gecos_name },
161 { "gecos_pattern", opt_stringptr, &gecos_pattern },
163 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
164 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
166 { "header_line_maxsize", opt_int, &header_line_maxsize },
167 { "header_maxsize", opt_int, &header_maxsize },
168 { "headers_charset", opt_stringptr, &headers_charset },
169 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
170 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
171 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
172 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
173 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
174 { "hold_domains", opt_stringptr, &hold_domains },
175 { "host_lookup", opt_stringptr, &host_lookup },
176 { "host_lookup_order", opt_stringptr, &host_lookup_order },
177 { "host_reject_connection", opt_stringptr, &host_reject_connection },
178 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
180 { "hosts_proxy", opt_stringptr, &hosts_proxy },
182 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
184 { "ibase_servers", opt_stringptr, &ibase_servers },
186 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
187 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
188 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
189 { "keep_environment", opt_stringptr, &keep_environment },
190 { "keep_malformed", opt_time, &keep_malformed },
192 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
193 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
194 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
195 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
196 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
197 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
198 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
199 { "ldap_start_tls", opt_bool, &eldap_start_tls },
200 { "ldap_version", opt_int, &eldap_version },
202 { "local_from_check", opt_bool, &local_from_check },
203 { "local_from_prefix", opt_stringptr, &local_from_prefix },
204 { "local_from_suffix", opt_stringptr, &local_from_suffix },
205 { "local_interfaces", opt_stringptr, &local_interfaces },
206 #ifdef HAVE_LOCAL_SCAN
207 { "local_scan_timeout", opt_time, &local_scan_timeout },
209 { "local_sender_retain", opt_bool, &local_sender_retain },
210 { "localhost_number", opt_stringptr, &host_number_string },
211 { "log_file_path", opt_stringptr, &log_file_path },
212 { "log_selector", opt_stringptr, &log_selector_string },
213 { "log_timezone", opt_bool, &log_timezone },
214 { "lookup_open_max", opt_int, &lookup_open_max },
215 { "max_username_length", opt_int, &max_username_length },
216 { "message_body_newlines", opt_bool, &message_body_newlines },
217 { "message_body_visible", opt_mkint, &message_body_visible },
218 { "message_id_header_domain", opt_stringptr, &message_id_domain },
219 { "message_id_header_text", opt_stringptr, &message_id_text },
220 { "message_logs", opt_bool, &message_logs },
221 { "message_size_limit", opt_stringptr, &message_size_limit },
222 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
223 { "move_frozen_messages", opt_bool, &move_frozen_messages },
225 { "mua_wrapper", opt_bool, &mua_wrapper },
227 { "mysql_servers", opt_stringptr, &mysql_servers },
229 { "never_users", opt_uidlist, &never_users },
231 { "openssl_options", opt_stringptr, &openssl_options },
234 { "oracle_servers", opt_stringptr, &oracle_servers },
236 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
238 { "perl_at_start", opt_bool, &opt_perl_at_start },
239 { "perl_startup", opt_stringptr, &opt_perl_startup },
240 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
243 { "pgsql_servers", opt_stringptr, &pgsql_servers },
245 { "pid_file_path", opt_stringptr, &pid_file_path },
246 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
247 #ifndef DISABLE_PIPE_CONNECT
248 { "pipelining_connect_advertise_hosts", opt_stringptr,
249 &pipe_connect_advertise_hosts },
252 { "prdr_enable", opt_bool, &prdr_enable },
254 { "preserve_message_logs", opt_bool, &preserve_message_logs },
255 { "primary_hostname", opt_stringptr, &primary_hostname },
256 { "print_topbitchars", opt_bool, &print_topbitchars },
257 { "process_log_path", opt_stringptr, &process_log_path },
258 { "prod_requires_admin", opt_bool, &prod_requires_admin },
259 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
260 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
261 { "queue_domains", opt_stringptr, &queue_domains },
262 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
263 { "queue_only", opt_bool, &queue_only },
264 { "queue_only_file", opt_stringptr, &queue_only_file },
265 { "queue_only_load", opt_fixed, &queue_only_load },
266 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
267 { "queue_only_override", opt_bool, &queue_only_override },
268 { "queue_run_in_order", opt_bool, &queue_run_in_order },
269 { "queue_run_max", opt_stringptr, &queue_run_max },
270 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
271 { "receive_timeout", opt_time, &receive_timeout },
272 { "received_header_text", opt_stringptr, &received_header_text },
273 { "received_headers_max", opt_int, &received_headers_max },
274 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
275 { "recipients_max", opt_int, &recipients_max },
276 { "recipients_max_reject", opt_bool, &recipients_max_reject },
278 { "redis_servers", opt_stringptr, &redis_servers },
280 { "remote_max_parallel", opt_int, &remote_max_parallel },
281 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
282 { "retry_data_expire", opt_time, &retry_data_expire },
283 { "retry_interval_max", opt_time, &retry_interval_max },
284 { "return_path_remove", opt_bool, &return_path_remove },
285 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
286 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
287 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
288 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
289 { "slow_lookup_log", opt_int, &slow_lookup_log },
290 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
291 { "smtp_accept_max", opt_int, &smtp_accept_max },
292 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
293 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
294 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
295 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
296 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
297 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
298 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
299 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
300 { "smtp_banner", opt_stringptr, &smtp_banner },
301 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
302 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
303 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
304 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
305 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
306 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
307 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
308 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
309 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
310 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
311 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
312 { "smtp_receive_timeout", opt_func, (void *) &fn_smtp_receive_timeout },
313 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
314 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
316 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
318 #ifdef WITH_CONTENT_SCAN
319 { "spamd_address", opt_stringptr, &spamd_address },
322 { "spf_guess", opt_stringptr, &spf_guess },
324 { "split_spool_directory", opt_bool, &split_spool_directory },
325 { "spool_directory", opt_stringptr, &spool_directory },
326 { "spool_wireformat", opt_bool, &spool_wireformat },
328 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
330 #ifdef EXPERIMENTAL_SRS
331 { "srs_config", opt_stringptr, &srs_config },
332 { "srs_hashlength", opt_int, &srs_hashlength },
333 { "srs_hashmin", opt_int, &srs_hashmin },
334 { "srs_maxage", opt_int, &srs_maxage },
335 { "srs_secrets", opt_stringptr, &srs_secrets },
336 { "srs_usehash", opt_bool, &srs_usehash },
337 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
339 { "strict_acl_vars", opt_bool, &strict_acl_vars },
340 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
341 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
342 { "syslog_duplication", opt_bool, &syslog_duplication },
343 { "syslog_facility", opt_stringptr, &syslog_facility_str },
344 { "syslog_pid", opt_bool, &syslog_pid },
345 { "syslog_processname", opt_stringptr, &syslog_processname },
346 { "syslog_timestamp", opt_bool, &syslog_timestamp },
347 { "system_filter", opt_stringptr, &system_filter },
348 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
349 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
350 { "system_filter_group", opt_gid, &system_filter_gid },
351 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
352 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
353 { "system_filter_user", opt_uid, &system_filter_uid },
354 { "tcp_nodelay", opt_bool, &tcp_nodelay },
355 #ifdef USE_TCP_WRAPPERS
356 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
358 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
359 { "timezone", opt_stringptr, &timezone_string },
360 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
362 { "tls_certificate", opt_stringptr, &tls_certificate },
363 { "tls_crl", opt_stringptr, &tls_crl },
364 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
365 { "tls_dhparam", opt_stringptr, &tls_dhparam },
366 { "tls_eccurve", opt_stringptr, &tls_eccurve },
367 # ifndef DISABLE_OCSP
368 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
370 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
371 { "tls_privatekey", opt_stringptr, &tls_privatekey },
372 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
373 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
374 # ifdef EXPERIMENTAL_TLS_RESUME
375 { "tls_resumption_hosts", opt_stringptr, &tls_resumption_hosts },
377 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
378 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
379 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
381 { "trusted_groups", opt_gidlist, &trusted_groups },
382 { "trusted_users", opt_uidlist, &trusted_users },
383 { "unknown_login", opt_stringptr, &unknown_login },
384 { "unknown_username", opt_stringptr, &unknown_username },
385 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
386 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
387 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
388 { "warn_message_file", opt_stringptr, &warn_message_file },
389 { "write_rejectlog", opt_bool, &write_rejectlog }
393 static int optionlist_config_size = nelem(optionlist_config);
400 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags) {/*Dummy*/}
405 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
413 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
415 for (struct auth_info * ai = auths_available; ai->driver_name[0]; ai++)
417 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
418 builtin_macro_create(buf);
419 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
421 if (ai->macros_create) (ai->macros_create)();
426 options_logging(void)
430 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
432 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
433 builtin_macro_create(buf);
438 #else /*!MACRO_PREDEF*/
440 extern char **environ;
442 static void save_config_line(const uschar* line);
443 static void save_config_position(const uschar *file, int line);
444 static void print_config(BOOL admin, BOOL terse);
447 #define CSTATE_STACK_SIZE 10
449 const uschar *config_directory = NULL;
452 /* Structure for chain (stack) of .included files */
454 typedef struct config_file_item {
455 struct config_file_item *next;
456 const uschar *filename;
457 const uschar *directory;
462 /* Structure for chain of configuration lines (-bP config) */
464 typedef struct config_line_item {
465 struct config_line_item *next;
469 static config_line_item* config_lines;
471 /* Structure of table of conditional words and their state transitions */
473 typedef struct cond_item {
481 /* Structure of table of syslog facility names and values */
483 typedef struct syslog_fac_item {
489 static const uschar * const hidden = US"<value not displayable>";
491 /* Static variables */
493 static config_file_item *config_file_stack = NULL; /* For includes */
495 static uschar *syslog_facility_str = NULL;
496 static uschar next_section[24];
497 static uschar time_buffer[24];
499 /* State variables for conditional loading (.ifdef / .else / .endif) */
501 static int cstate = 0;
502 static int cstate_stack_ptr = -1;
503 static int cstate_stack[CSTATE_STACK_SIZE];
505 /* Table of state transitions for handling conditional inclusions. There are
506 four possible state transitions:
510 .elifdef true (or .else)
513 .endif just causes the previous cstate to be popped off the stack */
515 static int next_cstate[3][4] =
517 /* State 0: reading from file, or reading until next .else or .endif */
519 /* State 1: condition failed, skipping until next .else or .endif */
521 /* State 2: skipping until .endif */
525 /* Table of conditionals and the states to set. For each name, there are four
526 values: the length of the name (to save computing it each time), the state to
527 set if a macro was found in the line, the state to set if a macro was not found
528 in the line, and a stack manipulation setting which is:
530 -1 pull state value off the stack
531 0 don't alter the stack
532 +1 push value onto stack, before setting new state
535 static cond_item cond_list[] = {
536 { US"ifdef", 5, 0, 1, 1 },
537 { US"ifndef", 6, 1, 0, 1 },
538 { US"elifdef", 7, 2, 3, 0 },
539 { US"elifndef", 8, 3, 2, 0 },
540 { US"else", 4, 2, 2, 0 },
541 { US"endif", 5, 0, 0, -1 }
544 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
546 /* Table of syslog facility names and their values */
548 static syslog_fac_item syslog_list[] = {
549 { US"mail", LOG_MAIL },
550 { US"user", LOG_USER },
551 { US"news", LOG_NEWS },
552 { US"uucp", LOG_UUCP },
553 { US"local0", LOG_LOCAL0 },
554 { US"local1", LOG_LOCAL1 },
555 { US"local2", LOG_LOCAL2 },
556 { US"local3", LOG_LOCAL3 },
557 { US"local4", LOG_LOCAL4 },
558 { US"local5", LOG_LOCAL5 },
559 { US"local6", LOG_LOCAL6 },
560 { US"local7", LOG_LOCAL7 },
561 { US"daemon", LOG_DAEMON }
564 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
567 #define opt_fn_print BIT(0)
568 #define opt_fn_print_label BIT(1)
571 /*************************************************
572 * Find the name of an option *
573 *************************************************/
575 /* This function is to aid debugging. Various functions take arguments that are
576 pointer variables in the options table or in option tables for various drivers.
577 For debugging output, it is useful to be able to find the name of the option
578 which is currently being processed. This function finds it, if it exists, by
579 searching the table(s).
581 Arguments: a value that is presumed to be in the table above
582 Returns: the option name, or an empty string
586 readconf_find_option(void *p)
588 for (int i = 0; i < nelem(optionlist_config); i++)
589 if (p == optionlist_config[i].v.value) return US optionlist_config[i].name;
591 for (router_instance * r = routers; r; r = r->next)
593 router_info *ri = r->info;
594 for (int i = 0; i < *ri->options_count; i++)
596 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
597 if (p == CS (r->options_block) + (long int)(ri->options[i].v.value))
598 return US ri->options[i].name;
602 for (transport_instance * t = transports; t; t = t->next)
604 transport_info *ti = t->info;
605 for (int i = 0; i < *ti->options_count; i++)
607 optionlist * op = &ti->options[i];
608 if ((op->type & opt_mask) != opt_stringptr) continue;
609 if (p == ( op->type & opt_public
611 : CS t->options_block
613 + (long int)op->v.value)
624 /*************************************************
625 * Deal with an assignment to a macro *
626 *************************************************/
628 /* We have a new definition; append to the list.
631 name Name of the macro; will be copied
632 val Expansion result for the macro; will be copied
636 macro_create(const uschar * name, const uschar * val, BOOL command_line)
638 macro_item * m = store_get(sizeof(macro_item), FALSE);
640 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
642 m->command_line = command_line;
643 m->namelen = Ustrlen(name);
644 m->replen = Ustrlen(val);
645 m->name = string_copy(name);
646 m->replacement = string_copy(val);
658 /* This function is called when a line that starts with an upper case letter is
659 encountered. The argument "line" should contain a complete logical line, and
660 start with the first letter of the macro name. The macro name and the
661 replacement text are extracted and stored. Redefinition of existing,
662 non-command line, macros is permitted using '==' instead of '='.
665 s points to the start of the logical line
667 Returns: FALSE iff fatal error
671 macro_read_assignment(uschar *s)
678 while (isalnum(*s) || *s == '_')
680 if (namelen >= sizeof(name) - 1)
682 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
683 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
686 name[namelen++] = *s++;
690 while (isspace(*s)) s++;
693 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
702 while (isspace(*s)) s++;
704 /* If an existing macro of the same name was defined on the command line, we
705 just skip this definition. It's an error to attempt to redefine a macro without
706 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
707 It is also an error to define a macro whose name begins with the name of a
708 previously defined macro. This is the requirement that make using a tree
709 for macros hard; we must check all macros for the substring. Perhaps a
710 sorted list, and a bsearch, would work?
711 Note: it is documented that the other way round works. */
713 for (m = macros; m; m = m->next)
715 if (Ustrcmp(m->name, name) == 0)
717 if (!m->command_line && !redef)
719 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
720 "defined (use \"==\" if you want to redefine it)", name);
726 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
728 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
729 "a macro because previously defined macro \"%s\" is a substring",
734 /* We cannot have this test, because it is documented that a substring
735 macro is permitted (there is even an example).
737 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
738 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
739 * "a macro because it is a substring of previously defined macro \"%s\"",
744 /* Check for an overriding command-line definition. */
746 if (m && m->command_line) return TRUE;
748 /* Redefinition must refer to an existing macro. */
753 m->replen = Ustrlen(s);
754 m->replacement = string_copy(s);
758 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
763 /* We have a new definition. */
765 (void) macro_create(name, s, FALSE);
773 /* Process line for macros. The line is in big_buffer starting at offset len.
774 Expand big_buffer if needed. Handle definitions of new macros, and
775 macro expansions, rewriting the line in the buffer.
778 len Offset in buffer of start of line
779 newlen Pointer to offset of end of line, updated on return
780 macro_found Pointer to return that a macro was expanded
782 Return: pointer to first nonblank char in line
786 macros_expand(int len, int * newlen, BOOL * macro_found)
788 uschar * ss = big_buffer + len;
791 /* Find the true start of the physical line - leading spaces are always
794 while (isspace(*ss)) ss++;
796 /* Process the physical line for macros. If this is the start of the logical
797 line, skip over initial text at the start of the line if it starts with an
798 upper case character followed by a sequence of name characters and an equals
799 sign, because that is the definition of a new macro, and we don't do
800 replacement therein. */
803 if (len == 0 && isupper(*s))
805 while (isalnum(*s) || *s == '_') s++;
806 while (isspace(*s)) s++;
807 if (*s != '=') s = ss; /* Not a macro definition */
810 /* Skip leading chars which cannot start a macro name, to avoid multiple
811 pointless rescans in Ustrstr calls. */
813 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
815 /* For each defined macro, scan the line (from after XXX= if present),
816 replacing all occurrences of the macro. */
818 *macro_found = FALSE;
819 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
824 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
828 while ((p = Ustrstr(t, m->name)) != NULL)
832 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
833 m->name, (int) Ustrlen(ss)-1, ss);
834 /* Expand the buffer if necessary */
836 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
838 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
839 uschar *newbuffer = store_malloc(newsize);
840 memcpy(newbuffer, big_buffer, *newlen + 1);
841 p = newbuffer + (p - big_buffer);
842 s = newbuffer + (s - big_buffer);
843 ss = newbuffer + (ss - big_buffer);
844 t = newbuffer + (t - big_buffer);
845 big_buffer_size = newsize;
846 store_free(big_buffer);
847 big_buffer = newbuffer;
850 /* Shuffle the remaining characters up or down in the buffer before
851 copying in the replacement text. Don't rescan the replacement for this
855 if ((moveby = m->replen - m->namelen) != 0)
857 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
860 Ustrncpy(p, m->replacement, m->replen);
862 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
867 /* An empty macro replacement at the start of a line could mean that ss no
868 longer points to the first non-blank character. */
870 while (isspace(*ss)) ss++;
874 /*************************************************
875 * Read configuration line *
876 *************************************************/
878 /* A logical line of text is read from the configuration file into the big
879 buffer, taking account of macros, .includes, and continuations. The size of
880 big_buffer is increased if necessary. The count of configuration lines is
881 maintained. Physical input lines starting with # (ignoring leading white space,
882 and after macro replacement) and empty logical lines are always ignored.
883 Leading and trailing spaces are removed.
885 If we hit a line of the form "begin xxxx", the xxxx is placed in the
886 next_section vector, and the function returns NULL, indicating the end of a
887 configuration section. On end-of-file, NULL is returned with next_section
892 Returns: a pointer to the first non-blank in the line,
893 or NULL if eof or end of section is reached
897 get_config_line(void)
899 int startoffset = 0; /* To first non-blank char in logical line */
900 int len = 0; /* Of logical line so far */
905 /* Loop for handling continuation lines, skipping comments, and dealing with
910 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
912 if (config_file_stack != NULL) /* EOF inside .include */
914 (void)fclose(config_file);
915 config_file = config_file_stack->file;
916 config_filename = config_file_stack->filename;
917 config_directory = config_file_stack->directory;
918 config_lineno = config_file_stack->lineno;
919 config_file_stack = config_file_stack->next;
921 save_config_position(config_filename, config_lineno);
925 /* EOF at top level */
927 if (cstate_stack_ptr >= 0)
928 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
929 "Unexpected end of configuration file: .endif missing");
931 if (len != 0) break; /* EOF after continuation */
932 next_section[0] = 0; /* EOF at start of logical line */
937 newlen = len + Ustrlen(big_buffer + len);
939 if (config_lines && config_lineno == 1)
940 save_config_position(config_filename, config_lineno);
942 /* Handle pathologically long physical lines - yes, it did happen - by
943 extending big_buffer at this point. The code also copes with very long
946 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
949 big_buffer_size += BIG_BUFFER_SIZE;
950 newbuffer = store_malloc(big_buffer_size);
952 /* This use of strcpy is OK because we know that the string in the old
953 buffer is shorter than the new buffer. */
955 Ustrcpy(newbuffer, big_buffer);
956 store_free(big_buffer);
957 big_buffer = newbuffer;
958 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
960 newlen += Ustrlen(big_buffer + newlen);
963 ss = macros_expand(len, &newlen, ¯o_found);
965 /* Check for comment lines - these are physical lines. */
967 if (*ss == '#') continue;
969 /* Handle conditionals, which are also applied to physical lines. Conditions
970 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
971 expansion occurred on the rest of the line. A preliminary test for the leading
972 '.' saves effort on most lines. */
978 /* Search the list of conditional directives */
980 for (i = 0; i < cond_list_size; i++)
983 cond_item *c = cond_list+i;
984 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
986 /* The following character must be white space or end of string */
988 n = ss[1 + c->namelen];
989 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
991 /* .ifdef and .ifndef push the current state onto the stack, then set
992 a new one from the table. Stack overflow is an error */
996 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
997 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
998 ".%s nested too deeply", c->name);
999 cstate_stack[++cstate_stack_ptr] = cstate;
1000 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1003 /* For any of the others, stack underflow is an error. The next state
1004 comes either from the stack (.endif) or from the table. */
1008 if (cstate_stack_ptr < 0)
1009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1010 ".%s without matching .ifdef", c->name);
1011 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1012 next_cstate[cstate][macro_found? c->action1 : c->action2];
1015 /* Having dealt with a directive, break the loop */
1020 /* If we have handled a conditional directive, continue with the next
1021 physical line. Otherwise, fall through. */
1023 if (i < cond_list_size) continue;
1026 /* If the conditional state is not 0 (actively using these lines), ignore
1029 if (cstate != 0) continue; /* Conditional skip */
1031 /* Handle .include lines - these are also physical lines. */
1033 if (Ustrncmp(ss, ".include", 8) == 0 &&
1035 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1038 int include_if_exists = isspace(ss[8])? 0 : 10;
1039 config_file_item *save;
1040 struct stat statbuf;
1042 ss += 9 + include_if_exists;
1043 while (isspace(*ss)) ss++;
1044 t = ss + Ustrlen(ss);
1045 while (t > ss && isspace(t[-1])) t--;
1046 if (*ss == '\"' && t[-1] == '\"')
1053 /* We allow relative file names. For security reasons currently
1054 relative names not allowed with .include_if_exists. For .include_if_exists
1055 we need to check the permissions/ownership of the containing folder */
1057 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1058 "absolute path \"%s\"", ss);
1061 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1062 ss = string_from_gstring(g);
1065 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1068 save_config_position(config_filename, config_lineno);
1069 save = store_get(sizeof(config_file_item), FALSE);
1070 save->next = config_file_stack;
1071 config_file_stack = save;
1072 save->file = config_file;
1073 save->filename = config_filename;
1074 save->directory = config_directory;
1075 save->lineno = config_lineno;
1077 if (!(config_file = Ufopen(ss, "rb")))
1078 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1079 "configuration file %s", ss);
1081 config_filename = string_copy(ss);
1082 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1087 /* If this is the start of the logical line, remember where the non-blank
1088 data starts. Otherwise shuffle down continuation lines to remove leading
1092 startoffset = ss - big_buffer;
1095 s = big_buffer + len;
1098 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1103 /* Accept the new addition to the line. Remove trailing white space. */
1106 while (len > 0 && isspace(big_buffer[len-1])) len--;
1107 big_buffer[len] = 0;
1109 /* We are done if the line does not end in backslash and contains some data.
1110 Empty logical lines are ignored. For continuations, remove the backslash and
1111 go round the loop to read the continuation line. */
1115 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1116 big_buffer[--len] = 0; /* Remove backslash */
1118 } /* Loop for reading multiple physical lines */
1120 /* We now have a logical line. Test for the end of a configuration section (or,
1121 more accurately, for the start of the next section). Place the name of the next
1122 section in next_section, and return NULL. If the name given is longer than
1123 next_section, truncate it. It will be unrecognized later, because all the known
1124 section names do fit. Leave space for pluralizing. */
1126 s = big_buffer + startoffset; /* First non-space character */
1129 save_config_line(s);
1131 if (strncmpic(s, US"begin ", 6) == 0)
1134 while (isspace(*s)) s++;
1135 if (big_buffer + len - s > sizeof(next_section) - 2)
1136 s[sizeof(next_section) - 2] = 0;
1137 Ustrcpy(next_section, s);
1141 /* Return the first non-blank character. */
1148 /*************************************************
1150 *************************************************/
1152 /* The yield is the pointer to the next uschar. Names longer than the
1153 output space are silently truncated. This function is also used from acl.c when
1157 name where to put the name
1161 Returns: new input pointer
1165 readconf_readname(uschar *name, int len, uschar *s)
1168 while (isspace(*s)) s++;
1171 while (isalnum(*s) || *s == '_')
1173 if (p < len-1) name[p++] = *s;
1178 while (isspace(*s)) s++;
1185 /*************************************************
1186 * Read a time value *
1187 *************************************************/
1189 /* This function is also called from outside, to read argument
1190 time values. The format of a time value is:
1192 [<n>w][<n>d][<n>h][<n>m][<n>s]
1194 as long as at least one is present. If a format error is encountered,
1195 return a negative value. The value must be terminated by the given
1200 terminator required terminating character
1201 return_msec if TRUE, allow fractional seconds and return milliseconds
1203 Returns: the time value, or -1 on syntax error
1204 value is seconds if return_msec is FALSE
1205 value is milliseconds if return_msec is TRUE
1209 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1217 if (!isdigit(*s)) return -1;
1218 (void)sscanf(CCS s, "%d%n", &value, &count);
1223 case 'w': value *= 7;
1224 case 'd': value *= 24;
1225 case 'h': value *= 60;
1226 case 'm': value *= 60;
1231 if (!return_msec) return -1;
1232 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1234 if (*s++ != 's') return -1;
1235 yield += (int)(fraction * 1000.0);
1241 if (return_msec) value *= 1000;
1243 if (*s == terminator) return yield;
1245 /* Control never reaches here. */
1250 /*************************************************
1251 * Read a fixed point value *
1252 *************************************************/
1254 /* The value is returned *1000
1258 terminator required terminator
1260 Returns: the value, or -1 on error
1264 readconf_readfixed(const uschar *s, int terminator)
1268 if (!isdigit(*s)) return -1;
1269 (void)sscanf(CS s, "%d%n", &value, &count);
1271 yield = value * 1000;
1275 while (isdigit((*(++s))))
1277 yield += (*s - '0') * m;
1282 return (*s == terminator)? yield : (-1);
1287 /*************************************************
1288 * Find option in list *
1289 *************************************************/
1291 /* The lists are always in order, so binary chop can be used.
1294 name the option name to search for
1295 ol the first entry in the option list
1296 last one more than the offset of the last entry in the option list
1298 Returns: pointer to an option entry, or NULL if not found
1302 find_option(uschar *name, optionlist *ol, int last)
1305 while (last > first)
1307 int middle = (first + last)/2;
1308 int c = Ustrcmp(name, ol[middle].name);
1310 if (c == 0) return ol + middle;
1311 else if (c > 0) first = middle + 1;
1319 /*************************************************
1320 * Find a set flag in option list *
1321 *************************************************/
1323 /* Because some versions of Unix make no restrictions on the values of uids and
1324 gids (even negative ones), we cannot represent "unset" by a special value.
1325 There is therefore a separate boolean variable for each one indicating whether
1326 a value is set or not. This function returns a pointer to the boolean, given
1327 the original option name. It is a major disaster if the flag cannot be found.
1330 name the name of the uid or gid option
1331 oltop points to the start of the relevant option list
1332 last one more than the offset of the last item in the option list
1333 data_block NULL when reading main options => data values in the option
1334 list are absolute addresses; otherwise they are byte offsets
1335 in data_block (used for driver options)
1337 Returns: a pointer to the boolean flag.
1341 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1345 sprintf(CS name2, "*set_%.50s", name);
1346 if (!(ol = find_option(name2, oltop, last)))
1347 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1348 "Exim internal error: missing set flag for %s", name);
1350 ? (BOOL *)(US data_block + (long int)ol->v.value) : (BOOL *)ol->v.value;
1356 /*************************************************
1357 * Output extra characters message and die *
1358 *************************************************/
1360 /* Called when an option line has junk on the end. Sometimes this is because
1361 the sysadmin thinks comments are permitted.
1364 s points to the extra characters
1365 t1..t3 strings to insert in the log message
1367 Returns: doesn't return; dies
1371 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1373 uschar *comment = US"";
1374 if (*s == '#') comment = US" (# is comment only at line start)";
1375 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1376 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1381 /*************************************************
1382 * Read rewrite information *
1383 *************************************************/
1385 /* Each line of rewrite information contains:
1387 . A complete address in the form user@domain, possibly with
1388 leading * for each part; or alternatively, a regex.
1390 . A replacement string (which will be expanded).
1392 . An optional sequence of one-letter flags, indicating which
1393 headers etc. to apply this rule to.
1395 All this is decoded and placed into a control block. The OR of the flags is
1396 maintained in a common word.
1399 p points to the string that makes up the rule
1400 existflags points to the overall flag word
1401 isglobal TRUE if reading global rewrite rules
1403 Returns: the control block for the parsed rule.
1406 static rewrite_rule *
1407 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1409 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1412 next->key = string_dequote(&p);
1414 while (isspace(*p)) p++;
1416 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1417 "missing rewrite replacement string");
1420 next->replacement = string_dequote(&p);
1422 while (*p != 0) switch (*p++)
1424 case ' ': case '\t': break;
1426 case 'q': next->flags |= rewrite_quit; break;
1427 case 'w': next->flags |= rewrite_whole; break;
1429 case 'h': next->flags |= rewrite_all_headers; break;
1430 case 's': next->flags |= rewrite_sender; break;
1431 case 'f': next->flags |= rewrite_from; break;
1432 case 't': next->flags |= rewrite_to; break;
1433 case 'c': next->flags |= rewrite_cc; break;
1434 case 'b': next->flags |= rewrite_bcc; break;
1435 case 'r': next->flags |= rewrite_replyto; break;
1437 case 'E': next->flags |= rewrite_all_envelope; break;
1438 case 'F': next->flags |= rewrite_envfrom; break;
1439 case 'T': next->flags |= rewrite_envto; break;
1441 case 'Q': next->flags |= rewrite_qualify; break;
1442 case 'R': next->flags |= rewrite_repeat; break;
1445 next->flags |= rewrite_smtp;
1446 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1447 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1448 "rewrite rule has the S flag but is not a regular expression");
1452 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1453 "unknown rewrite flag character '%c' "
1454 "(could be missing quotes round replacement item)", p[-1]);
1458 /* If no action flags are set, set all the "normal" rewrites. */
1460 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1461 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1463 /* Remember which exist, for optimization, and return the rule */
1465 *existflags |= next->flags;
1472 /*************************************************
1473 * Read global rewrite information *
1474 *************************************************/
1476 /* Each line is a single rewrite rule; it is parsed into a control block
1477 by readconf_one_rewrite(), and its flags are ORed into the global flag
1478 word rewrite_existflags. */
1481 readconf_rewrites(void)
1483 rewrite_rule **chain = &global_rewrite_rules;
1486 while ((p = get_config_line()) != NULL)
1488 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1490 chain = &(next->next);
1496 /*************************************************
1498 *************************************************/
1500 /* Strings are read into the normal store pool. As long we aren't too
1501 near the end of the current block, the string will just use what is necessary
1502 on the top of the stacking pool, because string_cat() uses the extension
1506 s the rest of the input line
1507 name the option name (for errors)
1509 Returns: pointer to the string
1513 read_string(const uschar *s, const uschar *name)
1518 if (*s != '\"') return string_copy(s);
1521 yield = string_dequote(&s);
1523 if (s == ss+1 || s[-1] != '\"')
1524 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1525 "missing quote at end of string value for %s", name);
1527 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1533 /*************************************************
1534 * Custom-handler options *
1535 *************************************************/
1537 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1539 if (flags & opt_fn_print)
1541 if (flags & opt_fn_print_label) printf("%s = ", name);
1542 printf("%s\n", smtp_receive_timeout_s
1543 ? string_printing2(smtp_receive_timeout_s, FALSE)
1544 : readconf_printtime(smtp_receive_timeout));
1546 else if (*str == '$')
1547 smtp_receive_timeout_s = string_copy(str);
1550 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1551 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1552 if (smtp_receive_timeout < 0)
1553 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1558 /*************************************************
1559 * Handle option line *
1560 *************************************************/
1562 /* This function is called from several places to process a line containing the
1563 setting of an option. The first argument is the line to be decoded; it has been
1564 checked not to be empty and not to start with '#'. Trailing newlines and white
1565 space have been removed. The second argument is a pointer to the list of
1566 variable names that are to be recognized, together with their types and
1567 locations, and the third argument gives the number of entries in the list.
1569 The fourth argument is a pointer to a data block. If it is NULL, then the data
1570 values in the options list are absolute addresses. Otherwise, they are byte
1571 offsets in the data block.
1573 String option data may continue onto several lines; this function reads further
1574 data from config_file if necessary.
1576 The yield of this function is normally zero. If a string continues onto
1577 multiple lines, then the data value is permitted to be followed by a comma
1578 or a semicolon (for use in drivers) and the yield is that character.
1581 buffer contains the configuration line to be handled
1582 oltop points to the start of the relevant option list
1583 last one more than the offset of the last item in the option list
1584 data_block NULL when reading main options => data values in the option
1585 list are absolute addresses; otherwise they are byte offsets
1586 in data_block when they have opt_public set; otherwise
1587 they are byte offsets in data_block->options_block.
1588 unknown_txt format string to use in panic message for unknown option;
1589 must contain %s for option name
1590 if given as NULL, don't panic on unknown option
1592 Returns: TRUE if an option was read successfully,
1593 FALSE false for an unknown option if unknown_txt == NULL,
1594 otherwise panic and die on an unknown option
1598 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1599 void *data_block, uschar *unknown_txt)
1603 int count, type, value;
1607 BOOL boolvalue = TRUE;
1608 BOOL freesptr = TRUE;
1609 optionlist *ol, *ol2;
1613 uschar *inttype = US"";
1616 uschar **str_target;
1620 /* There may be leading spaces; thereafter, we expect an option name starting
1623 while (isspace(*s)) s++;
1625 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1627 /* Read the name of the option, and skip any subsequent white space. If
1628 it turns out that what we read was "hide", set the flag indicating that
1629 this is a secure option, and loop to read the next word. */
1631 for (int n = 0; n < 2; n++)
1633 while (isalnum(*s) || *s == '_')
1635 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1639 while (isspace(*s)) s++;
1640 if (Ustrcmp(name, "hide") != 0) break;
1641 issecure = opt_secure;
1645 /* Deal with "no_" or "not_" here for booleans */
1647 if (Ustrncmp(name, "no_", 3) == 0)
1653 if (Ustrncmp(name, "not_", 4) == 0)
1659 /* Search the list for the given name. A non-existent name, or an option that
1660 is set twice, is a disaster. */
1662 if (!(ol = find_option(name + offset, oltop, last)))
1664 if (!unknown_txt) return FALSE;
1665 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1668 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1670 "\"%s\" option set for the second time", name);
1672 ol->type |= opt_set | issecure;
1673 type = ol->type & opt_mask;
1675 /* Types with data values must be followed by '='; the "no[t]_" prefix
1676 applies only to boolean values. */
1678 if (type < opt_bool || type > opt_bool_last)
1681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1682 "negation prefix applied to a non-boolean option");
1684 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1685 "unexpected end of line (data missing) after %s", name);
1687 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1690 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1691 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1692 ultimately expands to one of those values. */
1694 else if (*s && (offset != 0 || *s != '='))
1695 extra_chars_error(s, US"boolean option ", name, US"");
1697 /* Skip white space after = */
1699 if (*s == '=') while (isspace((*(++s))));
1701 /* If there is a data block and the opt_public flag is not set, change
1702 the data block pointer to the private options block. */
1704 if (data_block && !(ol->type & opt_public))
1705 data_block = (void *)(((driver_instance *)data_block)->options_block);
1707 /* Now get the data according to the type. */
1711 /* If a string value is not enclosed in quotes, it consists of
1712 the rest of the current line, verbatim. Otherwise, string escapes
1715 A transport is specified as a string, which is then looked up in the
1716 list of transports. A search type is specified as one of a number of
1719 A set or rewrite rules for a driver is specified as a string, which is
1720 then parsed into a suitable chain of control blocks.
1722 Uids and gids are specified as strings which are then looked up in the
1723 passwd file. Lists of uids and gids are similarly specified as colon-
1724 separated strings. */
1729 case opt_expand_uid:
1730 case opt_expand_gid:
1735 reset_point = store_mark();
1736 sptr = read_string(s, name);
1738 /* Having read a string, we now have several different ways of using it,
1739 depending on the data type, so do another switch. If keeping the actual
1740 string is not required (because it is interpreted), freesptr is set TRUE,
1741 and at the end we reset the pool. */
1745 /* If this was a string, set the variable to point to the new string,
1746 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1747 rules, we still keep the string (for printing), and parse the rules into a
1748 control block and flags word. */
1751 str_target = data_block ? USS (US data_block + (long int)ol->v.value)
1753 if (ol->type & opt_rep_con)
1755 uschar * saved_condition;
1756 /* We already have a condition, we're conducting a crude hack to let
1757 multiple condition rules be chained together, despite storing them in
1759 *str_target = string_copy_perm( (saved_condition = *str_target)
1760 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1761 saved_condition, sptr)
1764 /* TODO(pdp): there is a memory leak here and just below
1765 when we set 3 or more conditions; I still don't
1766 understand the store mechanism enough to know
1767 what's the safe way to free content from an earlier store.
1768 AFAICT, stores stack, so freeing an early stored item also stores
1769 all data alloc'd after it. If we knew conditions were adjacent,
1770 we could survive that, but we don't. So I *think* we need to take
1771 another bit from opt_type to indicate "malloced"; this seems like
1772 quite a hack, especially for this one case. It also means that
1773 we can't ever reclaim the store from the *first* condition.
1775 Because we only do this once, near process start-up, I'm prepared to
1776 let this slide for the time being, even though it rankles. */
1778 else if (ol->type & opt_rep_str)
1781 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1782 : Ustrncmp(name, "set", 3) == 0 ? ';'
1784 int sep_i = -(int)sep_o;
1785 const uschar * list = sptr;
1787 gstring * list_o = NULL;
1791 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1792 list_o = string_cat(list_o, *str_target);
1795 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1796 list_o = string_append_listele(list_o, sep_o, s);
1799 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1810 *USS (US data_block + (long int)ol->v.value) = sptr;
1812 *USS ol->v.value = sptr;
1814 if (type == opt_rewrite)
1819 rewrite_rule **chain;
1822 sprintf(CS name2, "*%.50s_rules", name);
1823 ol2 = find_option(name2, oltop, last);
1824 sprintf(CS name2, "*%.50s_flags", name);
1825 ol3 = find_option(name2, oltop, last);
1828 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1829 "rewrite rules not available for driver");
1833 chain = (rewrite_rule **)(US data_block + (long int)ol2->v.value);
1834 flagptr = (int *)(US data_block + (long int)ol3->v.value);
1838 chain = (rewrite_rule **)ol2->v.value;
1839 flagptr = (int *)ol3->v.value;
1842 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1844 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1846 chain = &(next->next);
1849 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1850 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1851 "non-header rewrite - not allowed at transport time -");
1855 /* If it was an expanded uid, see if there is any expansion to be
1856 done by checking for the presence of a $ character. If there is, save it
1857 in the corresponding *expand_user option field. Otherwise, fall through
1858 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1861 case opt_expand_uid:
1862 sprintf(CS name2, "*expand_%.50s", name);
1863 if ((ol2 = find_option(name2, oltop, last)))
1865 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1868 *(USS(US data_block + (long int)ol2->v.value)) = ss;
1870 *(USS ol2->v.value) = ss;
1874 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1880 /* Look up a fixed uid, and also make use of the corresponding gid
1881 if a passwd entry is returned and the gid has not been set. */
1884 if (!route_finduser(sptr, &pw, &uid))
1885 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1887 *(uid_t *)(US data_block + (long int)(ol->v.value)) = uid;
1889 *(uid_t *)ol->v.value = uid;
1891 /* Set the flag indicating a fixed value is set */
1893 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1895 /* Handle matching gid if we have a passwd entry: done by finding the
1896 same name with terminating "user" changed to "group"; if not found,
1897 ignore. Also ignore if the value is already set. */
1899 if (pw == NULL) break;
1900 Ustrcpy(name+Ustrlen(name)-4, US"group");
1901 ol2 = find_option(name, oltop, last);
1902 if (ol2 && ((ol2->type & opt_mask) == opt_gid ||
1903 (ol2->type & opt_mask) == opt_expand_gid))
1905 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1909 *((gid_t *)(US data_block + (long int)ol2->v.value)) = pw->pw_gid;
1911 *((gid_t *)ol2->v.value) = pw->pw_gid;
1917 /* If it was an expanded gid, see if there is any expansion to be
1918 done by checking for the presence of a $ character. If there is, save it
1919 in the corresponding *expand_user option field. Otherwise, fall through
1920 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1923 case opt_expand_gid:
1924 sprintf(CS name2, "*expand_%.50s", name);
1925 if ((ol2 = find_option(name2, oltop, last)))
1927 uschar *ss = (Ustrchr(sptr, '$') != NULL) ? sptr : NULL;
1930 *(USS(US data_block + (long int)ol2->v.value)) = ss;
1932 *(USS ol2->v.value) = ss;
1936 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1942 /* Handle freestanding gid */
1945 if (!route_findgroup(sptr, &gid))
1946 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1948 *((gid_t *)(US data_block + (long int)ol->v.value)) = gid;
1950 *((gid_t *)ol->v.value) = gid;
1951 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1954 /* If it was a uid list, look up each individual entry, and build
1955 a vector of uids, with a count in the first element. Put the vector
1956 in malloc store so we can free the string. (We are reading into
1957 permanent store already.) */
1965 const uschar *op = expand_string (sptr);
1968 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1969 name, expand_string_message);
1972 if (*p != 0) count++;
1973 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1974 list = store_malloc(count*sizeof(uid_t));
1975 list[ptr++] = (uid_t)(count - 1);
1978 *((uid_t **)(US data_block + (long int)ol->v.value)) = list;
1980 *((uid_t **)ol->v.value) = list;
1986 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1987 if (!route_finduser(big_buffer, NULL, &uid))
1988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1995 /* If it was a gid list, look up each individual entry, and build
1996 a vector of gids, with a count in the first element. Put the vector
1997 in malloc store so we can free the string. (We are reading into permanent
2006 const uschar *op = expand_string (sptr);
2009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2010 name, expand_string_message);
2013 if (*p != 0) count++;
2014 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2015 list = store_malloc(count*sizeof(gid_t));
2016 list[ptr++] = (gid_t)(count - 1);
2019 *((gid_t **)(US data_block + (long int)ol->v.value)) = list;
2021 *((gid_t **)ol->v.value) = list;
2027 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2028 if (!route_findgroup(big_buffer, &gid))
2029 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2037 /* Release store if the value of the string doesn't need to be kept. */
2039 if (freesptr) reset_point = store_reset(reset_point);
2042 /* Expanded boolean: if no characters follow, or if there are no dollar
2043 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2044 save the string for later expansion in the alternate place. */
2046 case opt_expand_bool:
2047 if (*s && Ustrchr(s, '$') != 0)
2049 sprintf(CS name2, "*expand_%.50s", name);
2050 if ((ol2 = find_option(name2, oltop, last)))
2052 reset_point = store_mark();
2053 sptr = read_string(s, name);
2055 *(USS(US data_block + (long int)ol2->v.value)) = sptr;
2057 *(USS ol2->v.value) = sptr;
2064 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2065 look for yes/not/true/false. Some booleans are stored in a single bit in
2066 a single int. There's a special fudge for verify settings; without a suffix
2067 they set both xx_sender and xx_recipient. The table points to the sender
2068 value; search subsequently for the recipient. There's another special case:
2069 opt_bool_set also notes when a boolean has been set. */
2073 case opt_bool_verify:
2077 s = readconf_readname(name2, 64, s);
2078 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2080 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2082 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2083 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2084 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2085 US"for boolean option ", name);
2088 /* Handle single-bit type. */
2090 if (type == opt_bit)
2092 int bit = 1 << ((ol->type >> 16) & 31);
2093 int * ptr = data_block
2094 ? (int *)(US data_block + (long int)ol->v.value)
2095 : (int *)ol->v.value;
2096 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2100 /* Handle full BOOL types */
2103 *((BOOL *)(US data_block + (long int)ol->v.value)) = boolvalue;
2105 *((BOOL *)ol->v.value) = boolvalue;
2109 if (type == opt_bool_verify)
2111 sprintf(CS name2, "%.50s_recipient", name + offset);
2112 if ((ol2 = find_option(name2, oltop, last)))
2114 *((BOOL *)(US data_block + (long int)ol2->v.value)) = boolvalue;
2116 *((BOOL *)ol2->v.value) = boolvalue;
2119 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2121 else if (type == opt_bool_set)
2123 sprintf(CS name2, "*set_%.50s", name + offset);
2124 if ((ol2 = find_option(name2, oltop, last)))
2126 *((BOOL *)(US data_block + (long int)ol2->v.value)) = TRUE;
2128 *((BOOL *)ol2->v.value) = TRUE;
2136 inttype = US"octal ";
2138 /* Integer: a simple(ish) case; allow octal and hex formats, and
2139 suffixes K, M, G, and T. The different types affect output, not input. */
2148 lvalue = strtol(CS s, CSS &endptr, intbase);
2151 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2154 if (errno != ERANGE && *endptr)
2156 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2158 if ((mp = Ustrchr(mp, *endptr)))
2163 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2174 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2176 "absolute value of integer \"%s\" is too large (overflow)", s);
2178 while (isspace(*endptr)) endptr++;
2180 extra_chars_error(endptr, inttype, US"integer value for ", name);
2182 value = (int)lvalue;
2186 *(int *)(US data_block + (long int)ol->v.value) = value;
2188 *(int *)ol->v.value = value;
2191 /* Integer held in K: again, allow formats and suffixes as above. */
2197 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2200 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2203 if (errno != ERANGE && *endptr)
2205 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2207 if ((mp = Ustrchr(mp, *endptr)))
2212 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2221 lvalue = (lvalue + 512)/1024;
2224 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2225 "absolute value of integer \"%s\" is too large (overflow)", s);
2227 while (isspace(*endptr)) endptr++;
2229 extra_chars_error(endptr, inttype, US"integer value for ", name);
2232 *(int_eximarith_t *)(US data_block + (long int)ol->v.value) = lvalue;
2234 *(int_eximarith_t *)ol->v.value = lvalue;
2238 /* Fixed-point number: held to 3 decimal places. */
2241 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2242 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2243 "fixed-point number expected for %s", name);
2245 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2246 "integer \"%s\" is too large (overflow)", s);
2250 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2251 "integer \"%s\" is too large (overflow)", s);
2253 /* We get a coverity error here for using count, as it derived
2254 from the tainted buffer pointed to by s, as parsed by sscanf().
2255 By the definition of sscanf we must be accessing between start
2256 and end of s (assuming it is nul-terminated...) so ignore the error. */
2257 /* coverity[tainted_data] */
2258 if (s[count] == '.')
2261 while (isdigit(s[++count]))
2263 value += (s[count] - '0') * d;
2268 while (isspace(s[count])) count++;
2271 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2274 *((int *)(US data_block + (long int)ol->v.value)) = value;
2276 *((int *)ol->v.value) = value;
2279 /* There's a special routine to read time values. */
2282 value = readconf_readtime(s, 0, FALSE);
2284 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2287 *((int *)(US data_block + (long int)ol->v.value)) = value;
2289 *((int *)ol->v.value) = value;
2292 /* A time list is a list of colon-separated times, with the first
2293 element holding the size of the list and the second the number of
2299 int * list = data_block
2300 ? (int *)(US data_block + (long int)ol->v.value)
2301 : (int *)ol->v.value;
2303 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2306 uschar *snext = Ustrchr(s, ':');
2310 while (ss > s && isspace(ss[-1])) ss--;
2313 value = readconf_readtime(s, terminator, FALSE);
2315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2317 if (count > 1 && value <= list[count])
2318 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2319 "time value out of order for %s", name);
2320 list[count+1] = value;
2321 if (snext == NULL) break;
2323 while (isspace(*s)) s++;
2326 if (count > list[0] - 2)
2327 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2329 if (count > 0 && list[2] == 0) count = 0;
2336 void (*fn)() = ol->v.fn;
2347 /*************************************************
2348 * Print a time value *
2349 *************************************************/
2352 Argument: a time value in seconds
2353 Returns: pointer to a fixed buffer containing the time as a string,
2354 in readconf_readtime() format
2358 readconf_printtime(int t)
2361 uschar *p = time_buffer;
2378 if (w > 0) p += sprintf(CS p, "%dw", w);
2379 if (d > 0) p += sprintf(CS p, "%dd", d);
2380 if (h > 0) p += sprintf(CS p, "%dh", h);
2381 if (m > 0) p += sprintf(CS p, "%dm", m);
2382 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2389 /*************************************************
2390 * Print an individual option value *
2391 *************************************************/
2393 /* This is used by the -bP option, so prints to the standard output.
2394 The entire options list is passed in as an argument, because some options come
2395 in pairs - typically uid/gid settings, which can either be explicit numerical
2396 values, or strings to be expanded later. If the numerical value is unset,
2397 search for "*expand_<name>" to see if there is a string equivalent.
2400 ol option entry, or NULL for an unknown option
2402 options_block NULL for main configuration options; otherwise points to
2403 a driver block; if the option doesn't have opt_public
2404 set, then options_block->options_block is where the item
2406 oltop points to the option list in which ol exists
2407 last one more than the offset of the last entry in optop
2408 no_labels do not show "foo = " at the start.
2410 Returns: boolean success
2414 print_ol(optionlist *ol, uschar *name, void *options_block,
2415 optionlist *oltop, int last, BOOL no_labels)
2428 printf("%s is not a known option\n", name);
2432 /* Non-admin callers cannot see options that have been flagged secure by the
2435 if (!f.admin_user && ol->type & opt_secure)
2438 printf("%s\n", CCS hidden);
2440 printf("%s = %s\n", name, CCS hidden);
2444 /* Else show the value of the option */
2446 value = ol->v.value;
2449 if (!(ol->type & opt_public))
2450 options_block = (void *)(((driver_instance *)options_block)->options_block);
2451 value = (void *)(US options_block + (long int)value);
2454 switch(ol->type & opt_mask)
2457 case opt_rewrite: /* Show the text value */
2459 if (!no_labels) printf("%s = ", name);
2460 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2464 if (!no_labels) printf("%s = ", name);
2465 printf("%d\n", *((int *)value));
2470 int x = *((int *)value);
2471 if (x != 0 && (x & 1023) == 0)
2475 if ((x & 1023) == 0)
2480 if (!no_labels) printf("%s = ", name);
2481 printf("%d%c\n", x, c);
2485 if (!no_labels) printf("%s = ", name);
2493 int_eximarith_t x = *((int_eximarith_t *)value);
2494 if (!no_labels) printf("%s = ", name);
2495 if (x == 0) printf("0\n");
2496 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2497 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2498 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2499 else printf(PR_EXIM_ARITH "K\n", x);
2504 if (!no_labels) printf("%s = ", name);
2505 printf("%#o\n", *((int *)value));
2508 /* Can be negative only when "unset", in which case integer */
2512 int x = *((int *)value);
2515 if (x < 0) printf("%s =\n", name); else
2517 if (!no_labels) printf("%s = ", name);
2518 printf("%d.", x/1000);
2531 /* If the numerical value is unset, try for the string value */
2533 case opt_expand_uid:
2534 if (! *get_set_flag(name, oltop, last, options_block))
2536 sprintf(CS name2, "*expand_%.50s", name);
2537 if ((ol2 = find_option(name2, oltop, last)))
2539 void * value2 = ol2->v.value;
2541 value2 = (void *)(US options_block + (long int)value2);
2543 if (!no_labels) printf("%s = ", name);
2544 printf("%s\n", s ? string_printing(s) : US"");
2549 /* Else fall through */
2552 if (!no_labels) printf("%s = ", name);
2553 if (! *get_set_flag(name, oltop, last, options_block))
2556 if ((pw = getpwuid(*((uid_t *)value))))
2557 printf("%s\n", pw->pw_name);
2559 printf("%ld\n", (long int)(*((uid_t *)value)));
2562 /* If the numerical value is unset, try for the string value */
2564 case opt_expand_gid:
2565 if (! *get_set_flag(name, oltop, last, options_block))
2567 sprintf(CS name2, "*expand_%.50s", name);
2568 if ( (ol2 = find_option(name2, oltop, last))
2569 && (ol2->type & opt_mask) == opt_stringptr)
2571 void * value2 = ol2->v.value;
2573 value2 = (void *)(US options_block + (long int)value2);
2575 if (!no_labels) printf("%s = ", name);
2576 printf("%s\n", s ? string_printing(s) : US"");
2581 /* Else fall through */
2584 if (!no_labels) printf("%s = ", name);
2585 if (! *get_set_flag(name, oltop, last, options_block))
2588 if ((gr = getgrgid(*((int *)value))))
2589 printf("%s\n", gr->gr_name);
2591 printf("%ld\n", (long int)(*((int *)value)));
2595 uidlist = *((uid_t **)value);
2596 if (!no_labels) printf("%s =", name);
2599 uschar sep = no_labels ? '\0' : ' ';
2600 for (int i = 1; i <= (int)(uidlist[0]); i++)
2602 uschar *name = NULL;
2603 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2604 if (sep != '\0') printf("%c", sep);
2605 if (name) printf("%s", name);
2606 else printf("%ld", (long int)(uidlist[i]));
2614 gidlist = *((gid_t **)value);
2615 if (!no_labels) printf("%s =", name);
2618 uschar sep = no_labels ? '\0' : ' ';
2619 for (int i = 1; i <= (int)(gidlist[0]); i++)
2621 uschar *name = NULL;
2622 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2623 if (sep != '\0') printf("%c", sep);
2624 if (name) printf("%s", name);
2625 else printf("%ld", (long int)(gidlist[i]));
2633 if (!no_labels) printf("%s = ", name);
2634 printf("%s\n", readconf_printtime(*((int *)value)));
2639 int *list = (int *)value;
2640 if (!no_labels) printf("%s = ", name);
2641 for (int i = 0; i < list[1]; i++)
2642 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2648 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2652 case opt_expand_bool:
2653 sprintf(CS name2, "*expand_%.50s", name);
2654 if ((ol2 = find_option(name2, oltop, last)) && ol2->v.value)
2656 void * value2 = ol2->v.value;
2658 value2 = (void *)(US options_block + (long int)value2);
2659 if ((s = *(USS value2)))
2661 if (!no_labels) printf("%s = ", name);
2662 printf("%s\n", string_printing(s));
2665 /* s == NULL => string not set; fall through */
2671 case opt_bool_verify:
2673 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2678 void (*fn)() = ol->v.fn;
2679 fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2688 /*************************************************
2689 * Print value from main configuration *
2690 *************************************************/
2692 /* This function, called as a result of encountering the -bP option,
2693 causes the value of any main configuration variable to be output if the
2694 second argument is NULL. There are some special values:
2696 all print all main configuration options
2697 config_file print the name of the configuration file
2698 (configure_file will still work, for backward
2700 routers print the routers' configurations
2701 transports print the transports' configuration
2702 authenticators print the authenticators' configuration
2703 macros print the macros' configuration
2704 router_list print a list of router names
2705 transport_list print a list of transport names
2706 authenticator_list print a list of authentication mechanism names
2707 macro_list print a list of macro names
2708 +name print a named list item
2709 local_scan print the local_scan options
2710 config print the configuration as it is parsed
2711 environment print the used execution environment
2713 If the second argument is not NULL, it must be one of "router", "transport",
2714 "authenticator" or "macro" in which case the first argument identifies the
2715 driver whose options are to be printed.
2718 name option name if type == NULL; else driver name
2719 type NULL or driver type name, as described above
2720 no_labels avoid the "foo = " at the start of an item
2722 Returns: Boolean success
2726 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2728 BOOL names_only = FALSE;
2729 optionlist *ol2 = NULL;
2730 driver_instance *d = NULL;
2739 static uschar *types[] = { US"address", US"domain", US"host",
2741 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2742 &hostlist_anchor, &localpartlist_anchor };
2744 for (int i = 0; i < 4; i++)
2745 if ((t = tree_search(*(anchors[i]), name+1)))
2747 namedlist_block * nb = t->data.ptr;
2748 const uschar * s = nb->hide ? hidden : nb->string;
2751 printf("%s\n", CCS s);
2753 printf("%slist %s = %s\n", types[i], name+1, CCS s);
2757 printf("no address, domain, host, or local part list called \"%s\" "
2758 "exists\n", name+1);
2763 if ( Ustrcmp(name, "configure_file") == 0
2764 || Ustrcmp(name, "config_file") == 0)
2766 printf("%s\n", CS config_main_filename);
2770 if (Ustrcmp(name, "all") == 0)
2772 for (optionlist * ol = optionlist_config;
2773 ol < optionlist_config + nelem(optionlist_config); ol++)
2774 if (!(ol->type & opt_hidden))
2775 (void) print_ol(ol, US ol->name, NULL,
2776 optionlist_config, nelem(optionlist_config),
2781 if (Ustrcmp(name, "local_scan") == 0)
2783 #ifndef LOCAL_SCAN_HAS_OPTIONS
2784 printf("local_scan() options are not supported\n");
2787 for (optionlist * ol = local_scan_options;
2788 ol < local_scan_options + local_scan_options_count; ol++)
2789 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2790 local_scan_options_count, no_labels);
2795 if (Ustrcmp(name, "config") == 0)
2797 print_config(f.admin_user, no_labels);
2801 if (Ustrcmp(name, "routers") == 0)
2806 else if (Ustrcmp(name, "transports") == 0)
2808 type = US"transport";
2811 else if (Ustrcmp(name, "authenticators") == 0)
2813 type = US"authenticator";
2816 else if (Ustrcmp(name, "macros") == 0)
2821 else if (Ustrcmp(name, "router_list") == 0)
2827 else if (Ustrcmp(name, "transport_list") == 0)
2829 type = US"transport";
2833 else if (Ustrcmp(name, "authenticator_list") == 0)
2835 type = US"authenticator";
2839 else if (Ustrcmp(name, "macro_list") == 0)
2845 else if (Ustrcmp(name, "environment") == 0)
2850 for (p = USS environ; *p; p++) ;
2851 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2853 for (p = USS environ; *p; p++)
2856 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2864 return print_ol(find_option(name,
2865 optionlist_config, nelem(optionlist_config)),
2866 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2869 /* Handle the options for a router or transport. Skip options that are flagged
2870 as hidden. Some of these are options with names starting with '*', used for
2871 internal alternative representations of other options (which the printing
2872 function will sort out). Others are synonyms kept for backward compatibility.
2875 if (Ustrcmp(type, "router") == 0)
2877 d = (driver_instance *)routers;
2878 ol2 = optionlist_routers;
2879 size = optionlist_routers_size;
2881 else if (Ustrcmp(type, "transport") == 0)
2883 d = (driver_instance *)transports;
2884 ol2 = optionlist_transports;
2885 size = optionlist_transports_size;
2887 else if (Ustrcmp(type, "authenticator") == 0)
2889 d = (driver_instance *)auths;
2890 ol2 = optionlist_auths;
2891 size = optionlist_auths_size;
2894 else if (Ustrcmp(type, "macro") == 0)
2896 /* People store passwords in macros and they were previously not available
2897 for printing. So we have an admin_users restriction. */
2900 fprintf(stderr, "exim: permission denied\n");
2903 for (macro_item * m = macros; m; m = m->next)
2904 if (!name || Ustrcmp(name, m->name) == 0)
2907 printf("%s\n", CS m->name);
2909 printf("%s\n", CS m->replacement);
2911 printf("%s=%s\n", CS m->name, CS m->replacement);
2915 if (!name) return TRUE;
2917 printf("%s %s not found\n", type, name);
2923 for (; d; d = d->next) printf("%s\n", CS d->name);
2927 /* Either search for a given driver, or print all of them */
2929 for (; d; d = d->next)
2933 printf("\n%s %s:\n", d->name, type);
2934 else if (Ustrcmp(d->name, name) != 0) continue;
2936 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2937 if (!(ol->type & opt_hidden))
2938 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2940 for (optionlist * ol = d->info->options;
2941 ol < d->info->options + *(d->info->options_count); ol++)
2942 if (!(ol->type & opt_hidden))
2943 rc |= print_ol(ol, US ol->name, d, d->info->options,
2944 *d->info->options_count, no_labels);
2946 if (name) return rc;
2948 if (!name) return TRUE;
2950 printf("%s %s not found\n", type, name);
2956 /*************************************************
2957 * Read a named list item *
2958 *************************************************/
2960 /* This function reads a name and a list (i.e. string). The name is used to
2961 save the list in a tree, sorted by its name. Each entry also has a number,
2962 which can be used for caching tests, but if the string contains any expansion
2963 items other than $key, the number is set negative to inhibit caching. This
2964 mechanism is used for domain, host, and address lists that are referenced by
2968 anchorp points to the tree anchor
2969 numberp points to the current number for this tree
2970 max the maximum number permitted
2971 s the text of the option line, starting immediately after the name
2973 tname the name of the list type, for messages
2974 hide do not output value on "-bP"
2980 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2981 uschar *tname, BOOL hide)
2983 BOOL forcecache = FALSE;
2986 namedlist_block * nb = store_get(sizeof(namedlist_block), FALSE);
2988 if (Ustrncmp(s, "_cache", 6) == 0)
2995 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2997 if (*numberp >= max)
2998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3001 while (isspace(*s)) s++;
3003 while (isalnum(*s) || *s == '_') s++;
3004 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3005 Ustrncpy(t->name, ss, s-ss);
3007 while (isspace(*s)) s++;
3009 if (!tree_insertnode(anchorp, t))
3010 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3011 "duplicate name \"%s\" for a named %s", t->name, tname);
3014 nb->number = *numberp;
3018 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3019 "missing '=' after \"%s\"", t->name);
3020 while (isspace(*s)) s++;
3021 nb->string = read_string(s, t->name);
3022 nb->cache_data = NULL;
3024 /* Check the string for any expansions; if any are found, mark this list
3025 uncacheable unless the user has explicited forced caching. */
3027 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3033 /*************************************************
3034 * Unpick data for a rate limit *
3035 *************************************************/
3037 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3041 s string, in the form t,b,f,l
3042 where t is the threshold (integer)
3043 b is the initial delay (time)
3044 f is the multiplicative factor (fixed point)
3045 k is the maximum time (time)
3046 threshold where to store threshold
3047 base where to store base in milliseconds
3048 factor where to store factor in milliseconds
3049 limit where to store limit
3051 Returns: nothing (panics on error)
3055 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3058 uschar bstring[16], lstring[16];
3060 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3061 factor, lstring) == 4)
3063 *base = readconf_readtime(bstring, 0, TRUE);
3064 *limit = readconf_readtime(lstring, 0, TRUE);
3065 if (*base >= 0 && *limit >= 0) return;
3067 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3073 /*************************************************
3074 * Read main configuration options *
3075 *************************************************/
3077 /* This function is the first to be called for configuration reading. It
3078 opens the configuration file and reads general configuration settings until
3079 it reaches the end of the configuration section. The file is then left open so
3080 that the remaining configuration data can subsequently be read if needed for
3083 The configuration file must be owned either by root or exim, and be writeable
3084 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3085 in the config file, so the test is done on the compiled in values. A slight
3086 anomaly, to be carefully documented.
3088 The name of the configuration file is taken from a list that is included in the
3089 binary of Exim. It can be altered from the command line, but if that is done,
3090 root privilege is immediately withdrawn unless the caller is root or exim.
3091 The first file on the list that exists is used.
3093 For use on multiple systems that share file systems, first look for a
3094 configuration file whose name has the current node name on the end. If that is
3095 not found, try the generic name. For really contorted configurations, that run
3096 multiple Exims with different uid settings, first try adding the effective uid
3097 before the node name. These complications are going to waste resources on most
3098 systems. Therefore they are available only when requested by compile-time
3102 readconf_main(BOOL nowarn)
3105 struct stat statbuf;
3106 uschar *s, *filename;
3107 const uschar *list = config_main_filelist;
3109 /* Loop through the possible file names */
3111 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3114 /* Cut out all the fancy processing unless specifically wanted */
3116 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3117 uschar *suffix = filename + Ustrlen(filename);
3119 /* Try for the node-specific file if a node name exists */
3121 #ifdef CONFIGURE_FILE_USE_NODE
3123 if (uname(&uts) >= 0)
3125 #ifdef CONFIGURE_FILE_USE_EUID
3126 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3127 config_file = Ufopen(filename, "rb");
3128 if (config_file == NULL)
3129 #endif /* CONFIGURE_FILE_USE_EUID */
3131 sprintf(CS suffix, ".%.256s", uts.nodename);
3132 config_file = Ufopen(filename, "rb");
3135 #endif /* CONFIGURE_FILE_USE_NODE */
3137 /* Otherwise, try the generic name, possibly with the euid added */
3139 #ifdef CONFIGURE_FILE_USE_EUID
3140 if (config_file == NULL)
3142 sprintf(CS suffix, ".%ld", (long int)original_euid);
3143 config_file = Ufopen(filename, "rb");
3145 #endif /* CONFIGURE_FILE_USE_EUID */
3147 /* Finally, try the unadorned name */
3149 if (config_file == NULL)
3152 config_file = Ufopen(filename, "rb");
3154 #else /* if neither defined */
3156 /* This is the common case when the fancy processing is not included. */
3158 config_file = Ufopen(filename, "rb");
3161 /* If the file does not exist, continue to try any others. For any other
3162 error, break out (and die). */
3164 if (config_file != NULL || errno != ENOENT) break;
3167 /* On success, save the name for verification; config_filename is used when
3168 logging configuration errors (it changes for .included files) whereas
3169 config_main_filename is the name shown by -bP. Failure to open a configuration
3170 file is a serious disaster. */
3174 uschar *last_slash = Ustrrchr(filename, '/');
3175 config_filename = config_main_filename = string_copy(filename);
3177 /* The config_main_directory we need for the $config_dir expansion.
3178 config_main_filename we need for $config_file expansion.
3179 And config_dir is the directory of the current configuration, used for
3180 relative .includes. We do need to know it's name, as we change our working
3183 if (filename[0] == '/')
3184 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3187 /* relative configuration file name: working dir + / + basename(filename) */
3189 uschar buf[PATH_MAX];
3192 if (os_getcwd(buf, PATH_MAX) == NULL)
3194 perror("exim: getcwd");
3197 g = string_cat(NULL, buf);
3199 /* If the dir does not end with a "/", append one */
3200 if (g->s[g->ptr-1] != '/')
3201 g = string_catn(g, US"/", 1);
3203 /* If the config file contains a "/", extract the directory part */
3205 g = string_catn(g, filename, last_slash - filename);
3207 config_main_directory = string_from_gstring(g);
3209 config_directory = config_main_directory;
3213 if (filename == NULL)
3214 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3215 "%s", config_main_filelist);
3217 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3218 "configuration file %s", filename));
3221 /* Now, once we found and opened our configuration file, we change the directory
3222 to a safe place. Later we change to $spool_directory. */
3224 if (Uchdir("/") < 0)
3226 perror("exim: chdir `/': ");
3230 /* Check the status of the file we have opened, if we have retained root
3231 privileges and the file isn't /dev/null (which *should* be 0666). */
3233 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3235 if (fstat(fileno(config_file), &statbuf) != 0)
3236 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3239 if ((statbuf.st_uid != root_uid /* owner not root */
3240 #ifdef CONFIGURE_OWNER
3241 && statbuf.st_uid != config_uid /* owner not the special one */
3244 (statbuf.st_gid != root_gid /* group not root & */
3245 #ifdef CONFIGURE_GROUP
3246 && statbuf.st_gid != config_gid /* group not the special one */
3248 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3250 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3252 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3253 "wrong owner, group, or mode", big_buffer);
3255 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3256 This assumes we will need this much storage to handle all the allocations
3257 during startup; it won't help when .include is being used. When it does, it
3258 will cut down on the number of store blocks (and malloc calls, and sbrk
3259 syscalls). It also assume we're on the relevant pool. */
3261 if (statbuf.st_size > 8192)
3263 rmark r = store_mark();
3264 void * dummy = store_get((int)statbuf.st_size, FALSE);
3269 /* Process the main configuration settings. They all begin with a lower case
3270 letter. If we see something starting with an upper case letter, it is taken as
3271 a macro definition. */
3273 while ((s = get_config_line()))
3278 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3279 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3280 "found unexpected BOM (Byte Order Mark)");
3284 if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US"");
3288 t = (hide = Ustrncmp(s, "hide", 4) == 0 && isspace(s[4])) ? s + 5 : s;
3290 if (Ustrncmp(t, "domainlist", 10) == 0)
3291 read_named_list(&domainlist_anchor, &domainlist_count,
3292 MAX_NAMED_LIST, t+10, US"domain list", hide);
3294 else if (Ustrncmp(t, "hostlist", 8) == 0)
3295 read_named_list(&hostlist_anchor, &hostlist_count,
3296 MAX_NAMED_LIST, t+8, US"host list", hide);
3298 else if (Ustrncmp(t, US"addresslist", 11) == 0)
3299 read_named_list(&addresslist_anchor, &addresslist_count,
3300 MAX_NAMED_LIST, t+11, US"address list", hide);
3302 else if (Ustrncmp(t, US"localpartlist", 13) == 0)
3303 read_named_list(&localpartlist_anchor, &localpartlist_count,
3304 MAX_NAMED_LIST, t+13, US"local part list", hide);
3307 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3308 NULL, US"main option \"%s\" unknown");
3312 /* If local_sender_retain is set, local_from_check must be unset. */
3314 if (local_sender_retain && local_from_check)
3315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3316 "local_sender_retain are set; this combination is not allowed");
3318 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3321 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3323 /* The max retry interval must not be greater than 24 hours. */
3325 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3327 /* remote_max_parallel must be > 0 */
3329 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3331 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3332 start of a new SMTP message. */
3334 freeze_tell_config = freeze_tell;
3336 /* The primary host name may be required for expansion of spool_directory
3337 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3338 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3339 canonize it. Some people like upper case letters in their host names, so we
3340 don't force the case. */
3342 if (primary_hostname == NULL)
3344 const uschar *hostname;
3346 if (uname(&uts) < 0)
3347 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3348 hostname = US uts.nodename;
3350 if (Ustrchr(hostname, '.') == NULL)
3353 struct hostent *hostdata;
3356 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3357 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3358 MCL_DOMAIN, TRUE, NULL) != OK))
3367 #if HAVE_GETIPNODEBYNAME
3369 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3371 hostdata = gethostbyname2(CS hostname, af);
3374 hostdata = gethostbyname(CS hostname);
3377 if (hostdata != NULL)
3379 hostname = US hostdata->h_name;
3383 if (af == AF_INET) break;
3388 primary_hostname = string_copy(hostname);
3391 /* Set up default value for smtp_active_hostname */
3393 smtp_active_hostname = primary_hostname;
3395 /* If spool_directory wasn't set in the build-time configuration, it must have
3396 got set above. Of course, writing to the log may not work if log_file_path is
3397 not set, but it will at least get to syslog or somewhere, with any luck. */
3399 if (!*spool_directory)
3400 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3403 /* Expand the spool directory name; it may, for example, contain the primary
3404 host name. Same comment about failure. */
3406 if (!(s = expand_string(spool_directory)))
3407 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3408 "\"%s\": %s", spool_directory, expand_string_message);
3409 spool_directory = s;
3411 /* Expand log_file_path, which must contain "%s" in any component that isn't
3412 the null string or "syslog". It is also allowed to contain one instance of %D
3413 or %M. However, it must NOT contain % followed by anything else. */
3417 const uschar *ss, *sss;
3418 int sep = ':'; /* Fixed for log file path */
3419 if (!(s = expand_string(log_file_path)))
3420 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3421 "\"%s\": %s", log_file_path, expand_string_message);
3424 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3427 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3428 if (!(t = Ustrstr(sss, "%s")))
3429 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3430 "contain \"%%s\"", sss);
3432 if ((t = Ustrchr(sss, '%')))
3433 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3434 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3435 "unexpected \"%%\" character", s);
3441 /* Interpret syslog_facility into an integer argument for 'ident' param to
3442 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3445 if (syslog_facility_str)
3448 uschar *s = syslog_facility_str;
3450 if ((Ustrlen(syslog_facility_str) >= 4) &&
3451 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3454 for (i = 0; i < syslog_list_size; i++)
3455 if (strcmpic(s, syslog_list[i].name) == 0)
3457 syslog_facility = syslog_list[i].value;
3461 if (i >= syslog_list_size)
3462 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3463 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3466 /* Expand pid_file_path */
3468 if (*pid_file_path != 0)
3470 if (!(s = expand_string(pid_file_path)))
3471 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3472 "\"%s\": %s", pid_file_path, expand_string_message);
3476 /* Set default value of process_log_path */
3478 if (!process_log_path || *process_log_path =='\0')
3479 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3481 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3484 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3486 /* Unpick the SMTP rate limiting options, if set */
3488 if (smtp_ratelimit_mail)
3489 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3490 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3492 if (smtp_ratelimit_rcpt)
3493 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3494 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3496 /* The qualify domains default to the primary host name */
3498 if (!qualify_domain_sender)
3499 qualify_domain_sender = primary_hostname;
3500 if (!qualify_domain_recipient)
3501 qualify_domain_recipient = qualify_domain_sender;
3503 /* Setting system_filter_user in the configuration sets the gid as well if a
3504 name is given, but a numerical value does not. */
3506 if (system_filter_uid_set && !system_filter_gid_set)
3508 struct passwd *pw = getpwuid(system_filter_uid);
3510 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3511 (long int)system_filter_uid);
3512 system_filter_gid = pw->pw_gid;
3513 system_filter_gid_set = TRUE;
3516 /* If the errors_reply_to field is set, check that it is syntactically valid
3517 and ensure it contains a domain. */
3519 if (errors_reply_to)
3522 int start, end, domain;
3523 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3524 &start, &end, &domain, FALSE);
3527 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3528 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3531 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3532 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3535 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3536 smtp_accept_max must also be set. */
3538 if (smtp_accept_max == 0 &&
3539 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3540 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3541 "smtp_accept_max must be set if smtp_accept_queue or "
3542 "smtp_accept_max_per_host is set");
3544 /* Set up the host number if anything is specified. It is an expanded string
3545 so that it can be computed from the host name, for example. We do this last
3546 so as to ensure that everything else is set up before the expansion. */
3548 if (host_number_string)
3552 uschar *s = expand_string(host_number_string);
3555 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3556 "failed to expand localhost_number \"%s\": %s",
3557 host_number_string, expand_string_message);
3558 n = Ustrtol(s, &end, 0);
3559 while (isspace(*end)) end++;
3561 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3562 "localhost_number value is not a number: %s", s);
3563 if (n > LOCALHOST_MAX)
3564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3565 "localhost_number is greater than the maximum allowed value (%d)",
3571 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3573 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3574 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3575 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3576 tls_verify_hosts ? "" : "try_");
3578 /* Magic number: at time of writing, 1024 has been the long-standing value
3579 used by so many clients, and what Exim used to use always, that it makes
3580 sense to just min-clamp this max-clamp at that. */
3581 if (tls_dh_max_bits < 1024)
3582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3583 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3585 /* If openssl_options is set, validate it */
3586 if (openssl_options)
3589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3590 "openssl_options is set but we're using GnuTLS");
3593 if (!tls_openssl_options_parse(openssl_options, &dummy))
3594 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3595 "openssl_options parse error: %s", openssl_options);
3598 #endif /*DISABLE_TLS*/
3600 if (!nowarn && !keep_environment && environ && *environ)
3601 log_write(0, LOG_MAIN,
3602 "Warning: purging the environment.\n"
3603 " Suggested action: use keep_environment.");
3608 /*************************************************
3609 * Initialize one driver *
3610 *************************************************/
3612 /* This is called once the driver's generic options, if any, have been read.
3613 We can now find the driver, set up defaults for the private options, and
3614 unset any "set" bits in the private options table (which might have been
3615 set by another incarnation of the same driver).
3618 d pointer to driver instance block, with generic
3620 drivers_available vector of available drivers
3621 size_of_info size of each block in drivers_available
3622 class class of driver, for error message
3624 Returns: pointer to the driver info block
3627 static driver_info *
3628 init_driver(driver_instance *d, driver_info *drivers_available,
3629 int size_of_info, uschar *class)
3631 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3632 dd = (driver_info *)((US dd) + size_of_info))
3633 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3635 int len = dd->options_len;
3637 d->options_block = store_get(len, FALSE);
3638 memcpy(d->options_block, dd->options_block, len);
3639 for (int i = 0; i < *(dd->options_count); i++)
3640 dd->options[i].type &= ~opt_set;
3644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3645 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3647 return NULL; /* never obeyed */
3653 /*************************************************
3654 * Initialize driver list *
3655 *************************************************/
3657 /* This function is called for routers, transports, and authentication
3658 mechanisms. It reads the data from the current point in the configuration file
3659 up to the end of the section, and sets up a chain of instance blocks according
3660 to the file's contents. The file will already have been opened by a call to
3661 readconf_main, and must be left open for subsequent reading of further data.
3663 Any errors cause a panic crash. Note that the blocks with names driver_info and
3664 driver_instance must map the first portions of all the _info and _instance
3665 blocks for this shared code to work.
3668 class "router", "transport", or "authenticator"
3669 anchor &routers, &transports, &auths
3670 drivers_available available drivers
3671 size_of_info size of each info block
3672 instance_default points to default data for an instance
3673 instance_size size of instance block
3674 driver_optionlist generic option list
3675 driver_optionlist_count count of generic option list
3681 readconf_driver_init(
3683 driver_instance **anchor,
3684 driver_info *drivers_available,
3686 void *instance_default,
3688 optionlist *driver_optionlist,
3689 int driver_optionlist_count)
3691 driver_instance **p = anchor;
3692 driver_instance *d = NULL;
3695 while ((buffer = get_config_line()))
3700 /* Read the first name on the line and test for the start of a new driver. A
3701 macro definition indicates the end of the previous driver. If this isn't the
3702 start of a new driver, the line will be re-read. */
3704 s = readconf_readname(name, sizeof(name), buffer);
3706 /* Handle macro definition, first finishing off the initialization of the
3707 previous driver, if any. */
3709 if (isupper(*name) && *s == '=')
3713 if (!d->driver_name)
3714 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3715 "no driver defined for %s \"%s\"", class, d->name);
3716 /* s is using big_buffer, so this call had better not */
3720 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3724 /* If the line starts with a name terminated by a colon, we are at the
3725 start of the definition of a new driver. The rest of the line must be
3730 /* Finish off initializing the previous driver. */
3734 if (!d->driver_name)
3735 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3736 "no driver defined for %s \"%s\"", class, d->name);
3740 /* Check that we haven't already got a driver of this name */
3742 for (d = *anchor; d; d = d->next)
3743 if (Ustrcmp(name, d->name) == 0)
3744 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3745 "there are two %ss called \"%s\"", class, name);
3747 /* Set up a new driver instance data block on the chain, with
3748 its default values installed. */
3750 d = store_get(instance_size, FALSE);
3751 memcpy(d, instance_default, instance_size);
3754 d->name = string_copy(name);
3756 /* Clear out the "set" bits in the generic options */
3758 for (int i = 0; i < driver_optionlist_count; i++)
3759 driver_optionlist[i].type &= ~opt_set;
3761 /* Check nothing more on this line, then do the next loop iteration. */
3763 while (isspace(*s)) s++;
3764 if (*s) extra_chars_error(s, US"driver name ", name, US"");
3768 /* Not the start of a new driver. Give an error if we have not set up a
3769 current driver yet. */
3772 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3774 /* First look to see if this is a generic option; if it is "driver",
3775 initialize the driver. If is it not a generic option, we can look for a
3776 private option provided that the driver has been previously set up. */
3778 if (readconf_handle_option(buffer, driver_optionlist,
3779 driver_optionlist_count, d, NULL))
3781 if (!d->info && d->driver_name)
3782 init_driver(d, drivers_available, size_of_info, class);
3785 /* Handle private options - pass the generic block because some may
3786 live therein. A flag with each option indicates if it is in the public
3790 readconf_handle_option(buffer, d->info->options,
3791 *(d->info->options_count), d, US"option \"%s\" unknown");
3793 /* The option is not generic and the driver name has not yet been given. */
3795 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3796 "(\"driver\" must be specified before any private options)", name);
3799 /* Run the initialization function for the final driver. */
3803 if (!d->driver_name)
3804 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3805 "no driver defined for %s \"%s\"", class, d->name);
3812 /*************************************************
3813 * Check driver dependency *
3814 *************************************************/
3816 /* This function is passed a driver instance and a string. It checks whether
3817 any of the string options for the driver contains the given string as an
3821 d points to a driver instance block
3822 s the string to search for
3824 Returns: TRUE if a dependency is found
3828 readconf_depends(driver_instance *d, uschar *s)
3830 int count = *(d->info->options_count);
3833 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3834 if ((ol->type & opt_mask) == opt_stringptr)
3836 void * options_block = ol->type & opt_public ? (void *)d : d->options_block;
3837 uschar * value = *USS(US options_block + (long int)ol->v.value);
3839 if (value && (ss = Ustrstr(value, s)) != NULL)
3841 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3842 isalnum(ss[Ustrlen(s)])) continue;
3843 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3844 d->name, ol->name, s);
3849 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3856 /*************************************************
3857 * Decode an error type for retries *
3858 *************************************************/
3860 /* This function is global because it is also called from the main
3861 program when testing retry information. It decodes strings such as "quota_7d"
3862 into numerical error codes.
3865 pp points to start of text
3866 p points past end of text
3867 basic_errno points to an int to receive the main error number
3868 more_errno points to an int to receive the secondary error data
3870 Returns: NULL if decoded correctly; else points to error text
3874 readconf_retry_error(const uschar *pp, const uschar *p,
3875 int *basic_errno, int *more_errno)
3878 const uschar *q = pp;
3879 while (q < p && *q != '_') q++;
3882 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3884 *basic_errno = ERRNO_EXIMQUOTA;
3885 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3886 return US"bad time value";
3889 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3891 *basic_errno = ECONNREFUSED;
3894 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3895 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3896 else return US"A or MX expected after \"refused\"";
3900 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3902 *basic_errno = ETIMEDOUT;
3906 int xlen = p - q - 1;
3907 const uschar *x = q + 1;
3909 static uschar *extras[] =
3910 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3911 static int values[] =
3912 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3914 for (i = 0; i < nelem(extras); i++)
3915 if (strncmpic(x, extras[i], xlen) == 0)
3917 *more_errno = values[i];
3921 if (i >= nelem(extras))
3922 if (strncmpic(x, US"DNS", xlen) == 0)
3923 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3924 "available in retry rules (it has never worked) - treated as "
3927 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3931 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3932 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3933 strncmpic(pp, US"data_4", 6) == 0)
3936 int x = 255; /* means "any 4xx code" */
3937 if (p != pp + 8) bad = TRUE; else
3939 int a = pp[6], b = pp[7];
3943 if (isdigit(b)) x += b - '0';
3944 else if (b == 'x') x += 100;
3947 else if (a != 'x' || b != 'x') bad = TRUE;
3951 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3952 "x is literal and d is any digit", pp);
3954 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3955 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3956 *more_errno = x << 8;
3959 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3960 strncmpic(q+1, US"failed", p-q-1) == 0)
3961 *basic_errno = ERRNO_AUTHFAIL;
3963 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3964 *basic_errno = ERRNO_SMTPCLOSED;
3966 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3967 *basic_errno = ERRNO_TLSREQUIRED;
3969 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3970 *basic_errno = ERRNO_UNKNOWNHOST;
3972 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3973 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3981 /*************************************************
3982 * Read retry information *
3983 *************************************************/
3985 /* Each line of retry information contains:
3987 . A domain name pattern or an address pattern;
3989 . An error name, possibly with additional data, or *;
3991 . An optional sequence of retry items, each consisting of an identifying
3992 letter, a cutoff time, and optional parameters.
3994 All this is decoded and placed into a control block. */
3997 /* Subroutine to read an argument, preceded by a comma and terminated
3998 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3999 1 = fixed point number (returned *1000).
4002 paddr pointer to pointer to current character; updated
4003 type 0 => read a time; 1 => read a fixed point number
4005 Returns: time in seconds or fixed point number * 1000
4009 retry_arg(const uschar **paddr, int type)
4011 const uschar *p = *paddr;
4014 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4016 while (isspace(*p)) p++;
4018 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4020 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4021 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4026 case 0: return readconf_readtime(pp, *p, FALSE);
4027 case 1: return readconf_readfixed(pp, *p);
4029 return 0; /* Keep picky compilers happy */
4032 /* The function proper */
4035 readconf_retries(void)
4037 retry_config **chain = &retries;
4041 while ((p = get_config_line()))
4043 retry_rule **rchain;
4047 next = store_get(sizeof(retry_config), FALSE);
4050 chain = &(next->next);
4051 next->basic_errno = next->more_errno = 0;
4052 next->senders = NULL;
4054 rchain = &(next->rules);
4056 next->pattern = string_dequote(&p);
4057 while (isspace(*p)) p++;
4059 while (mac_isgraph(*p)) p++;
4060 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4061 "missing error type in retry rule");
4063 /* Test error names for things we understand. */
4065 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4066 &next->more_errno)))
4067 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4069 /* There may be an optional address list of senders to be used as another
4070 constraint on the rule. This was added later, so the syntax is a bit of a
4071 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4074 while (isspace(*p)) p++;
4075 if (Ustrncmp(p, "senders", 7) == 0)
4078 while (isspace(*p)) p++;
4079 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4080 "\"=\" expected after \"senders\" in retry rule");
4081 while (isspace(*p)) p++;
4082 next->senders = string_dequote(&p);
4085 /* Now the retry rules. Keep the maximum timeout encountered. */
4087 while (isspace(*p)) p++;
4091 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4093 rchain = &(rule->next);
4095 rule->rule = toupper(*p++);
4096 rule->timeout = retry_arg(&p, 0);
4097 if (rule->timeout > retry_maximum_timeout)
4098 retry_maximum_timeout = rule->timeout;
4102 case 'F': /* Fixed interval */
4103 rule->p1 = retry_arg(&p, 0);
4106 case 'G': /* Geometrically increasing intervals */
4107 case 'H': /* Ditto, but with randomness */
4108 rule->p1 = retry_arg(&p, 0);
4109 rule->p2 = retry_arg(&p, 1);
4113 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4117 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4118 (rule->rule != 'F' && rule->p2 < 1000))
4119 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4120 "bad parameters for retry rule");
4122 while (isspace(*p)) p++;
4126 while (isspace(*p)) p++;
4129 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4136 /*************************************************
4137 * Initialize authenticators *
4138 *************************************************/
4140 /* Read the authenticators section of the configuration file.
4149 #ifndef DISABLE_PIPE_CONNECT
4153 readconf_driver_init(US"authenticator",
4154 (driver_instance **)(&auths), /* chain anchor */
4155 (driver_info *)auths_available, /* available drivers */
4156 sizeof(auth_info), /* size of info block */
4157 &auth_defaults, /* default values for generic options */
4158 sizeof(auth_instance), /* size of instance block */
4159 optionlist_auths, /* generic options */
4160 optionlist_auths_size);
4162 for (auth_instance * au = auths; au; au = au->next)
4164 if (!au->public_name)
4165 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4166 "the %s authenticator", au->name);
4168 for (auth_instance * bu = au->next; bu; bu = bu->next)
4169 if (strcmpic(au->public_name, bu->public_name) == 0)
4170 if ((au->client && bu->client) || (au->server && bu->server))
4171 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4172 "(%s and %s) have the same public name (%s)",
4173 au->client ? US"client" : US"server", au->name, bu->name,
4175 #ifndef DISABLE_PIPE_CONNECT
4179 #ifndef DISABLE_PIPE_CONNECT
4180 f.smtp_in_early_pipe_no_auth = nauths > 16;
4187 /*************************************************
4188 * Read ACL information *
4189 *************************************************/
4191 /* If this run of Exim is not doing something that involves receiving a
4192 message, we can just skip over the ACL information. No need to parse it.
4194 First, we have a function for acl_read() to call back to get the next line. We
4195 need to remember the line we passed, because at the end it will contain the
4196 name of the next ACL. */
4198 static uschar *acl_line;
4203 acl_line = get_config_line();
4208 /* Now the main function:
4219 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4222 acl_line = get_config_line();
4230 p = readconf_readname(name, sizeof(name), acl_line);
4231 if (isupper(*name) && *p == '=')
4233 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4234 acl_line = get_config_line();
4238 if (*p != ':' || name[0] == 0)
4239 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4241 node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4242 Ustrcpy(node->name, name);
4243 if (!tree_insertnode(&acl_anchor, node))
4244 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4245 "there are two ACLs called \"%s\"", name);
4247 node->data.ptr = acl_read(acl_callback, &error);
4249 if (node->data.ptr == NULL && error != NULL)
4250 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4256 /*************************************************
4257 * Read configuration for local_scan() *
4258 *************************************************/
4260 /* This function is called after "begin local_scan" is encountered in the
4261 configuration file. If the local_scan() function allows for configuration
4262 options, we can process them. Otherwise, we expire in a panic.
4269 local_scan_init(void)
4271 #ifndef LOCAL_SCAN_HAS_OPTIONS
4272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4273 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4277 while ((p = get_config_line()))
4278 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4279 NULL, US"local_scan option \"%s\" unknown");
4285 /*************************************************
4286 * Read rest of configuration (after main) *
4287 *************************************************/
4289 /* This function reads the rest of the runtime configuration, after the main
4290 configuration. It is called only when actually needed. Each subsequent section
4291 of the configuration starts with a line of the form
4295 where the name is "routers", "transports", etc. A section is terminated by
4296 hitting the next "begin" line, and the next name is left in next_section.
4297 Because it may confuse people as to whether the names are singular or plural,
4298 we add "s" if it's missing. There is always enough room in next_section for
4299 this. This function is basically just a switch.
4305 static uschar *section_list[] = {
4319 while(next_section[0] != 0)
4323 int last = nelem(section_list);
4325 int n = Ustrlen(next_section);
4327 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4331 int c = strcmpic(next_section, section_list[mid]);
4333 if (c > 0) first = mid + 1; else last = mid;
4335 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4336 "\"%.*s\" is not a known configuration section name", n, next_section);
4337 mid = (last + first)/2;
4341 if (((had ^= bit) & bit) == 0)
4342 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4343 "\"%.*s\" section is repeated in the configuration file", n,
4348 case 0: readconf_acl(); break;
4349 case 1: auths_init(); break;
4350 case 2: local_scan_init(); break;
4351 case 3: readconf_retries(); break;
4352 case 4: readconf_rewrites(); break;
4353 case 5: route_init(); break;
4354 case 6: transport_init(); break;
4358 (void)fclose(config_file);
4361 /* Init the storage for the pre-parsed config lines */
4363 readconf_save_config(const uschar *s)
4365 save_config_line(string_sprintf("# Exim Configuration (%s)",
4366 f.running_in_test_harness ? US"X" : s));
4370 save_config_position(const uschar *file, int line)
4372 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4375 /* Append a pre-parsed logical line to the config lines store,
4376 this operates on a global (static) list that holds all the pre-parsed
4377 config lines, we do no further processing here, output formatting and
4378 honouring of <hide> or macros will be done during output */
4381 save_config_line(const uschar* line)
4383 static config_line_item *current;
4384 config_line_item *next;
4386 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4387 next->line = string_copy(line);
4390 if (!config_lines) config_lines = next;
4391 else current->next = next;
4396 /* List the parsed config lines, care about nice formatting and
4397 hide the <hide> values unless we're the admin user */
4399 print_config(BOOL admin, BOOL terse)
4401 const int TS = terse ? 0 : 2;
4404 for (config_line_item * i = config_lines; i; i = i->next)
4409 /* skip over to the first non-space */
4410 for (current = i->line; *current && isspace(*current); ++current)
4413 if (*current == '\0')
4416 /* Collapse runs of spaces. We stop this if we encounter one of the
4417 * following characters: "'$, as this may indicate careful formatting */
4418 for (p = current; *p; ++p)
4421 if (!isspace(*p)) continue;
4422 if (*p != ' ') *p = ' ';
4424 for (next = p; isspace(*next); ++next)
4428 memmove(p+1, next, Ustrlen(next)+1);
4430 if (*next == '"' || *next == '\'' || *next == '$')
4435 if (current[0] == '#')
4438 /* begin lines are left aligned */
4439 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4441 if (!terse) puts("");
4446 /* router/acl/transport block names */
4447 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4449 if (!terse) puts("");
4450 printf("%*s%s\n", TS, "", current);
4454 /* hidden lines (all MACROS or lines prefixed with "hide") */
4456 && ( isupper(*current)
4457 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4461 if ((p = Ustrchr(current, '=')))
4464 printf("%*s%s= %s\n", indent, "", current, CCS hidden);
4466 /* e.g.: hide split_spool_directory */
4468 printf("%*s\n", indent, CCS hidden);
4472 /* rest is public */
4473 printf("%*s%s\n", indent, "", current);
4477 #endif /*!MACRO_PREDEF*/
4480 /* End of readconf.c */