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 #ifdef SUPPORT_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);
424 options_logging(void)
428 for (bit_table * bp = log_options; bp < log_options + log_options_count; bp++)
430 spf(buf, sizeof(buf), US"_LOG_%T", bp->name);
431 builtin_macro_create(buf);
436 #else /*!MACRO_PREDEF*/
438 extern char **environ;
440 static void save_config_line(const uschar* line);
441 static void save_config_position(const uschar *file, int line);
442 static void print_config(BOOL admin, BOOL terse);
445 #define CSTATE_STACK_SIZE 10
447 const uschar *config_directory = NULL;
450 /* Structure for chain (stack) of .included files */
452 typedef struct config_file_item {
453 struct config_file_item *next;
454 const uschar *filename;
455 const uschar *directory;
460 /* Structure for chain of configuration lines (-bP config) */
462 typedef struct config_line_item {
463 struct config_line_item *next;
467 static config_line_item* config_lines;
469 /* Structure of table of conditional words and their state transitions */
471 typedef struct cond_item {
479 /* Structure of table of syslog facility names and values */
481 typedef struct syslog_fac_item {
487 static const char * const hidden = "<value not displayable>";
489 /* Static variables */
491 static config_file_item *config_file_stack = NULL; /* For includes */
493 static uschar *syslog_facility_str = NULL;
494 static uschar next_section[24];
495 static uschar time_buffer[24];
497 /* State variables for conditional loading (.ifdef / .else / .endif) */
499 static int cstate = 0;
500 static int cstate_stack_ptr = -1;
501 static int cstate_stack[CSTATE_STACK_SIZE];
503 /* Table of state transitions for handling conditional inclusions. There are
504 four possible state transitions:
508 .elifdef true (or .else)
511 .endif just causes the previous cstate to be popped off the stack */
513 static int next_cstate[3][4] =
515 /* State 0: reading from file, or reading until next .else or .endif */
517 /* State 1: condition failed, skipping until next .else or .endif */
519 /* State 2: skipping until .endif */
523 /* Table of conditionals and the states to set. For each name, there are four
524 values: the length of the name (to save computing it each time), the state to
525 set if a macro was found in the line, the state to set if a macro was not found
526 in the line, and a stack manipulation setting which is:
528 -1 pull state value off the stack
529 0 don't alter the stack
530 +1 push value onto stack, before setting new state
533 static cond_item cond_list[] = {
534 { US"ifdef", 5, 0, 1, 1 },
535 { US"ifndef", 6, 1, 0, 1 },
536 { US"elifdef", 7, 2, 3, 0 },
537 { US"elifndef", 8, 3, 2, 0 },
538 { US"else", 4, 2, 2, 0 },
539 { US"endif", 5, 0, 0, -1 }
542 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
544 /* Table of syslog facility names and their values */
546 static syslog_fac_item syslog_list[] = {
547 { US"mail", LOG_MAIL },
548 { US"user", LOG_USER },
549 { US"news", LOG_NEWS },
550 { US"uucp", LOG_UUCP },
551 { US"local0", LOG_LOCAL0 },
552 { US"local1", LOG_LOCAL1 },
553 { US"local2", LOG_LOCAL2 },
554 { US"local3", LOG_LOCAL3 },
555 { US"local4", LOG_LOCAL4 },
556 { US"local5", LOG_LOCAL5 },
557 { US"local6", LOG_LOCAL6 },
558 { US"local7", LOG_LOCAL7 },
559 { US"daemon", LOG_DAEMON }
562 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
565 #define opt_fn_print BIT(0)
566 #define opt_fn_print_label BIT(1)
569 /*************************************************
570 * Find the name of an option *
571 *************************************************/
573 /* This function is to aid debugging. Various functions take arguments that are
574 pointer variables in the options table or in option tables for various drivers.
575 For debugging output, it is useful to be able to find the name of the option
576 which is currently being processed. This function finds it, if it exists, by
577 searching the table(s).
579 Arguments: a value that is presumed to be in the table above
580 Returns: the option name, or an empty string
584 readconf_find_option(void *p)
586 for (int i = 0; i < nelem(optionlist_config); i++)
587 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
589 for (router_instance * r = routers; r; r = r->next)
591 router_info *ri = r->info;
592 for (int i = 0; i < *ri->options_count; i++)
594 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
595 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
596 return US ri->options[i].name;
600 for (transport_instance * t = transports; t; t = t->next)
602 transport_info *ti = t->info;
603 for (int i = 0; i < *ti->options_count; i++)
605 optionlist * op = &ti->options[i];
606 if ((op->type & opt_mask) != opt_stringptr) continue;
607 if (p == ( op->type & opt_public
609 : CS t->options_block
611 + (long int)op->value)
622 /*************************************************
623 * Deal with an assignment to a macro *
624 *************************************************/
626 /* We have a new definition; append to the list.
629 name Name of the macro; will be copied
630 val Expansion result for the macro; will be copied
634 macro_create(const uschar * name, const uschar * val, BOOL command_line)
636 macro_item * m = store_get(sizeof(macro_item), FALSE);
638 READCONF_DEBUG fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val);
640 m->command_line = command_line;
641 m->namelen = Ustrlen(name);
642 m->replen = Ustrlen(val);
643 m->name = string_copy(name);
644 m->replacement = string_copy(val);
656 /* This function is called when a line that starts with an upper case letter is
657 encountered. The argument "line" should contain a complete logical line, and
658 start with the first letter of the macro name. The macro name and the
659 replacement text are extracted and stored. Redefinition of existing,
660 non-command line, macros is permitted using '==' instead of '='.
663 s points to the start of the logical line
665 Returns: FALSE iff fatal error
669 macro_read_assignment(uschar *s)
676 while (isalnum(*s) || *s == '_')
678 if (namelen >= sizeof(name) - 1)
680 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
681 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
684 name[namelen++] = *s++;
688 while (isspace(*s)) s++;
691 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
700 while (isspace(*s)) s++;
702 /* If an existing macro of the same name was defined on the command line, we
703 just skip this definition. It's an error to attempt to redefine a macro without
704 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
705 It is also an error to define a macro whose name begins with the name of a
706 previously defined macro. This is the requirement that make using a tree
707 for macros hard; we must check all macros for the substring. Perhaps a
708 sorted list, and a bsearch, would work?
709 Note: it is documented that the other way round works. */
711 for (m = macros; m; m = m->next)
713 if (Ustrcmp(m->name, name) == 0)
715 if (!m->command_line && !redef)
717 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
718 "defined (use \"==\" if you want to redefine it)", name);
724 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
726 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
727 "a macro because previously defined macro \"%s\" is a substring",
732 /* We cannot have this test, because it is documented that a substring
733 macro is permitted (there is even an example).
735 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
736 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
737 * "a macro because it is a substring of previously defined macro \"%s\"",
742 /* Check for an overriding command-line definition. */
744 if (m && m->command_line) return TRUE;
746 /* Redefinition must refer to an existing macro. */
751 m->replen = Ustrlen(s);
752 m->replacement = string_copy(s);
756 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
761 /* We have a new definition. */
763 (void) macro_create(name, s, FALSE);
771 /* Process line for macros. The line is in big_buffer starting at offset len.
772 Expand big_buffer if needed. Handle definitions of new macros, and
773 macro expansions, rewriting the line in the buffer.
776 len Offset in buffer of start of line
777 newlen Pointer to offset of end of line, updated on return
778 macro_found Pointer to return that a macro was expanded
780 Return: pointer to first nonblank char in line
784 macros_expand(int len, int * newlen, BOOL * macro_found)
786 uschar * ss = big_buffer + len;
789 /* Find the true start of the physical line - leading spaces are always
792 while (isspace(*ss)) ss++;
794 /* Process the physical line for macros. If this is the start of the logical
795 line, skip over initial text at the start of the line if it starts with an
796 upper case character followed by a sequence of name characters and an equals
797 sign, because that is the definition of a new macro, and we don't do
798 replacement therein. */
801 if (len == 0 && isupper(*s))
803 while (isalnum(*s) || *s == '_') s++;
804 while (isspace(*s)) s++;
805 if (*s != '=') s = ss; /* Not a macro definition */
808 /* Skip leading chars which cannot start a macro name, to avoid multiple
809 pointless rescans in Ustrstr calls. */
811 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
813 /* For each defined macro, scan the line (from after XXX= if present),
814 replacing all occurrences of the macro. */
816 *macro_found = FALSE;
817 if (*s) for (macro_item * m = *s == '_' ? macros : macros_user; m; m = m->next)
822 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
826 while ((p = Ustrstr(t, m->name)) != NULL)
830 READCONF_DEBUG fprintf(stderr, "%s: matched '%s' in '%.*s'\n", __FUNCTION__,
831 m->name, (int) Ustrlen(ss)-1, ss);
832 /* Expand the buffer if necessary */
834 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
836 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
837 uschar *newbuffer = store_malloc(newsize);
838 memcpy(newbuffer, big_buffer, *newlen + 1);
839 p = newbuffer + (p - big_buffer);
840 s = newbuffer + (s - big_buffer);
841 ss = newbuffer + (ss - big_buffer);
842 t = newbuffer + (t - big_buffer);
843 big_buffer_size = newsize;
844 store_free(big_buffer);
845 big_buffer = newbuffer;
848 /* Shuffle the remaining characters up or down in the buffer before
849 copying in the replacement text. Don't rescan the replacement for this
853 if ((moveby = m->replen - m->namelen) != 0)
855 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
858 Ustrncpy(p, m->replacement, m->replen);
860 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
865 /* An empty macro replacement at the start of a line could mean that ss no
866 longer points to the first non-blank character. */
868 while (isspace(*ss)) ss++;
872 /*************************************************
873 * Read configuration line *
874 *************************************************/
876 /* A logical line of text is read from the configuration file into the big
877 buffer, taking account of macros, .includes, and continuations. The size of
878 big_buffer is increased if necessary. The count of configuration lines is
879 maintained. Physical input lines starting with # (ignoring leading white space,
880 and after macro replacement) and empty logical lines are always ignored.
881 Leading and trailing spaces are removed.
883 If we hit a line of the form "begin xxxx", the xxxx is placed in the
884 next_section vector, and the function returns NULL, indicating the end of a
885 configuration section. On end-of-file, NULL is returned with next_section
890 Returns: a pointer to the first non-blank in the line,
891 or NULL if eof or end of section is reached
895 get_config_line(void)
897 int startoffset = 0; /* To first non-blank char in logical line */
898 int len = 0; /* Of logical line so far */
903 /* Loop for handling continuation lines, skipping comments, and dealing with
908 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
910 if (config_file_stack != NULL) /* EOF inside .include */
912 (void)fclose(config_file);
913 config_file = config_file_stack->file;
914 config_filename = config_file_stack->filename;
915 config_directory = config_file_stack->directory;
916 config_lineno = config_file_stack->lineno;
917 config_file_stack = config_file_stack->next;
919 save_config_position(config_filename, config_lineno);
923 /* EOF at top level */
925 if (cstate_stack_ptr >= 0)
926 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
927 "Unexpected end of configuration file: .endif missing");
929 if (len != 0) break; /* EOF after continuation */
930 next_section[0] = 0; /* EOF at start of logical line */
935 newlen = len + Ustrlen(big_buffer + len);
937 if (config_lines && config_lineno == 1)
938 save_config_position(config_filename, config_lineno);
940 /* Handle pathologically long physical lines - yes, it did happen - by
941 extending big_buffer at this point. The code also copes with very long
944 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
947 big_buffer_size += BIG_BUFFER_SIZE;
948 newbuffer = store_malloc(big_buffer_size);
950 /* This use of strcpy is OK because we know that the string in the old
951 buffer is shorter than the new buffer. */
953 Ustrcpy(newbuffer, big_buffer);
954 store_free(big_buffer);
955 big_buffer = newbuffer;
956 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
958 newlen += Ustrlen(big_buffer + newlen);
961 ss = macros_expand(len, &newlen, ¯o_found);
963 /* Check for comment lines - these are physical lines. */
965 if (*ss == '#') continue;
967 /* Handle conditionals, which are also applied to physical lines. Conditions
968 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
969 expansion occurred on the rest of the line. A preliminary test for the leading
970 '.' saves effort on most lines. */
976 /* Search the list of conditional directives */
978 for (i = 0; i < cond_list_size; i++)
981 cond_item *c = cond_list+i;
982 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
984 /* The following character must be white space or end of string */
986 n = ss[1 + c->namelen];
987 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
989 /* .ifdef and .ifndef push the current state onto the stack, then set
990 a new one from the table. Stack overflow is an error */
994 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
995 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
996 ".%s nested too deeply", c->name);
997 cstate_stack[++cstate_stack_ptr] = cstate;
998 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1001 /* For any of the others, stack underflow is an error. The next state
1002 comes either from the stack (.endif) or from the table. */
1006 if (cstate_stack_ptr < 0)
1007 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1008 ".%s without matching .ifdef", c->name);
1009 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1010 next_cstate[cstate][macro_found? c->action1 : c->action2];
1013 /* Having dealt with a directive, break the loop */
1018 /* If we have handled a conditional directive, continue with the next
1019 physical line. Otherwise, fall through. */
1021 if (i < cond_list_size) continue;
1024 /* If the conditional state is not 0 (actively using these lines), ignore
1027 if (cstate != 0) continue; /* Conditional skip */
1029 /* Handle .include lines - these are also physical lines. */
1031 if (Ustrncmp(ss, ".include", 8) == 0 &&
1033 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1036 int include_if_exists = isspace(ss[8])? 0 : 10;
1037 config_file_item *save;
1038 struct stat statbuf;
1040 ss += 9 + include_if_exists;
1041 while (isspace(*ss)) ss++;
1042 t = ss + Ustrlen(ss);
1043 while (t > ss && isspace(t[-1])) t--;
1044 if (*ss == '\"' && t[-1] == '\"')
1051 /* We allow relative file names. For security reasons currently
1052 relative names not allowed with .include_if_exists. For .include_if_exists
1053 we need to check the permissions/ownership of the containing folder */
1055 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1056 "absolute path \"%s\"", ss);
1059 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1060 ss = string_from_gstring(g);
1063 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1066 save_config_position(config_filename, config_lineno);
1067 save = store_get(sizeof(config_file_item), FALSE);
1068 save->next = config_file_stack;
1069 config_file_stack = save;
1070 save->file = config_file;
1071 save->filename = config_filename;
1072 save->directory = config_directory;
1073 save->lineno = config_lineno;
1075 if (!(config_file = Ufopen(ss, "rb")))
1076 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1077 "configuration file %s", ss);
1079 config_filename = string_copy(ss);
1080 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1085 /* If this is the start of the logical line, remember where the non-blank
1086 data starts. Otherwise shuffle down continuation lines to remove leading
1090 startoffset = ss - big_buffer;
1093 s = big_buffer + len;
1096 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1101 /* Accept the new addition to the line. Remove trailing white space. */
1104 while (len > 0 && isspace(big_buffer[len-1])) len--;
1105 big_buffer[len] = 0;
1107 /* We are done if the line does not end in backslash and contains some data.
1108 Empty logical lines are ignored. For continuations, remove the backslash and
1109 go round the loop to read the continuation line. */
1113 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1114 big_buffer[--len] = 0; /* Remove backslash */
1116 } /* Loop for reading multiple physical lines */
1118 /* We now have a logical line. Test for the end of a configuration section (or,
1119 more accurately, for the start of the next section). Place the name of the next
1120 section in next_section, and return NULL. If the name given is longer than
1121 next_section, truncate it. It will be unrecognized later, because all the known
1122 section names do fit. Leave space for pluralizing. */
1124 s = big_buffer + startoffset; /* First non-space character */
1127 save_config_line(s);
1129 if (strncmpic(s, US"begin ", 6) == 0)
1132 while (isspace(*s)) s++;
1133 if (big_buffer + len - s > sizeof(next_section) - 2)
1134 s[sizeof(next_section) - 2] = 0;
1135 Ustrcpy(next_section, s);
1139 /* Return the first non-blank character. */
1146 /*************************************************
1148 *************************************************/
1150 /* The yield is the pointer to the next uschar. Names longer than the
1151 output space are silently truncated. This function is also used from acl.c when
1155 name where to put the name
1159 Returns: new input pointer
1163 readconf_readname(uschar *name, int len, uschar *s)
1166 while (isspace(*s)) s++;
1169 while (isalnum(*s) || *s == '_')
1171 if (p < len-1) name[p++] = *s;
1176 while (isspace(*s)) s++;
1183 /*************************************************
1184 * Read a time value *
1185 *************************************************/
1187 /* This function is also called from outside, to read argument
1188 time values. The format of a time value is:
1190 [<n>w][<n>d][<n>h][<n>m][<n>s]
1192 as long as at least one is present. If a format error is encountered,
1193 return a negative value. The value must be terminated by the given
1198 terminator required terminating character
1199 return_msec if TRUE, allow fractional seconds and return milliseconds
1201 Returns: the time value, or -1 on syntax error
1202 value is seconds if return_msec is FALSE
1203 value is milliseconds if return_msec is TRUE
1207 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1215 if (!isdigit(*s)) return -1;
1216 (void)sscanf(CCS s, "%d%n", &value, &count);
1221 case 'w': value *= 7;
1222 case 'd': value *= 24;
1223 case 'h': value *= 60;
1224 case 'm': value *= 60;
1229 if (!return_msec) return -1;
1230 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1232 if (*s++ != 's') return -1;
1233 yield += (int)(fraction * 1000.0);
1239 if (return_msec) value *= 1000;
1241 if (*s == terminator) return yield;
1243 /* Control never reaches here. */
1248 /*************************************************
1249 * Read a fixed point value *
1250 *************************************************/
1252 /* The value is returned *1000
1256 terminator required terminator
1258 Returns: the value, or -1 on error
1262 readconf_readfixed(const uschar *s, int terminator)
1266 if (!isdigit(*s)) return -1;
1267 (void)sscanf(CS s, "%d%n", &value, &count);
1269 yield = value * 1000;
1273 while (isdigit((*(++s))))
1275 yield += (*s - '0') * m;
1280 return (*s == terminator)? yield : (-1);
1285 /*************************************************
1286 * Find option in list *
1287 *************************************************/
1289 /* The lists are always in order, so binary chop can be used.
1292 name the option name to search for
1293 ol the first entry in the option list
1294 last one more than the offset of the last entry in the option list
1296 Returns: pointer to an option entry, or NULL if not found
1300 find_option(uschar *name, optionlist *ol, int last)
1303 while (last > first)
1305 int middle = (first + last)/2;
1306 int c = Ustrcmp(name, ol[middle].name);
1308 if (c == 0) return ol + middle;
1309 else if (c > 0) first = middle + 1;
1317 /*************************************************
1318 * Find a set flag in option list *
1319 *************************************************/
1321 /* Because some versions of Unix make no restrictions on the values of uids and
1322 gids (even negative ones), we cannot represent "unset" by a special value.
1323 There is therefore a separate boolean variable for each one indicating whether
1324 a value is set or not. This function returns a pointer to the boolean, given
1325 the original option name. It is a major disaster if the flag cannot be found.
1328 name the name of the uid or gid option
1329 oltop points to the start of the relevant option list
1330 last one more than the offset of the last item in the option list
1331 data_block NULL when reading main options => data values in the option
1332 list are absolute addresses; otherwise they are byte offsets
1333 in data_block (used for driver options)
1335 Returns: a pointer to the boolean flag.
1339 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1343 sprintf(CS name2, "*set_%.50s", name);
1344 ol = find_option(name2, oltop, last);
1345 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1346 "Exim internal error: missing set flag for %s", name);
1347 return (data_block == NULL)? (BOOL *)(ol->value) :
1348 (BOOL *)(US data_block + (long int)(ol->value));
1354 /*************************************************
1355 * Output extra characters message and die *
1356 *************************************************/
1358 /* Called when an option line has junk on the end. Sometimes this is because
1359 the sysadmin thinks comments are permitted.
1362 s points to the extra characters
1363 t1..t3 strings to insert in the log message
1365 Returns: doesn't return; dies
1369 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1371 uschar *comment = US"";
1372 if (*s == '#') comment = US" (# is comment only at line start)";
1373 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1374 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1379 /*************************************************
1380 * Read rewrite information *
1381 *************************************************/
1383 /* Each line of rewrite information contains:
1385 . A complete address in the form user@domain, possibly with
1386 leading * for each part; or alternatively, a regex.
1388 . A replacement string (which will be expanded).
1390 . An optional sequence of one-letter flags, indicating which
1391 headers etc. to apply this rule to.
1393 All this is decoded and placed into a control block. The OR of the flags is
1394 maintained in a common word.
1397 p points to the string that makes up the rule
1398 existflags points to the overall flag word
1399 isglobal TRUE if reading global rewrite rules
1401 Returns: the control block for the parsed rule.
1404 static rewrite_rule *
1405 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1407 rewrite_rule *next = store_get(sizeof(rewrite_rule), FALSE);
1410 next->key = string_dequote(&p);
1412 while (isspace(*p)) p++;
1414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1415 "missing rewrite replacement string");
1418 next->replacement = string_dequote(&p);
1420 while (*p != 0) switch (*p++)
1422 case ' ': case '\t': break;
1424 case 'q': next->flags |= rewrite_quit; break;
1425 case 'w': next->flags |= rewrite_whole; break;
1427 case 'h': next->flags |= rewrite_all_headers; break;
1428 case 's': next->flags |= rewrite_sender; break;
1429 case 'f': next->flags |= rewrite_from; break;
1430 case 't': next->flags |= rewrite_to; break;
1431 case 'c': next->flags |= rewrite_cc; break;
1432 case 'b': next->flags |= rewrite_bcc; break;
1433 case 'r': next->flags |= rewrite_replyto; break;
1435 case 'E': next->flags |= rewrite_all_envelope; break;
1436 case 'F': next->flags |= rewrite_envfrom; break;
1437 case 'T': next->flags |= rewrite_envto; break;
1439 case 'Q': next->flags |= rewrite_qualify; break;
1440 case 'R': next->flags |= rewrite_repeat; break;
1443 next->flags |= rewrite_smtp;
1444 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1445 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1446 "rewrite rule has the S flag but is not a regular expression");
1450 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1451 "unknown rewrite flag character '%c' "
1452 "(could be missing quotes round replacement item)", p[-1]);
1456 /* If no action flags are set, set all the "normal" rewrites. */
1458 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1459 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1461 /* Remember which exist, for optimization, and return the rule */
1463 *existflags |= next->flags;
1470 /*************************************************
1471 * Read global rewrite information *
1472 *************************************************/
1474 /* Each line is a single rewrite rule; it is parsed into a control block
1475 by readconf_one_rewrite(), and its flags are ORed into the global flag
1476 word rewrite_existflags. */
1479 readconf_rewrites(void)
1481 rewrite_rule **chain = &global_rewrite_rules;
1484 while ((p = get_config_line()) != NULL)
1486 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1488 chain = &(next->next);
1494 /*************************************************
1496 *************************************************/
1498 /* Strings are read into the normal store pool. As long we aren't too
1499 near the end of the current block, the string will just use what is necessary
1500 on the top of the stacking pool, because string_cat() uses the extension
1504 s the rest of the input line
1505 name the option name (for errors)
1507 Returns: pointer to the string
1511 read_string(const uschar *s, const uschar *name)
1516 if (*s != '\"') return string_copy(s);
1519 yield = string_dequote(&s);
1521 if (s == ss+1 || s[-1] != '\"')
1522 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1523 "missing quote at end of string value for %s", name);
1525 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1531 /*************************************************
1532 * Custom-handler options *
1533 *************************************************/
1535 fn_smtp_receive_timeout(const uschar * name, const uschar * str, unsigned flags)
1537 if (flags & opt_fn_print)
1539 if (flags & opt_fn_print_label) printf("%s = ", name);
1540 printf("%s\n", smtp_receive_timeout_s
1541 ? string_printing2(smtp_receive_timeout_s, FALSE)
1542 : readconf_printtime(smtp_receive_timeout));
1544 else if (*str == '$')
1545 smtp_receive_timeout_s = string_copy(str);
1548 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1549 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1550 if (smtp_receive_timeout < 0)
1551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1556 /*************************************************
1557 * Handle option line *
1558 *************************************************/
1560 /* This function is called from several places to process a line containing the
1561 setting of an option. The first argument is the line to be decoded; it has been
1562 checked not to be empty and not to start with '#'. Trailing newlines and white
1563 space have been removed. The second argument is a pointer to the list of
1564 variable names that are to be recognized, together with their types and
1565 locations, and the third argument gives the number of entries in the list.
1567 The fourth argument is a pointer to a data block. If it is NULL, then the data
1568 values in the options list are absolute addresses. Otherwise, they are byte
1569 offsets in the data block.
1571 String option data may continue onto several lines; this function reads further
1572 data from config_file if necessary.
1574 The yield of this function is normally zero. If a string continues onto
1575 multiple lines, then the data value is permitted to be followed by a comma
1576 or a semicolon (for use in drivers) and the yield is that character.
1579 buffer contains the configuration line to be handled
1580 oltop points to the start of the relevant option list
1581 last one more than the offset of the last item in the option list
1582 data_block NULL when reading main options => data values in the option
1583 list are absolute addresses; otherwise they are byte offsets
1584 in data_block when they have opt_public set; otherwise
1585 they are byte offsets in data_block->options_block.
1586 unknown_txt format string to use in panic message for unknown option;
1587 must contain %s for option name
1588 if given as NULL, don't panic on unknown option
1590 Returns: TRUE if an option was read successfully,
1591 FALSE false for an unknown option if unknown_txt == NULL,
1592 otherwise panic and die on an unknown option
1596 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1597 void *data_block, uschar *unknown_txt)
1601 int count, type, value;
1605 BOOL boolvalue = TRUE;
1606 BOOL freesptr = TRUE;
1607 optionlist *ol, *ol2;
1611 uschar *inttype = US"";
1614 uschar **str_target;
1618 /* There may be leading spaces; thereafter, we expect an option name starting
1621 while (isspace(*s)) s++;
1623 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1625 /* Read the name of the option, and skip any subsequent white space. If
1626 it turns out that what we read was "hide", set the flag indicating that
1627 this is a secure option, and loop to read the next word. */
1629 for (int n = 0; n < 2; n++)
1631 while (isalnum(*s) || *s == '_')
1633 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1637 while (isspace(*s)) s++;
1638 if (Ustrcmp(name, "hide") != 0) break;
1639 issecure = opt_secure;
1643 /* Deal with "no_" or "not_" here for booleans */
1645 if (Ustrncmp(name, "no_", 3) == 0)
1651 if (Ustrncmp(name, "not_", 4) == 0)
1657 /* Search the list for the given name. A non-existent name, or an option that
1658 is set twice, is a disaster. */
1660 if (!(ol = find_option(name + offset, oltop, last)))
1662 if (unknown_txt == NULL) return FALSE;
1663 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1666 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1667 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1668 "\"%s\" option set for the second time", name);
1670 ol->type |= opt_set | issecure;
1671 type = ol->type & opt_mask;
1673 /* Types with data values must be followed by '='; the "no[t]_" prefix
1674 applies only to boolean values. */
1676 if (type < opt_bool || type > opt_bool_last)
1679 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1680 "negation prefix applied to a non-boolean option");
1682 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1683 "unexpected end of line (data missing) after %s", name);
1685 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1688 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1689 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1690 ultimately expands to one of those values. */
1692 else if (*s != 0 && (offset != 0 || *s != '='))
1693 extra_chars_error(s, US"boolean option ", name, US"");
1695 /* Skip white space after = */
1697 if (*s == '=') while (isspace((*(++s))));
1699 /* If there is a data block and the opt_public flag is not set, change
1700 the data block pointer to the private options block. */
1702 if (data_block != NULL && (ol->type & opt_public) == 0)
1703 data_block = (void *)(((driver_instance *)data_block)->options_block);
1705 /* Now get the data according to the type. */
1709 /* If a string value is not enclosed in quotes, it consists of
1710 the rest of the current line, verbatim. Otherwise, string escapes
1713 A transport is specified as a string, which is then looked up in the
1714 list of transports. A search type is specified as one of a number of
1717 A set or rewrite rules for a driver is specified as a string, which is
1718 then parsed into a suitable chain of control blocks.
1720 Uids and gids are specified as strings which are then looked up in the
1721 passwd file. Lists of uids and gids are similarly specified as colon-
1722 separated strings. */
1727 case opt_expand_uid:
1728 case opt_expand_gid:
1733 reset_point = store_mark();
1734 sptr = read_string(s, name);
1736 /* Having read a string, we now have several different ways of using it,
1737 depending on the data type, so do another switch. If keeping the actual
1738 string is not required (because it is interpreted), freesptr is set TRUE,
1739 and at the end we reset the pool. */
1743 /* If this was a string, set the variable to point to the new string,
1744 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1745 rules, we still keep the string (for printing), and parse the rules into a
1746 control block and flags word. */
1749 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1751 if (ol->type & opt_rep_con)
1753 uschar * saved_condition;
1754 /* We already have a condition, we're conducting a crude hack to let
1755 multiple condition rules be chained together, despite storing them in
1757 *str_target = string_copy_perm( (saved_condition = *str_target)
1758 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1759 saved_condition, sptr)
1762 /* TODO(pdp): there is a memory leak here and just below
1763 when we set 3 or more conditions; I still don't
1764 understand the store mechanism enough to know
1765 what's the safe way to free content from an earlier store.
1766 AFAICT, stores stack, so freeing an early stored item also stores
1767 all data alloc'd after it. If we knew conditions were adjacent,
1768 we could survive that, but we don't. So I *think* we need to take
1769 another bit from opt_type to indicate "malloced"; this seems like
1770 quite a hack, especially for this one case. It also means that
1771 we can't ever reclaim the store from the *first* condition.
1773 Because we only do this once, near process start-up, I'm prepared to
1774 let this slide for the time being, even though it rankles. */
1776 else if (ol->type & opt_rep_str)
1779 Ustrncmp(name, "headers_add", 11) == 0 ? '\n'
1780 : Ustrncmp(name, "set", 3) == 0 ? ';'
1782 int sep_i = -(int)sep_o;
1783 const uschar * list = sptr;
1785 gstring * list_o = NULL;
1789 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1790 list_o = string_cat(list_o, *str_target);
1793 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1794 list_o = string_append_listele(list_o, sep_o, s);
1797 *str_target = string_copy_perm(string_from_gstring(list_o), FALSE);
1808 *USS (US data_block + (long int)(ol->value)) = sptr;
1810 *USS (ol->value) = sptr;
1812 if (type == opt_rewrite)
1817 rewrite_rule **chain;
1820 sprintf(CS name2, "*%.50s_rules", name);
1821 ol2 = find_option(name2, oltop, last);
1822 sprintf(CS name2, "*%.50s_flags", name);
1823 ol3 = find_option(name2, oltop, last);
1825 if (ol2 == NULL || ol3 == NULL)
1826 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1827 "rewrite rules not available for driver");
1829 if (data_block == NULL)
1831 chain = (rewrite_rule **)(ol2->value);
1832 flagptr = (int *)(ol3->value);
1836 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1837 flagptr = (int *)(US data_block + (long int)(ol3->value));
1840 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1842 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1844 chain = &(next->next);
1847 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1848 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1849 "non-header rewrite - not allowed at transport time -");
1853 /* If it was an expanded uid, see if there is any expansion to be
1854 done by checking for the presence of a $ character. If there is, save it
1855 in the corresponding *expand_user option field. Otherwise, fall through
1856 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1859 case opt_expand_uid:
1860 sprintf(CS name2, "*expand_%.50s", name);
1861 ol2 = find_option(name2, oltop, last);
1864 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1866 if (data_block == NULL)
1867 *((uschar **)(ol2->value)) = ss;
1869 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1873 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1879 /* Look up a fixed uid, and also make use of the corresponding gid
1880 if a passwd entry is returned and the gid has not been set. */
1883 if (!route_finduser(sptr, &pw, &uid))
1884 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1885 if (data_block == NULL)
1886 *((uid_t *)(ol->value)) = uid;
1888 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1890 /* Set the flag indicating a fixed value is set */
1892 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1894 /* Handle matching gid if we have a passwd entry: done by finding the
1895 same name with terminating "user" changed to "group"; if not found,
1896 ignore. Also ignore if the value is already set. */
1898 if (pw == NULL) break;
1899 Ustrcpy(name+Ustrlen(name)-4, US"group");
1900 ol2 = find_option(name, oltop, last);
1901 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1902 (ol2->type & opt_mask) == opt_expand_gid))
1904 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1907 if (data_block == NULL)
1908 *((gid_t *)(ol2->value)) = pw->pw_gid;
1910 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1916 /* If it was an expanded gid, see if there is any expansion to be
1917 done by checking for the presence of a $ character. If there is, save it
1918 in the corresponding *expand_user option field. Otherwise, fall through
1919 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1922 case opt_expand_gid:
1923 sprintf(CS name2, "*expand_%.50s", name);
1924 ol2 = find_option(name2, oltop, last);
1927 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1929 if (data_block == NULL)
1930 *((uschar **)(ol2->value)) = ss;
1932 *((uschar **)(US data_block + (long int)(ol2->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);
1947 if (data_block == NULL)
1948 *((gid_t *)(ol->value)) = gid;
1950 *((gid_t *)(US data_block + (long int)(ol->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);
1977 if (data_block == NULL)
1978 *((uid_t **)(ol->value)) = list;
1980 *((uid_t **)(US data_block + (long int)(ol->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);
2018 if (data_block == NULL)
2019 *((gid_t **)(ol->value)) = list;
2021 *((gid_t **)(US data_block + (long int)(ol->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 != 0 && 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);
2054 if (data_block == NULL)
2055 *((uschar **)(ol2->value)) = sptr;
2057 *((uschar **)(US data_block + (long int)(ol2->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 == NULL)?
2094 (int *)(ol->value) :
2095 (int *)(US data_block + (long int)ol->value);
2096 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2100 /* Handle full BOOL types */
2102 if (data_block == NULL)
2103 *((BOOL *)(ol->value)) = boolvalue;
2105 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2109 if (type == opt_bool_verify)
2111 sprintf(CS name2, "%.50s_recipient", name + offset);
2112 ol2 = find_option(name2, oltop, last);
2115 if (data_block == NULL)
2116 *((BOOL *)(ol2->value)) = boolvalue;
2118 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2122 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2124 else if (type == opt_bool_set)
2126 sprintf(CS name2, "*set_%.50s", name + offset);
2127 ol2 = find_option(name2, oltop, last);
2130 if (data_block == NULL)
2131 *((BOOL *)(ol2->value)) = TRUE;
2133 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2142 inttype = US"octal ";
2144 /* Integer: a simple(ish) case; allow octal and hex formats, and
2145 suffixes K, M, G, and T. The different types affect output, not input. */
2154 lvalue = strtol(CS s, CSS &endptr, intbase);
2157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2160 if (errno != ERANGE && *endptr)
2162 uschar * mp = US"TtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2164 if ((mp = Ustrchr(mp, *endptr)))
2169 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024)
2180 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2181 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2182 "absolute value of integer \"%s\" is too large (overflow)", s);
2184 while (isspace(*endptr)) endptr++;
2186 extra_chars_error(endptr, inttype, US"integer value for ", name);
2188 value = (int)lvalue;
2192 *(int *)(US data_block + (long int)ol->value) = value;
2194 *(int *)ol->value = value;
2197 /* Integer held in K: again, allow formats and suffixes as above. */
2203 int_eximarith_t lvalue = strtol(CS s, CSS &endptr, intbase);
2206 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2209 if (errno != ERANGE && *endptr)
2211 uschar * mp = US"ZzEePpTtGgMmKk\0"; /* YyZzEePpTtGgMmKk */
2213 if ((mp = Ustrchr(mp, *endptr)))
2218 if (lvalue > EXIM_ARITH_MAX/1024 || lvalue < EXIM_ARITH_MIN/1024)
2227 lvalue = (lvalue + 512)/1024;
2230 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2231 "absolute value of integer \"%s\" is too large (overflow)", s);
2233 while (isspace(*endptr)) endptr++;
2235 extra_chars_error(endptr, inttype, US"integer value for ", name);
2238 *(int_eximarith_t *)(US data_block + (long int)ol->value) = lvalue;
2240 *(int_eximarith_t *)ol->value = lvalue;
2244 /* Fixed-point number: held to 3 decimal places. */
2247 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2248 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2249 "fixed-point number expected for %s", name);
2251 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2252 "integer \"%s\" is too large (overflow)", s);
2256 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2257 "integer \"%s\" is too large (overflow)", s);
2259 /* We get a coverity error here for using count, as it derived
2260 from the tainted buffer pointed to by s, as parsed by sscanf().
2261 By the definition of sscanf we must be accessing between start
2262 and end of s (assuming it is nul-terminated...) so ignore the error. */
2263 /* coverity[tainted_data] */
2264 if (s[count] == '.')
2267 while (isdigit(s[++count]))
2269 value += (s[count] - '0') * d;
2274 while (isspace(s[count])) count++;
2277 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2279 if (data_block == NULL)
2280 *((int *)(ol->value)) = value;
2282 *((int *)(US data_block + (long int)(ol->value))) = value;
2285 /* There's a special routine to read time values. */
2288 value = readconf_readtime(s, 0, FALSE);
2290 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2292 if (data_block == NULL)
2293 *((int *)(ol->value)) = value;
2295 *((int *)(US data_block + (long int)(ol->value))) = value;
2298 /* A time list is a list of colon-separated times, with the first
2299 element holding the size of the list and the second the number of
2305 int *list = (data_block == NULL)?
2306 (int *)(ol->value) :
2307 (int *)(US data_block + (long int)(ol->value));
2309 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2312 uschar *snext = Ustrchr(s, ':');
2316 while (ss > s && isspace(ss[-1])) ss--;
2319 value = readconf_readtime(s, terminator, FALSE);
2321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2323 if (count > 1 && value <= list[count])
2324 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2325 "time value out of order for %s", name);
2326 list[count+1] = value;
2327 if (snext == NULL) break;
2329 while (isspace(*s)) s++;
2332 if (count > list[0] - 2)
2333 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2335 if (count > 0 && list[2] == 0) count = 0;
2342 void (*fn)() = ol->value;
2353 /*************************************************
2354 * Print a time value *
2355 *************************************************/
2358 Argument: a time value in seconds
2359 Returns: pointer to a fixed buffer containing the time as a string,
2360 in readconf_readtime() format
2364 readconf_printtime(int t)
2367 uschar *p = time_buffer;
2384 if (w > 0) p += sprintf(CS p, "%dw", w);
2385 if (d > 0) p += sprintf(CS p, "%dd", d);
2386 if (h > 0) p += sprintf(CS p, "%dh", h);
2387 if (m > 0) p += sprintf(CS p, "%dm", m);
2388 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2395 /*************************************************
2396 * Print an individual option value *
2397 *************************************************/
2399 /* This is used by the -bP option, so prints to the standard output.
2400 The entire options list is passed in as an argument, because some options come
2401 in pairs - typically uid/gid settings, which can either be explicit numerical
2402 values, or strings to be expanded later. If the numerical value is unset,
2403 search for "*expand_<name>" to see if there is a string equivalent.
2406 ol option entry, or NULL for an unknown option
2408 options_block NULL for main configuration options; otherwise points to
2409 a driver block; if the option doesn't have opt_public
2410 set, then options_block->options_block is where the item
2412 oltop points to the option list in which ol exists
2413 last one more than the offset of the last entry in optop
2414 no_labels do not show "foo = " at the start.
2416 Returns: boolean success
2420 print_ol(optionlist *ol, uschar *name, void *options_block,
2421 optionlist *oltop, int last, BOOL no_labels)
2434 printf("%s is not a known option\n", name);
2438 /* Non-admin callers cannot see options that have been flagged secure by the
2441 if (!f.admin_user && ol->type & opt_secure)
2444 printf("%s\n", hidden);
2446 printf("%s = %s\n", name, hidden);
2450 /* Else show the value of the option */
2455 if (!(ol->type & opt_public))
2456 options_block = (void *)(((driver_instance *)options_block)->options_block);
2457 value = (void *)(US options_block + (long int)value);
2460 switch(ol->type & opt_mask)
2463 case opt_rewrite: /* Show the text value */
2465 if (!no_labels) printf("%s = ", name);
2466 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2470 if (!no_labels) printf("%s = ", name);
2471 printf("%d\n", *((int *)value));
2476 int x = *((int *)value);
2477 if (x != 0 && (x & 1023) == 0)
2481 if ((x & 1023) == 0)
2486 if (!no_labels) printf("%s = ", name);
2487 printf("%d%c\n", x, c);
2491 if (!no_labels) printf("%s = ", name);
2499 int_eximarith_t x = *((int_eximarith_t *)value);
2500 if (!no_labels) printf("%s = ", name);
2501 if (x == 0) printf("0\n");
2502 else if ((x & ((1<<30)-1)) == 0) printf(PR_EXIM_ARITH "T\n", x >> 30);
2503 else if ((x & ((1<<20)-1)) == 0) printf(PR_EXIM_ARITH "G\n", x >> 20);
2504 else if ((x & ((1<<10)-1)) == 0) printf(PR_EXIM_ARITH "M\n", x >> 10);
2505 else printf(PR_EXIM_ARITH "K\n", x);
2510 if (!no_labels) printf("%s = ", name);
2511 printf("%#o\n", *((int *)value));
2514 /* Can be negative only when "unset", in which case integer */
2518 int x = *((int *)value);
2521 if (x < 0) printf("%s =\n", name); else
2523 if (!no_labels) printf("%s = ", name);
2524 printf("%d.", x/1000);
2537 /* If the numerical value is unset, try for the string value */
2539 case opt_expand_uid:
2540 if (! *get_set_flag(name, oltop, last, options_block))
2542 sprintf(CS name2, "*expand_%.50s", name);
2543 if ((ol2 = find_option(name2, oltop, last)))
2545 void *value2 = ol2->value;
2547 value2 = (void *)(US options_block + (long int)value2);
2549 if (!no_labels) printf("%s = ", name);
2550 printf("%s\n", s ? string_printing(s) : US"");
2555 /* Else fall through */
2558 if (!no_labels) printf("%s = ", name);
2559 if (! *get_set_flag(name, oltop, last, options_block))
2562 if ((pw = getpwuid(*((uid_t *)value))))
2563 printf("%s\n", pw->pw_name);
2565 printf("%ld\n", (long int)(*((uid_t *)value)));
2568 /* If the numerical value is unset, try for the string value */
2570 case opt_expand_gid:
2571 if (! *get_set_flag(name, oltop, last, options_block))
2573 sprintf(CS name2, "*expand_%.50s", name);
2574 if ( (ol2 = find_option(name2, oltop, last))
2575 && (ol2->type & opt_mask) == opt_stringptr)
2577 void *value2 = ol2->value;
2579 value2 = (void *)(US options_block + (long int)value2);
2581 if (!no_labels) printf("%s = ", name);
2582 printf("%s\n", s ? string_printing(s) : US"");
2587 /* Else fall through */
2590 if (!no_labels) printf("%s = ", name);
2591 if (! *get_set_flag(name, oltop, last, options_block))
2594 if ((gr = getgrgid(*((int *)value))))
2595 printf("%s\n", gr->gr_name);
2597 printf("%ld\n", (long int)(*((int *)value)));
2601 uidlist = *((uid_t **)value);
2602 if (!no_labels) printf("%s =", name);
2605 uschar sep = no_labels ? '\0' : ' ';
2606 for (int i = 1; i <= (int)(uidlist[0]); i++)
2608 uschar *name = NULL;
2609 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2610 if (sep != '\0') printf("%c", sep);
2611 if (name) printf("%s", name);
2612 else printf("%ld", (long int)(uidlist[i]));
2620 gidlist = *((gid_t **)value);
2621 if (!no_labels) printf("%s =", name);
2624 uschar sep = no_labels ? '\0' : ' ';
2625 for (int i = 1; i <= (int)(gidlist[0]); i++)
2627 uschar *name = NULL;
2628 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2629 if (sep != '\0') printf("%c", sep);
2630 if (name) printf("%s", name);
2631 else printf("%ld", (long int)(gidlist[i]));
2639 if (!no_labels) printf("%s = ", name);
2640 printf("%s\n", readconf_printtime(*((int *)value)));
2645 int *list = (int *)value;
2646 if (!no_labels) printf("%s = ", name);
2647 for (int i = 0; i < list[1]; i++)
2648 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2654 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2658 case opt_expand_bool:
2659 sprintf(CS name2, "*expand_%.50s", name);
2660 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2662 void *value2 = ol2->value;
2664 value2 = (void *)(US options_block + (long int)value2);
2668 if (!no_labels) printf("%s = ", name);
2669 printf("%s\n", string_printing(s));
2672 /* s == NULL => string not set; fall through */
2678 case opt_bool_verify:
2680 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2685 void (*fn)() = ol->value;
2686 fn(name, NULL, no_labels ? opt_fn_print : opt_fn_print|opt_fn_print_label);
2695 /*************************************************
2696 * Print value from main configuration *
2697 *************************************************/
2699 /* This function, called as a result of encountering the -bP option,
2700 causes the value of any main configuration variable to be output if the
2701 second argument is NULL. There are some special values:
2703 all print all main configuration options
2704 config_file print the name of the configuration file
2705 (configure_file will still work, for backward
2707 routers print the routers' configurations
2708 transports print the transports' configuration
2709 authenticators print the authenticators' configuration
2710 macros print the macros' configuration
2711 router_list print a list of router names
2712 transport_list print a list of transport names
2713 authenticator_list print a list of authentication mechanism names
2714 macro_list print a list of macro names
2715 +name print a named list item
2716 local_scan print the local_scan options
2717 config print the configuration as it is parsed
2718 environment print the used execution environment
2720 If the second argument is not NULL, it must be one of "router", "transport",
2721 "authenticator" or "macro" in which case the first argument identifies the
2722 driver whose options are to be printed.
2725 name option name if type == NULL; else driver name
2726 type NULL or driver type name, as described above
2727 no_labels avoid the "foo = " at the start of an item
2729 Returns: Boolean success
2733 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2735 BOOL names_only = FALSE;
2736 optionlist *ol2 = NULL;
2737 driver_instance *d = NULL;
2746 static uschar *types[] = { US"address", US"domain", US"host",
2748 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2749 &hostlist_anchor, &localpartlist_anchor };
2751 for (int i = 0; i < 4; i++)
2752 if ((t = tree_search(*(anchors[i]), name+1)))
2756 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2758 printf("%slist %s = %s\n", types[i], name+1,
2759 ((namedlist_block *)(t->data.ptr))->string);
2763 printf("no address, domain, host, or local part list called \"%s\" "
2764 "exists\n", name+1);
2769 if ( Ustrcmp(name, "configure_file") == 0
2770 || Ustrcmp(name, "config_file") == 0)
2772 printf("%s\n", CS config_main_filename);
2776 if (Ustrcmp(name, "all") == 0)
2778 for (optionlist * ol = optionlist_config;
2779 ol < optionlist_config + nelem(optionlist_config); ol++)
2780 if (!(ol->type & opt_hidden))
2781 (void) print_ol(ol, US ol->name, NULL,
2782 optionlist_config, nelem(optionlist_config),
2787 if (Ustrcmp(name, "local_scan") == 0)
2789 #ifndef LOCAL_SCAN_HAS_OPTIONS
2790 printf("local_scan() options are not supported\n");
2793 for (optionlist * ol = local_scan_options;
2794 ol < local_scan_options + local_scan_options_count; ol++)
2795 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2796 local_scan_options_count, no_labels);
2801 if (Ustrcmp(name, "config") == 0)
2803 print_config(f.admin_user, no_labels);
2807 if (Ustrcmp(name, "routers") == 0)
2812 else if (Ustrcmp(name, "transports") == 0)
2814 type = US"transport";
2817 else if (Ustrcmp(name, "authenticators") == 0)
2819 type = US"authenticator";
2822 else if (Ustrcmp(name, "macros") == 0)
2827 else if (Ustrcmp(name, "router_list") == 0)
2833 else if (Ustrcmp(name, "transport_list") == 0)
2835 type = US"transport";
2839 else if (Ustrcmp(name, "authenticator_list") == 0)
2841 type = US"authenticator";
2845 else if (Ustrcmp(name, "macro_list") == 0)
2851 else if (Ustrcmp(name, "environment") == 0)
2856 for (p = USS environ; *p; p++) ;
2857 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2859 for (p = USS environ; *p; p++)
2862 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2870 return print_ol(find_option(name,
2871 optionlist_config, nelem(optionlist_config)),
2872 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2875 /* Handle the options for a router or transport. Skip options that are flagged
2876 as hidden. Some of these are options with names starting with '*', used for
2877 internal alternative representations of other options (which the printing
2878 function will sort out). Others are synonyms kept for backward compatibility.
2881 if (Ustrcmp(type, "router") == 0)
2883 d = (driver_instance *)routers;
2884 ol2 = optionlist_routers;
2885 size = optionlist_routers_size;
2887 else if (Ustrcmp(type, "transport") == 0)
2889 d = (driver_instance *)transports;
2890 ol2 = optionlist_transports;
2891 size = optionlist_transports_size;
2893 else if (Ustrcmp(type, "authenticator") == 0)
2895 d = (driver_instance *)auths;
2896 ol2 = optionlist_auths;
2897 size = optionlist_auths_size;
2900 else if (Ustrcmp(type, "macro") == 0)
2902 /* People store passwords in macros and they were previously not available
2903 for printing. So we have an admin_users restriction. */
2906 fprintf(stderr, "exim: permission denied\n");
2909 for (macro_item * m = macros; m; m = m->next)
2910 if (!name || Ustrcmp(name, m->name) == 0)
2913 printf("%s\n", CS m->name);
2915 printf("%s\n", CS m->replacement);
2917 printf("%s=%s\n", CS m->name, CS m->replacement);
2921 if (!name) return TRUE;
2923 printf("%s %s not found\n", type, name);
2929 for (; d; d = d->next) printf("%s\n", CS d->name);
2933 /* Either search for a given driver, or print all of them */
2935 for (; d; d = d->next)
2939 printf("\n%s %s:\n", d->name, type);
2940 else if (Ustrcmp(d->name, name) != 0) continue;
2942 for (optionlist * ol = ol2; ol < ol2 + size; ol++)
2943 if (!(ol->type & opt_hidden))
2944 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2946 for (optionlist * ol = d->info->options;
2947 ol < d->info->options + *(d->info->options_count); ol++)
2948 if (!(ol->type & opt_hidden))
2949 rc |= print_ol(ol, US ol->name, d, d->info->options,
2950 *d->info->options_count, no_labels);
2952 if (name) return rc;
2954 if (!name) return TRUE;
2956 printf("%s %s not found\n", type, name);
2962 /*************************************************
2963 * Read a named list item *
2964 *************************************************/
2966 /* This function reads a name and a list (i.e. string). The name is used to
2967 save the list in a tree, sorted by its name. Each entry also has a number,
2968 which can be used for caching tests, but if the string contains any expansion
2969 items other than $key, the number is set negative to inhibit caching. This
2970 mechanism is used for domain, host, and address lists that are referenced by
2974 anchorp points to the tree anchor
2975 numberp points to the current number for this tree
2976 max the maximum number permitted
2977 s the text of the option line, starting immediately after the name
2979 tname the name of the list type, for messages
2985 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2988 BOOL forcecache = FALSE;
2991 namedlist_block *nb = store_get(sizeof(namedlist_block), FALSE);
2993 if (Ustrncmp(s, "_cache", 6) == 0)
3000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3002 if (*numberp >= max)
3003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3006 while (isspace(*s)) s++;
3008 while (isalnum(*s) || *s == '_') s++;
3009 t = store_get(sizeof(tree_node) + s-ss, is_tainted(ss));
3010 Ustrncpy(t->name, ss, s-ss);
3012 while (isspace(*s)) s++;
3014 if (!tree_insertnode(anchorp, t))
3015 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3016 "duplicate name \"%s\" for a named %s", t->name, tname);
3019 nb->number = *numberp;
3022 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3023 "missing '=' after \"%s\"", t->name);
3024 while (isspace(*s)) s++;
3025 nb->string = read_string(s, t->name);
3026 nb->cache_data = NULL;
3028 /* Check the string for any expansions; if any are found, mark this list
3029 uncacheable unless the user has explicited forced caching. */
3031 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3037 /*************************************************
3038 * Unpick data for a rate limit *
3039 *************************************************/
3041 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3045 s string, in the form t,b,f,l
3046 where t is the threshold (integer)
3047 b is the initial delay (time)
3048 f is the multiplicative factor (fixed point)
3049 k is the maximum time (time)
3050 threshold where to store threshold
3051 base where to store base in milliseconds
3052 factor where to store factor in milliseconds
3053 limit where to store limit
3055 Returns: nothing (panics on error)
3059 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3062 uschar bstring[16], lstring[16];
3064 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3065 factor, lstring) == 4)
3067 *base = readconf_readtime(bstring, 0, TRUE);
3068 *limit = readconf_readtime(lstring, 0, TRUE);
3069 if (*base >= 0 && *limit >= 0) return;
3071 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3077 /*************************************************
3078 * Drop privs for checking TLS config *
3079 *************************************************/
3081 /* We want to validate TLS options during readconf, but do not want to be
3082 root when we call into the TLS library, in case of library linkage errors
3083 which cause segfaults; before this check, those were always done as the Exim
3084 runtime user and it makes sense to continue with that.
3086 Assumes: tls_require_ciphers has been set, if it will be
3087 exim_user has been set, if it will be
3088 exim_group has been set, if it will be
3090 Returns: bool for "okay"; false will cause caller to immediately exit.
3095 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3097 const uschar *errmsg;
3100 void (*oldsignal)(int);
3102 /* If TLS will never be used, no point checking ciphers */
3104 if ( !tls_advertise_hosts
3105 || !*tls_advertise_hosts
3106 || Ustrcmp(tls_advertise_hosts, ":") == 0
3109 else if (!nowarn && !tls_certificate)
3110 log_write(0, LOG_MAIN,
3111 "Warning: No server certificate defined; will use a selfsigned one.\n"
3112 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3114 oldsignal = signal(SIGCHLD, SIG_DFL);
3117 if ((pid = fork()) < 0)
3118 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3122 /* in some modes, will have dropped privilege already */
3124 exim_setugid(exim_uid, exim_gid, FALSE,
3125 US"calling tls_validate_require_cipher");
3127 if ((errmsg = tls_validate_require_cipher()))
3128 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3129 "tls_require_ciphers invalid: %s", errmsg);
3131 exim_underbar_exit(0);
3135 rc = waitpid(pid, &status, 0);
3136 } while (rc < 0 && errno == EINTR);
3139 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3142 signal(SIGCHLD, oldsignal);
3146 #endif /*DISABLE_TLS*/
3151 /*************************************************
3152 * Read main configuration options *
3153 *************************************************/
3155 /* This function is the first to be called for configuration reading. It
3156 opens the configuration file and reads general configuration settings until
3157 it reaches the end of the configuration section. The file is then left open so
3158 that the remaining configuration data can subsequently be read if needed for
3161 The configuration file must be owned either by root or exim, and be writeable
3162 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3163 in the config file, so the test is done on the compiled in values. A slight
3164 anomaly, to be carefully documented.
3166 The name of the configuration file is taken from a list that is included in the
3167 binary of Exim. It can be altered from the command line, but if that is done,
3168 root privilege is immediately withdrawn unless the caller is root or exim.
3169 The first file on the list that exists is used.
3171 For use on multiple systems that share file systems, first look for a
3172 configuration file whose name has the current node name on the end. If that is
3173 not found, try the generic name. For really contorted configurations, that run
3174 multiple Exims with different uid settings, first try adding the effective uid
3175 before the node name. These complications are going to waste resources on most
3176 systems. Therefore they are available only when requested by compile-time
3180 readconf_main(BOOL nowarn)
3183 struct stat statbuf;
3184 uschar *s, *filename;
3185 const uschar *list = config_main_filelist;
3187 /* Loop through the possible file names */
3189 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3192 /* Cut out all the fancy processing unless specifically wanted */
3194 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3195 uschar *suffix = filename + Ustrlen(filename);
3197 /* Try for the node-specific file if a node name exists */
3199 #ifdef CONFIGURE_FILE_USE_NODE
3201 if (uname(&uts) >= 0)
3203 #ifdef CONFIGURE_FILE_USE_EUID
3204 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3205 config_file = Ufopen(filename, "rb");
3206 if (config_file == NULL)
3207 #endif /* CONFIGURE_FILE_USE_EUID */
3209 sprintf(CS suffix, ".%.256s", uts.nodename);
3210 config_file = Ufopen(filename, "rb");
3213 #endif /* CONFIGURE_FILE_USE_NODE */
3215 /* Otherwise, try the generic name, possibly with the euid added */
3217 #ifdef CONFIGURE_FILE_USE_EUID
3218 if (config_file == NULL)
3220 sprintf(CS suffix, ".%ld", (long int)original_euid);
3221 config_file = Ufopen(filename, "rb");
3223 #endif /* CONFIGURE_FILE_USE_EUID */
3225 /* Finally, try the unadorned name */
3227 if (config_file == NULL)
3230 config_file = Ufopen(filename, "rb");
3232 #else /* if neither defined */
3234 /* This is the common case when the fancy processing is not included. */
3236 config_file = Ufopen(filename, "rb");
3239 /* If the file does not exist, continue to try any others. For any other
3240 error, break out (and die). */
3242 if (config_file != NULL || errno != ENOENT) break;
3245 /* On success, save the name for verification; config_filename is used when
3246 logging configuration errors (it changes for .included files) whereas
3247 config_main_filename is the name shown by -bP. Failure to open a configuration
3248 file is a serious disaster. */
3252 uschar *last_slash = Ustrrchr(filename, '/');
3253 config_filename = config_main_filename = string_copy(filename);
3255 /* The config_main_directory we need for the $config_dir expansion.
3256 config_main_filename we need for $config_file expansion.
3257 And config_dir is the directory of the current configuration, used for
3258 relative .includes. We do need to know it's name, as we change our working
3261 if (filename[0] == '/')
3262 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3265 /* relative configuration file name: working dir + / + basename(filename) */
3267 uschar buf[PATH_MAX];
3270 if (os_getcwd(buf, PATH_MAX) == NULL)
3272 perror("exim: getcwd");
3275 g = string_cat(NULL, buf);
3277 /* If the dir does not end with a "/", append one */
3278 if (g->s[g->ptr-1] != '/')
3279 g = string_catn(g, US"/", 1);
3281 /* If the config file contains a "/", extract the directory part */
3283 g = string_catn(g, filename, last_slash - filename);
3285 config_main_directory = string_from_gstring(g);
3287 config_directory = config_main_directory;
3291 if (filename == NULL)
3292 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3293 "%s", config_main_filelist);
3295 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3296 "configuration file %s", filename));
3299 /* Now, once we found and opened our configuration file, we change the directory
3300 to a safe place. Later we change to $spool_directory. */
3302 if (Uchdir("/") < 0)
3304 perror("exim: chdir `/': ");
3308 /* Check the status of the file we have opened, if we have retained root
3309 privileges and the file isn't /dev/null (which *should* be 0666). */
3311 if (f.trusted_config && Ustrcmp(filename, US"/dev/null"))
3313 if (fstat(fileno(config_file), &statbuf) != 0)
3314 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3317 if ((statbuf.st_uid != root_uid /* owner not root */
3318 #ifdef CONFIGURE_OWNER
3319 && statbuf.st_uid != config_uid /* owner not the special one */
3322 (statbuf.st_gid != root_gid /* group not root & */
3323 #ifdef CONFIGURE_GROUP
3324 && statbuf.st_gid != config_gid /* group not the special one */
3326 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3328 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3330 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3331 "wrong owner, group, or mode", big_buffer);
3333 /* Do a dummy store-allocation of a size related to the (toplevel) file size.
3334 This assumes we will need this much storage to handle all the allocations
3335 during startup; it won't help when .include is being used. When it does, it
3336 will cut down on the number of store blocks (and malloc calls, and sbrk
3337 syscalls). It also assume we're on the relevant pool. */
3339 if (statbuf.st_size > 8192)
3341 rmark r = store_mark();
3342 void * dummy = store_get((int)statbuf.st_size, FALSE);
3347 /* Process the main configuration settings. They all begin with a lower case
3348 letter. If we see something starting with an upper case letter, it is taken as
3349 a macro definition. */
3351 while ((s = get_config_line()))
3353 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3354 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3355 "found unexpected BOM (Byte Order Mark)");
3358 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3360 else if (Ustrncmp(s, "domainlist", 10) == 0)
3361 read_named_list(&domainlist_anchor, &domainlist_count,
3362 MAX_NAMED_LIST, s+10, US"domain list");
3364 else if (Ustrncmp(s, "hostlist", 8) == 0)
3365 read_named_list(&hostlist_anchor, &hostlist_count,
3366 MAX_NAMED_LIST, s+8, US"host list");
3368 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3369 read_named_list(&addresslist_anchor, &addresslist_count,
3370 MAX_NAMED_LIST, s+11, US"address list");
3372 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3373 read_named_list(&localpartlist_anchor, &localpartlist_count,
3374 MAX_NAMED_LIST, s+13, US"local part list");
3377 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3378 NULL, US"main option \"%s\" unknown");
3382 /* If local_sender_retain is set, local_from_check must be unset. */
3384 if (local_sender_retain && local_from_check)
3385 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3386 "local_sender_retain are set; this combination is not allowed");
3388 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3391 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3393 /* The max retry interval must not be greater than 24 hours. */
3395 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3397 /* remote_max_parallel must be > 0 */
3399 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3401 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3402 start of a new SMTP message. */
3404 freeze_tell_config = freeze_tell;
3406 /* The primary host name may be required for expansion of spool_directory
3407 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3408 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3409 canonize it. Some people like upper case letters in their host names, so we
3410 don't force the case. */
3412 if (primary_hostname == NULL)
3414 const uschar *hostname;
3416 if (uname(&uts) < 0)
3417 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3418 hostname = US uts.nodename;
3420 if (Ustrchr(hostname, '.') == NULL)
3423 struct hostent *hostdata;
3426 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3427 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3428 MCL_DOMAIN, TRUE, NULL) != OK))
3437 #if HAVE_GETIPNODEBYNAME
3439 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3441 hostdata = gethostbyname2(CS hostname, af);
3444 hostdata = gethostbyname(CS hostname);
3447 if (hostdata != NULL)
3449 hostname = US hostdata->h_name;
3453 if (af == AF_INET) break;
3458 primary_hostname = string_copy(hostname);
3461 /* Set up default value for smtp_active_hostname */
3463 smtp_active_hostname = primary_hostname;
3465 /* If spool_directory wasn't set in the build-time configuration, it must have
3466 got set above. Of course, writing to the log may not work if log_file_path is
3467 not set, but it will at least get to syslog or somewhere, with any luck. */
3469 if (!*spool_directory)
3470 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3473 /* Expand the spool directory name; it may, for example, contain the primary
3474 host name. Same comment about failure. */
3476 if (!(s = expand_string(spool_directory)))
3477 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3478 "\"%s\": %s", spool_directory, expand_string_message);
3479 spool_directory = s;
3481 /* Expand log_file_path, which must contain "%s" in any component that isn't
3482 the null string or "syslog". It is also allowed to contain one instance of %D
3483 or %M. However, it must NOT contain % followed by anything else. */
3487 const uschar *ss, *sss;
3488 int sep = ':'; /* Fixed for log file path */
3489 if (!(s = expand_string(log_file_path)))
3490 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3491 "\"%s\": %s", log_file_path, expand_string_message);
3494 while ((sss = string_nextinlist(&ss, &sep, big_buffer, big_buffer_size)))
3497 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3498 if (!(t = Ustrstr(sss, "%s")))
3499 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3500 "contain \"%%s\"", sss);
3502 if ((t = Ustrchr(sss, '%')))
3503 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3504 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3505 "unexpected \"%%\" character", s);
3511 /* Interpret syslog_facility into an integer argument for 'ident' param to
3512 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3515 if (syslog_facility_str)
3518 uschar *s = syslog_facility_str;
3520 if ((Ustrlen(syslog_facility_str) >= 4) &&
3521 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3524 for (i = 0; i < syslog_list_size; i++)
3525 if (strcmpic(s, syslog_list[i].name) == 0)
3527 syslog_facility = syslog_list[i].value;
3531 if (i >= syslog_list_size)
3532 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3533 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3536 /* Expand pid_file_path */
3538 if (*pid_file_path != 0)
3540 if (!(s = expand_string(pid_file_path)))
3541 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3542 "\"%s\": %s", pid_file_path, expand_string_message);
3546 /* Set default value of process_log_path */
3548 if (!process_log_path || *process_log_path =='\0')
3549 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3551 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3554 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3556 /* Unpick the SMTP rate limiting options, if set */
3558 if (smtp_ratelimit_mail)
3559 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3560 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3562 if (smtp_ratelimit_rcpt)
3563 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3564 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3566 /* The qualify domains default to the primary host name */
3568 if (!qualify_domain_sender)
3569 qualify_domain_sender = primary_hostname;
3570 if (!qualify_domain_recipient)
3571 qualify_domain_recipient = qualify_domain_sender;
3573 /* Setting system_filter_user in the configuration sets the gid as well if a
3574 name is given, but a numerical value does not. */
3576 if (system_filter_uid_set && !system_filter_gid_set)
3578 struct passwd *pw = getpwuid(system_filter_uid);
3580 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3581 (long int)system_filter_uid);
3582 system_filter_gid = pw->pw_gid;
3583 system_filter_gid_set = TRUE;
3586 /* If the errors_reply_to field is set, check that it is syntactically valid
3587 and ensure it contains a domain. */
3589 if (errors_reply_to)
3592 int start, end, domain;
3593 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3594 &start, &end, &domain, FALSE);
3597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3598 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3601 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3602 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3605 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3606 smtp_accept_max must also be set. */
3608 if (smtp_accept_max == 0 &&
3609 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3610 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3611 "smtp_accept_max must be set if smtp_accept_queue or "
3612 "smtp_accept_max_per_host is set");
3614 /* Set up the host number if anything is specified. It is an expanded string
3615 so that it can be computed from the host name, for example. We do this last
3616 so as to ensure that everything else is set up before the expansion. */
3618 if (host_number_string)
3622 uschar *s = expand_string(host_number_string);
3625 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3626 "failed to expand localhost_number \"%s\": %s",
3627 host_number_string, expand_string_message);
3628 n = Ustrtol(s, &end, 0);
3629 while (isspace(*end)) end++;
3631 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3632 "localhost_number value is not a number: %s", s);
3633 if (n > LOCALHOST_MAX)
3634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3635 "localhost_number is greater than the maximum allowed value (%d)",
3641 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3643 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3645 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3646 tls_verify_hosts ? "" : "try_");
3648 /* This also checks that the library linkage is working and we can call
3649 routines in it, so call even if tls_require_ciphers is unset */
3650 if (!tls_dropprivs_validate_require_cipher(nowarn))
3653 /* Magic number: at time of writing, 1024 has been the long-standing value
3654 used by so many clients, and what Exim used to use always, that it makes
3655 sense to just min-clamp this max-clamp at that. */
3656 if (tls_dh_max_bits < 1024)
3657 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3658 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3660 /* If openssl_options is set, validate it */
3661 if (openssl_options)
3664 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3665 "openssl_options is set but we're using GnuTLS");
3668 if (!tls_openssl_options_parse(openssl_options, &dummy))
3669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3670 "openssl_options parse error: %s", openssl_options);
3673 #endif /*DISABLE_TLS*/
3675 if (!nowarn && !keep_environment && environ && *environ)
3676 log_write(0, LOG_MAIN,
3677 "Warning: purging the environment.\n"
3678 " Suggested action: use keep_environment.");
3683 /*************************************************
3684 * Initialize one driver *
3685 *************************************************/
3687 /* This is called once the driver's generic options, if any, have been read.
3688 We can now find the driver, set up defaults for the private options, and
3689 unset any "set" bits in the private options table (which might have been
3690 set by another incarnation of the same driver).
3693 d pointer to driver instance block, with generic
3695 drivers_available vector of available drivers
3696 size_of_info size of each block in drivers_available
3697 class class of driver, for error message
3699 Returns: pointer to the driver info block
3702 static driver_info *
3703 init_driver(driver_instance *d, driver_info *drivers_available,
3704 int size_of_info, uschar *class)
3706 for (driver_info * dd = drivers_available; dd->driver_name[0] != 0;
3707 dd = (driver_info *)((US dd) + size_of_info))
3708 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3710 int len = dd->options_len;
3712 d->options_block = store_get(len, FALSE);
3713 memcpy(d->options_block, dd->options_block, len);
3714 for (int i = 0; i < *(dd->options_count); i++)
3715 dd->options[i].type &= ~opt_set;
3719 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3720 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3722 return NULL; /* never obeyed */
3728 /*************************************************
3729 * Initialize driver list *
3730 *************************************************/
3732 /* This function is called for routers, transports, and authentication
3733 mechanisms. It reads the data from the current point in the configuration file
3734 up to the end of the section, and sets up a chain of instance blocks according
3735 to the file's contents. The file will already have been opened by a call to
3736 readconf_main, and must be left open for subsequent reading of further data.
3738 Any errors cause a panic crash. Note that the blocks with names driver_info and
3739 driver_instance must map the first portions of all the _info and _instance
3740 blocks for this shared code to work.
3743 class "router", "transport", or "authenticator"
3744 anchor &routers, &transports, &auths
3745 drivers_available available drivers
3746 size_of_info size of each info block
3747 instance_default points to default data for an instance
3748 instance_size size of instance block
3749 driver_optionlist generic option list
3750 driver_optionlist_count count of generic option list
3756 readconf_driver_init(
3758 driver_instance **anchor,
3759 driver_info *drivers_available,
3761 void *instance_default,
3763 optionlist *driver_optionlist,
3764 int driver_optionlist_count)
3766 driver_instance **p = anchor;
3767 driver_instance *d = NULL;
3770 while ((buffer = get_config_line()) != NULL)
3775 /* Read the first name on the line and test for the start of a new driver. A
3776 macro definition indicates the end of the previous driver. If this isn't the
3777 start of a new driver, the line will be re-read. */
3779 s = readconf_readname(name, sizeof(name), buffer);
3781 /* Handle macro definition, first finishing off the initialization of the
3782 previous driver, if any. */
3784 if (isupper(*name) && *s == '=')
3788 if (!d->driver_name)
3789 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3790 "no driver defined for %s \"%s\"", class, d->name);
3794 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3798 /* If the line starts with a name terminated by a colon, we are at the
3799 start of the definition of a new driver. The rest of the line must be
3804 /* Finish off initializing the previous driver. */
3808 if (!d->driver_name)
3809 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3810 "no driver defined for %s \"%s\"", class, d->name);
3814 /* Check that we haven't already got a driver of this name */
3816 for (d = *anchor; d; d = d->next)
3817 if (Ustrcmp(name, d->name) == 0)
3818 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3819 "there are two %ss called \"%s\"", class, name);
3821 /* Set up a new driver instance data block on the chain, with
3822 its default values installed. */
3824 d = store_get(instance_size, FALSE);
3825 memcpy(d, instance_default, instance_size);
3828 d->name = string_copy(name);
3830 /* Clear out the "set" bits in the generic options */
3832 for (int i = 0; i < driver_optionlist_count; i++)
3833 driver_optionlist[i].type &= ~opt_set;
3835 /* Check nothing more on this line, then do the next loop iteration. */
3837 while (isspace(*s)) s++;
3838 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3842 /* Not the start of a new driver. Give an error if we have not set up a
3843 current driver yet. */
3846 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3848 /* First look to see if this is a generic option; if it is "driver",
3849 initialize the driver. If is it not a generic option, we can look for a
3850 private option provided that the driver has been previously set up. */
3852 if (readconf_handle_option(buffer, driver_optionlist,
3853 driver_optionlist_count, d, NULL))
3855 if (!d->info && d->driver_name)
3856 init_driver(d, drivers_available, size_of_info, class);
3859 /* Handle private options - pass the generic block because some may
3860 live therein. A flag with each option indicates if it is in the public
3864 readconf_handle_option(buffer, d->info->options,
3865 *(d->info->options_count), d, US"option \"%s\" unknown");
3867 /* The option is not generic and the driver name has not yet been given. */
3869 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3870 "(\"driver\" must be specified before any private options)", name);
3873 /* Run the initialization function for the final driver. */
3877 if (!d->driver_name)
3878 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3879 "no driver defined for %s \"%s\"", class, d->name);
3886 /*************************************************
3887 * Check driver dependency *
3888 *************************************************/
3890 /* This function is passed a driver instance and a string. It checks whether
3891 any of the string options for the driver contains the given string as an
3895 d points to a driver instance block
3896 s the string to search for
3898 Returns: TRUE if a dependency is found
3902 readconf_depends(driver_instance *d, uschar *s)
3904 int count = *(d->info->options_count);
3907 for (optionlist * ol = d->info->options; ol < d->info->options + count; ol++)
3909 void *options_block;
3911 int type = ol->type & opt_mask;
3912 if (type != opt_stringptr) continue;
3913 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3914 value = *(uschar **)(US options_block + (long int)(ol->value));
3915 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3917 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3918 isalnum(ss[Ustrlen(s)])) continue;
3919 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3920 d->name, ol->name, s);
3925 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3932 /*************************************************
3933 * Decode an error type for retries *
3934 *************************************************/
3936 /* This function is global because it is also called from the main
3937 program when testing retry information. It decodes strings such as "quota_7d"
3938 into numerical error codes.
3941 pp points to start of text
3942 p points past end of text
3943 basic_errno points to an int to receive the main error number
3944 more_errno points to an int to receive the secondary error data
3946 Returns: NULL if decoded correctly; else points to error text
3950 readconf_retry_error(const uschar *pp, const uschar *p,
3951 int *basic_errno, int *more_errno)
3954 const uschar *q = pp;
3955 while (q < p && *q != '_') q++;
3958 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3960 *basic_errno = ERRNO_EXIMQUOTA;
3961 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3962 return US"bad time value";
3965 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3967 *basic_errno = ECONNREFUSED;
3970 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3971 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3972 else return US"A or MX expected after \"refused\"";
3976 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3978 *basic_errno = ETIMEDOUT;
3982 int xlen = p - q - 1;
3983 const uschar *x = q + 1;
3985 static uschar *extras[] =
3986 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3987 static int values[] =
3988 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3990 for (i = 0; i < nelem(extras); i++)
3991 if (strncmpic(x, extras[i], xlen) == 0)
3993 *more_errno = values[i];
3997 if (i >= nelem(extras))
3998 if (strncmpic(x, US"DNS", xlen) == 0)
3999 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4000 "available in retry rules (it has never worked) - treated as "
4003 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4007 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4008 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4009 strncmpic(pp, US"data_4", 6) == 0)
4012 int x = 255; /* means "any 4xx code" */
4013 if (p != pp + 8) bad = TRUE; else
4015 int a = pp[6], b = pp[7];
4019 if (isdigit(b)) x += b - '0';
4020 else if (b == 'x') x += 100;
4023 else if (a != 'x' || b != 'x') bad = TRUE;
4027 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4028 "x is literal and d is any digit", pp);
4030 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4031 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4032 *more_errno = x << 8;
4035 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4036 strncmpic(q+1, US"failed", p-q-1) == 0)
4037 *basic_errno = ERRNO_AUTHFAIL;
4039 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4040 *basic_errno = ERRNO_SMTPCLOSED;
4042 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4043 *basic_errno = ERRNO_TLSREQUIRED;
4045 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4046 *basic_errno = ERRNO_UNKNOWNHOST;
4048 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4049 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4057 /*************************************************
4058 * Read retry information *
4059 *************************************************/
4061 /* Each line of retry information contains:
4063 . A domain name pattern or an address pattern;
4065 . An error name, possibly with additional data, or *;
4067 . An optional sequence of retry items, each consisting of an identifying
4068 letter, a cutoff time, and optional parameters.
4070 All this is decoded and placed into a control block. */
4073 /* Subroutine to read an argument, preceded by a comma and terminated
4074 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4075 1 = fixed point number (returned *1000).
4078 paddr pointer to pointer to current character; updated
4079 type 0 => read a time; 1 => read a fixed point number
4081 Returns: time in seconds or fixed point number * 1000
4085 retry_arg(const uschar **paddr, int type)
4087 const uschar *p = *paddr;
4090 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4092 while (isspace(*p)) p++;
4094 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4096 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4102 case 0: return readconf_readtime(pp, *p, FALSE);
4103 case 1: return readconf_readfixed(pp, *p);
4105 return 0; /* Keep picky compilers happy */
4108 /* The function proper */
4111 readconf_retries(void)
4113 retry_config **chain = &retries;
4117 while ((p = get_config_line()))
4119 retry_rule **rchain;
4123 next = store_get(sizeof(retry_config), FALSE);
4126 chain = &(next->next);
4127 next->basic_errno = next->more_errno = 0;
4128 next->senders = NULL;
4130 rchain = &(next->rules);
4132 next->pattern = string_dequote(&p);
4133 while (isspace(*p)) p++;
4135 while (mac_isgraph(*p)) p++;
4136 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4137 "missing error type in retry rule");
4139 /* Test error names for things we understand. */
4141 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4142 &next->more_errno)))
4143 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4145 /* There may be an optional address list of senders to be used as another
4146 constraint on the rule. This was added later, so the syntax is a bit of a
4147 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4150 while (isspace(*p)) p++;
4151 if (Ustrncmp(p, "senders", 7) == 0)
4154 while (isspace(*p)) p++;
4155 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4156 "\"=\" expected after \"senders\" in retry rule");
4157 while (isspace(*p)) p++;
4158 next->senders = string_dequote(&p);
4161 /* Now the retry rules. Keep the maximum timeout encountered. */
4163 while (isspace(*p)) p++;
4167 retry_rule *rule = store_get(sizeof(retry_rule), FALSE);
4169 rchain = &(rule->next);
4171 rule->rule = toupper(*p++);
4172 rule->timeout = retry_arg(&p, 0);
4173 if (rule->timeout > retry_maximum_timeout)
4174 retry_maximum_timeout = rule->timeout;
4178 case 'F': /* Fixed interval */
4179 rule->p1 = retry_arg(&p, 0);
4182 case 'G': /* Geometrically increasing intervals */
4183 case 'H': /* Ditto, but with randomness */
4184 rule->p1 = retry_arg(&p, 0);
4185 rule->p2 = retry_arg(&p, 1);
4189 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4193 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4194 (rule->rule != 'F' && rule->p2 < 1000))
4195 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4196 "bad parameters for retry rule");
4198 while (isspace(*p)) p++;
4202 while (isspace(*p)) p++;
4205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4212 /*************************************************
4213 * Initialize authenticators *
4214 *************************************************/
4216 /* Read the authenticators section of the configuration file.
4225 #ifdef SUPPORT_PIPE_CONNECT
4229 readconf_driver_init(US"authenticator",
4230 (driver_instance **)(&auths), /* chain anchor */
4231 (driver_info *)auths_available, /* available drivers */
4232 sizeof(auth_info), /* size of info block */
4233 &auth_defaults, /* default values for generic options */
4234 sizeof(auth_instance), /* size of instance block */
4235 optionlist_auths, /* generic options */
4236 optionlist_auths_size);
4238 for (auth_instance * au = auths; au; au = au->next)
4240 if (!au->public_name)
4241 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4242 "the %s authenticator", au->name);
4244 for (auth_instance * bu = au->next; bu; bu = bu->next)
4245 if (strcmpic(au->public_name, bu->public_name) == 0)
4246 if ((au->client && bu->client) || (au->server && bu->server))
4247 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4248 "(%s and %s) have the same public name (%s)",
4249 au->client ? US"client" : US"server", au->name, bu->name,
4251 #ifdef SUPPORT_PIPE_CONNECT
4255 #ifdef SUPPORT_PIPE_CONNECT
4256 f.smtp_in_early_pipe_no_auth = nauths > 16;
4263 /*************************************************
4264 * Read ACL information *
4265 *************************************************/
4267 /* If this run of Exim is not doing something that involves receiving a
4268 message, we can just skip over the ACL information. No need to parse it.
4270 First, we have a function for acl_read() to call back to get the next line. We
4271 need to remember the line we passed, because at the end it will contain the
4272 name of the next ACL. */
4274 static uschar *acl_line;
4279 acl_line = get_config_line();
4284 /* Now the main function:
4295 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4298 acl_line = get_config_line();
4306 p = readconf_readname(name, sizeof(name), acl_line);
4307 if (isupper(*name) && *p == '=')
4309 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4310 acl_line = get_config_line();
4314 if (*p != ':' || name[0] == 0)
4315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4317 node = store_get(sizeof(tree_node) + Ustrlen(name), is_tainted(name));
4318 Ustrcpy(node->name, name);
4319 if (!tree_insertnode(&acl_anchor, node))
4320 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4321 "there are two ACLs called \"%s\"", name);
4323 node->data.ptr = acl_read(acl_callback, &error);
4325 if (node->data.ptr == NULL && error != NULL)
4326 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4332 /*************************************************
4333 * Read configuration for local_scan() *
4334 *************************************************/
4336 /* This function is called after "begin local_scan" is encountered in the
4337 configuration file. If the local_scan() function allows for configuration
4338 options, we can process them. Otherwise, we expire in a panic.
4345 local_scan_init(void)
4347 #ifndef LOCAL_SCAN_HAS_OPTIONS
4348 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4349 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4353 while ((p = get_config_line()))
4355 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4356 NULL, US"local_scan option \"%s\" unknown");
4363 /*************************************************
4364 * Read rest of configuration (after main) *
4365 *************************************************/
4367 /* This function reads the rest of the runtime configuration, after the main
4368 configuration. It is called only when actually needed. Each subsequent section
4369 of the configuration starts with a line of the form
4373 where the name is "routers", "transports", etc. A section is terminated by
4374 hitting the next "begin" line, and the next name is left in next_section.
4375 Because it may confuse people as to whether the names are singular or plural,
4376 we add "s" if it's missing. There is always enough room in next_section for
4377 this. This function is basically just a switch.
4383 static uschar *section_list[] = {
4397 while(next_section[0] != 0)
4401 int last = nelem(section_list);
4403 int n = Ustrlen(next_section);
4405 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, US"s");
4409 int c = strcmpic(next_section, section_list[mid]);
4411 if (c > 0) first = mid + 1; else last = mid;
4413 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4414 "\"%.*s\" is not a known configuration section name", n, next_section);
4415 mid = (last + first)/2;
4419 if (((had ^= bit) & bit) == 0)
4420 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4421 "\"%.*s\" section is repeated in the configuration file", n,
4426 case 0: readconf_acl(); break;
4427 case 1: auths_init(); break;
4428 case 2: local_scan_init(); break;
4429 case 3: readconf_retries(); break;
4430 case 4: readconf_rewrites(); break;
4431 case 5: route_init(); break;
4432 case 6: transport_init(); break;
4436 (void)fclose(config_file);
4439 /* Init the storage for the pre-parsed config lines */
4441 readconf_save_config(const uschar *s)
4443 save_config_line(string_sprintf("# Exim Configuration (%s)",
4444 f.running_in_test_harness ? US"X" : s));
4448 save_config_position(const uschar *file, int line)
4450 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4453 /* Append a pre-parsed logical line to the config lines store,
4454 this operates on a global (static) list that holds all the pre-parsed
4455 config lines, we do no further processing here, output formatting and
4456 honouring of <hide> or macros will be done during output */
4459 save_config_line(const uschar* line)
4461 static config_line_item *current;
4462 config_line_item *next;
4464 next = (config_line_item*) store_get(sizeof(config_line_item), FALSE);
4465 next->line = string_copy(line);
4468 if (!config_lines) config_lines = next;
4469 else current->next = next;
4474 /* List the parsed config lines, care about nice formatting and
4475 hide the <hide> values unless we're the admin user */
4477 print_config(BOOL admin, BOOL terse)
4479 const int TS = terse ? 0 : 2;
4482 for (config_line_item * i = config_lines; i; i = i->next)
4487 /* skip over to the first non-space */
4488 for (current = i->line; *current && isspace(*current); ++current)
4491 if (*current == '\0')
4494 /* Collapse runs of spaces. We stop this if we encounter one of the
4495 * following characters: "'$, as this may indicate careful formatting */
4496 for (p = current; *p; ++p)
4499 if (!isspace(*p)) continue;
4500 if (*p != ' ') *p = ' ';
4502 for (next = p; isspace(*next); ++next)
4506 memmove(p+1, next, Ustrlen(next)+1);
4508 if (*next == '"' || *next == '\'' || *next == '$')
4513 if (current[0] == '#')
4516 /* begin lines are left aligned */
4517 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4519 if (!terse) puts("");
4524 /* router/acl/transport block names */
4525 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4527 if (!terse) puts("");
4528 printf("%*s%s\n", TS, "", current);
4532 /* hidden lines (all MACROS or lines prefixed with "hide") */
4534 && ( isupper(*current)
4535 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4539 if ((p = Ustrchr(current, '=')))
4542 printf("%*s%s= %s\n", indent, "", current, hidden);
4544 /* e.g.: hide split_spool_directory */
4546 printf("%*s\n", indent, hidden);
4550 /* rest is public */
4551 printf("%*s%s\n", indent, "", current);
4555 #endif /*!MACRO_PREDEF*/
4558 /* End of readconf.c */