1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2017 */
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 static uschar * syslog_facility_str;
19 static void fn_smtp_receive_timeout(const uschar *, const uschar *);
21 /*************************************************
22 * Main configuration options *
23 *************************************************/
25 /* The list of options that can be set in the main configuration file. This
26 must be in alphabetic order because it is searched by binary chop. */
28 static optionlist optionlist_config[] = {
29 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
30 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
31 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
32 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
33 { "accept_8bitmime", opt_bool, &accept_8bitmime },
34 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
35 #ifdef WITH_CONTENT_SCAN
36 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
38 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
39 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
40 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
41 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
43 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
46 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
48 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
49 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
50 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
51 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
52 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
53 #ifdef WITH_CONTENT_SCAN
54 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
56 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
57 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
58 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
59 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
61 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
63 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
64 { "add_environment", opt_stringptr, &add_environment },
65 { "admin_groups", opt_gidlist, &admin_groups },
66 { "allow_domain_literals", opt_bool, &allow_domain_literals },
67 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
68 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
69 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
70 { "auto_thaw", opt_time, &auto_thaw },
71 #ifdef WITH_CONTENT_SCAN
72 { "av_scanner", opt_stringptr, &av_scanner },
74 { "bi_command", opt_stringptr, &bi_command },
75 #ifdef EXPERIMENTAL_BRIGHTMAIL
76 { "bmi_config_file", opt_stringptr, &bmi_config_file },
78 { "bounce_message_file", opt_stringptr, &bounce_message_file },
79 { "bounce_message_text", opt_stringptr, &bounce_message_text },
80 { "bounce_return_body", opt_bool, &bounce_return_body },
81 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
82 { "bounce_return_message", opt_bool, &bounce_return_message },
83 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
84 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
85 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
86 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
87 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
88 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
89 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
90 { "check_log_inodes", opt_int, &check_log_inodes },
91 { "check_log_space", opt_Kint, &check_log_space },
92 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
93 { "check_spool_inodes", opt_int, &check_spool_inodes },
94 { "check_spool_space", opt_Kint, &check_spool_space },
95 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
96 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
97 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
98 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
99 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
100 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
101 #ifdef EXPERIMENTAL_DCC
102 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
103 { "dccifd_address", opt_stringptr, &dccifd_address },
104 { "dccifd_options", opt_stringptr, &dccifd_options },
106 { "debug_store", opt_bool, &debug_store },
107 { "delay_warning", opt_timelist, &delay_warning },
108 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
109 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
110 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
111 { "delivery_date_remove", opt_bool, &delivery_date_remove },
112 #ifdef ENABLE_DISABLE_FSYNC
113 { "disable_fsync", opt_bool, &disable_fsync },
115 { "disable_ipv6", opt_bool, &disable_ipv6 },
117 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
119 #ifdef EXPERIMENTAL_DMARC
120 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
121 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
122 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
124 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
125 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
126 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
127 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
128 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
129 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
130 { "dns_retrans", opt_time, &dns_retrans },
131 { "dns_retry", opt_int, &dns_retry },
132 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
133 { "dns_use_edns0", opt_int, &dns_use_edns0 },
134 /* This option is now a no-op, retained for compatibility */
135 { "drop_cr", opt_bool, &drop_cr },
136 /*********************************************************/
137 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
138 { "dsn_from", opt_stringptr, &dsn_from },
139 { "envelope_to_remove", opt_bool, &envelope_to_remove },
140 { "errors_copy", opt_stringptr, &errors_copy },
141 { "errors_reply_to", opt_stringptr, &errors_reply_to },
142 #ifndef DISABLE_EVENT
143 { "event_action", opt_stringptr, &event_action },
145 { "exim_group", opt_gid, &exim_gid },
146 { "exim_path", opt_stringptr, &exim_path },
147 { "exim_user", opt_uid, &exim_uid },
148 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
149 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
150 { "finduser_retries", opt_int, &finduser_retries },
151 { "freeze_tell", opt_stringptr, &freeze_tell },
152 { "gecos_name", opt_stringptr, &gecos_name },
153 { "gecos_pattern", opt_stringptr, &gecos_pattern },
155 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
156 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
158 { "header_line_maxsize", opt_int, &header_line_maxsize },
159 { "header_maxsize", opt_int, &header_maxsize },
160 { "headers_charset", opt_stringptr, &headers_charset },
161 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
162 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
163 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
164 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
165 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
166 { "hold_domains", opt_stringptr, &hold_domains },
167 { "host_lookup", opt_stringptr, &host_lookup },
168 { "host_lookup_order", opt_stringptr, &host_lookup_order },
169 { "host_reject_connection", opt_stringptr, &host_reject_connection },
170 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
172 { "hosts_proxy", opt_stringptr, &hosts_proxy },
174 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
176 { "ibase_servers", opt_stringptr, &ibase_servers },
178 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
179 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
180 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
181 { "keep_environment", opt_stringptr, &keep_environment },
182 { "keep_malformed", opt_time, &keep_malformed },
184 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
185 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
186 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
187 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
188 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
189 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
190 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
191 { "ldap_start_tls", opt_bool, &eldap_start_tls },
192 { "ldap_version", opt_int, &eldap_version },
194 { "local_from_check", opt_bool, &local_from_check },
195 { "local_from_prefix", opt_stringptr, &local_from_prefix },
196 { "local_from_suffix", opt_stringptr, &local_from_suffix },
197 { "local_interfaces", opt_stringptr, &local_interfaces },
198 { "local_scan_timeout", opt_time, &local_scan_timeout },
199 { "local_sender_retain", opt_bool, &local_sender_retain },
200 { "localhost_number", opt_stringptr, &host_number_string },
201 { "log_file_path", opt_stringptr, &log_file_path },
202 { "log_selector", opt_stringptr, &log_selector_string },
203 { "log_timezone", opt_bool, &log_timezone },
204 { "lookup_open_max", opt_int, &lookup_open_max },
205 { "max_username_length", opt_int, &max_username_length },
206 { "message_body_newlines", opt_bool, &message_body_newlines },
207 { "message_body_visible", opt_mkint, &message_body_visible },
208 { "message_id_header_domain", opt_stringptr, &message_id_domain },
209 { "message_id_header_text", opt_stringptr, &message_id_text },
210 { "message_logs", opt_bool, &message_logs },
211 { "message_size_limit", opt_stringptr, &message_size_limit },
212 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
213 { "move_frozen_messages", opt_bool, &move_frozen_messages },
215 { "mua_wrapper", opt_bool, &mua_wrapper },
217 { "mysql_servers", opt_stringptr, &mysql_servers },
219 { "never_users", opt_uidlist, &never_users },
221 { "openssl_options", opt_stringptr, &openssl_options },
224 { "oracle_servers", opt_stringptr, &oracle_servers },
226 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
228 { "perl_at_start", opt_bool, &opt_perl_at_start },
229 { "perl_startup", opt_stringptr, &opt_perl_startup },
230 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
233 { "pgsql_servers", opt_stringptr, &pgsql_servers },
235 { "pid_file_path", opt_stringptr, &pid_file_path },
236 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
238 { "prdr_enable", opt_bool, &prdr_enable },
240 { "preserve_message_logs", opt_bool, &preserve_message_logs },
241 { "primary_hostname", opt_stringptr, &primary_hostname },
242 { "print_topbitchars", opt_bool, &print_topbitchars },
243 { "process_log_path", opt_stringptr, &process_log_path },
244 { "prod_requires_admin", opt_bool, &prod_requires_admin },
245 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
246 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
247 { "queue_domains", opt_stringptr, &queue_domains },
248 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
249 { "queue_only", opt_bool, &queue_only },
250 { "queue_only_file", opt_stringptr, &queue_only_file },
251 { "queue_only_load", opt_fixed, &queue_only_load },
252 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
253 { "queue_only_override", opt_bool, &queue_only_override },
254 { "queue_run_in_order", opt_bool, &queue_run_in_order },
255 { "queue_run_max", opt_stringptr, &queue_run_max },
256 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
257 { "receive_timeout", opt_time, &receive_timeout },
258 { "received_header_text", opt_stringptr, &received_header_text },
259 { "received_headers_max", opt_int, &received_headers_max },
260 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
261 { "recipients_max", opt_int, &recipients_max },
262 { "recipients_max_reject", opt_bool, &recipients_max_reject },
264 { "redis_servers", opt_stringptr, &redis_servers },
266 { "remote_max_parallel", opt_int, &remote_max_parallel },
267 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
268 { "retry_data_expire", opt_time, &retry_data_expire },
269 { "retry_interval_max", opt_time, &retry_interval_max },
270 { "return_path_remove", opt_bool, &return_path_remove },
271 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
272 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
273 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
274 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
275 { "slow_lookup_log", opt_int, &slow_lookup_log },
276 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
277 { "smtp_accept_max", opt_int, &smtp_accept_max },
278 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
279 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
280 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
281 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
282 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
283 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
284 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
285 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
286 { "smtp_banner", opt_stringptr, &smtp_banner },
287 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
288 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
289 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
290 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
291 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
292 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
293 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
294 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
295 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
296 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
297 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
298 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
299 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
300 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
302 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
304 #ifdef WITH_CONTENT_SCAN
305 { "spamd_address", opt_stringptr, &spamd_address },
308 { "spf_guess", opt_stringptr, &spf_guess },
310 { "split_spool_directory", opt_bool, &split_spool_directory },
311 { "spool_directory", opt_stringptr, &spool_directory },
312 { "spool_wireformat", opt_bool, &spool_wireformat },
314 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
316 #ifdef EXPERIMENTAL_SRS
317 { "srs_config", opt_stringptr, &srs_config },
318 { "srs_hashlength", opt_int, &srs_hashlength },
319 { "srs_hashmin", opt_int, &srs_hashmin },
320 { "srs_maxage", opt_int, &srs_maxage },
321 { "srs_secrets", opt_stringptr, &srs_secrets },
322 { "srs_usehash", opt_bool, &srs_usehash },
323 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
325 { "strict_acl_vars", opt_bool, &strict_acl_vars },
326 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
327 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
328 { "syslog_duplication", opt_bool, &syslog_duplication },
329 { "syslog_facility", opt_stringptr, &syslog_facility_str },
330 { "syslog_pid", opt_bool, &syslog_pid },
331 { "syslog_processname", opt_stringptr, &syslog_processname },
332 { "syslog_timestamp", opt_bool, &syslog_timestamp },
333 { "system_filter", opt_stringptr, &system_filter },
334 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
335 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
336 { "system_filter_group", opt_gid, &system_filter_gid },
337 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
338 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
339 { "system_filter_user", opt_uid, &system_filter_uid },
340 { "tcp_nodelay", opt_bool, &tcp_nodelay },
341 #ifdef USE_TCP_WRAPPERS
342 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
344 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
345 { "timezone", opt_stringptr, &timezone_string },
346 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
348 { "tls_certificate", opt_stringptr, &tls_certificate },
349 { "tls_crl", opt_stringptr, &tls_crl },
350 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
351 { "tls_dhparam", opt_stringptr, &tls_dhparam },
352 { "tls_eccurve", opt_stringptr, &tls_eccurve },
353 # ifndef DISABLE_OCSP
354 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
356 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
357 { "tls_privatekey", opt_stringptr, &tls_privatekey },
358 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
359 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
360 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
361 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
362 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
364 { "trusted_groups", opt_gidlist, &trusted_groups },
365 { "trusted_users", opt_uidlist, &trusted_users },
366 { "unknown_login", opt_stringptr, &unknown_login },
367 { "unknown_username", opt_stringptr, &unknown_username },
368 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
369 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
370 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
371 { "warn_message_file", opt_stringptr, &warn_message_file },
372 { "write_rejectlog", opt_bool, &write_rejectlog }
376 static int optionlist_config_size = nelem(optionlist_config);
382 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
387 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
393 struct auth_info * ai;
396 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
398 for (ai = auths_available; ai->driver_name[0]; ai++)
400 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
401 builtin_macro_create(buf);
402 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
407 #else /*!MACRO_PREDEF*/
409 extern char **environ;
411 static void save_config_line(const uschar* line);
412 static void save_config_position(const uschar *file, int line);
413 static void print_config(BOOL admin, BOOL terse);
416 #define CSTATE_STACK_SIZE 10
418 const uschar *config_directory = NULL;
421 /* Structure for chain (stack) of .included files */
423 typedef struct config_file_item {
424 struct config_file_item *next;
425 const uschar *filename;
426 const uschar *directory;
431 /* Structure for chain of configuration lines (-bP config) */
433 typedef struct config_line_item {
434 struct config_line_item *next;
438 static config_line_item* config_lines;
440 /* Structure of table of conditional words and their state transitions */
442 typedef struct cond_item {
450 /* Structure of table of syslog facility names and values */
452 typedef struct syslog_fac_item {
458 static const char * const hidden = "<value not displayable>";
460 /* Static variables */
462 static config_file_item *config_file_stack = NULL; /* For includes */
464 static uschar *syslog_facility_str = NULL;
465 static uschar next_section[24];
466 static uschar time_buffer[24];
468 /* State variables for conditional loading (.ifdef / .else / .endif) */
470 static int cstate = 0;
471 static int cstate_stack_ptr = -1;
472 static int cstate_stack[CSTATE_STACK_SIZE];
474 /* Table of state transitions for handling conditional inclusions. There are
475 four possible state transitions:
479 .elifdef true (or .else)
482 .endif just causes the previous cstate to be popped off the stack */
484 static int next_cstate[3][4] =
486 /* State 0: reading from file, or reading until next .else or .endif */
488 /* State 1: condition failed, skipping until next .else or .endif */
490 /* State 2: skipping until .endif */
494 /* Table of conditionals and the states to set. For each name, there are four
495 values: the length of the name (to save computing it each time), the state to
496 set if a macro was found in the line, the state to set if a macro was not found
497 in the line, and a stack manipulation setting which is:
499 -1 pull state value off the stack
500 0 don't alter the stack
501 +1 push value onto stack, before setting new state
504 static cond_item cond_list[] = {
505 { US"ifdef", 5, 0, 1, 1 },
506 { US"ifndef", 6, 1, 0, 1 },
507 { US"elifdef", 7, 2, 3, 0 },
508 { US"elifndef", 8, 3, 2, 0 },
509 { US"else", 4, 2, 2, 0 },
510 { US"endif", 5, 0, 0, -1 }
513 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
515 /* Table of syslog facility names and their values */
517 static syslog_fac_item syslog_list[] = {
518 { US"mail", LOG_MAIL },
519 { US"user", LOG_USER },
520 { US"news", LOG_NEWS },
521 { US"uucp", LOG_UUCP },
522 { US"local0", LOG_LOCAL0 },
523 { US"local1", LOG_LOCAL1 },
524 { US"local2", LOG_LOCAL2 },
525 { US"local3", LOG_LOCAL3 },
526 { US"local4", LOG_LOCAL4 },
527 { US"local5", LOG_LOCAL5 },
528 { US"local6", LOG_LOCAL6 },
529 { US"local7", LOG_LOCAL7 },
530 { US"daemon", LOG_DAEMON }
533 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
538 /*************************************************
539 * Find the name of an option *
540 *************************************************/
542 /* This function is to aid debugging. Various functions take arguments that are
543 pointer variables in the options table or in option tables for various drivers.
544 For debugging output, it is useful to be able to find the name of the option
545 which is currently being processed. This function finds it, if it exists, by
546 searching the table(s).
548 Arguments: a value that is presumed to be in the table above
549 Returns: the option name, or an empty string
553 readconf_find_option(void *p)
557 transport_instance *t;
559 for (i = 0; i < nelem(optionlist_config); i++)
560 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
562 for (r = routers; r; r = r->next)
564 router_info *ri = r->info;
565 for (i = 0; i < *ri->options_count; i++)
567 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
568 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
569 return US ri->options[i].name;
573 for (t = transports; t; t = t->next)
575 transport_info *ti = t->info;
576 for (i = 0; i < *ti->options_count; i++)
578 optionlist * op = &ti->options[i];
579 if ((op->type & opt_mask) != opt_stringptr) continue;
580 if (p == ( op->type & opt_public
582 : CS t->options_block
584 + (long int)op->value)
595 /* This function is called when a line that starts with an upper case letter is
596 encountered. The argument "line" should contain a complete logical line, and
597 start with the first letter of the macro name. The macro name and the
598 replacement text are extracted and stored. Redefinition of existing,
599 non-command line, macros is permitted using '==' instead of '='.
602 s points to the start of the logical line
604 Returns: FALSE iff fatal error
608 macro_read_assignment(uschar *s)
615 while (isalnum(*s) || *s == '_')
617 if (namelen >= sizeof(name) - 1)
619 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
620 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
623 name[namelen++] = *s++;
627 while (isspace(*s)) s++;
630 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
639 while (isspace(*s)) s++;
641 /* If an existing macro of the same name was defined on the command line, we
642 just skip this definition. It's an error to attempt to redefine a macro without
643 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
644 It is also an error to define a macro whose name begins with the name of a
645 previously defined macro.
646 Note: it is documented that the other way round works. */
648 if ((m = macro_search_prefix(name)))
650 if (m->namelen < namelen) /* substring match */
652 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
653 "a macro because previously defined macro \"%s\" is a substring",
654 name, m->tnode.name);
658 if (!m->command_line && !redef)
660 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
661 "defined (use \"==\" if you want to redefine it", name);
665 if (m->command_line) /* overriding cmdline definition */
669 /* Redefinition must refer to an existing macro. */
674 m->replen = Ustrlen(s);
675 m->tnode.data.ptr = string_copy(s);
679 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
684 /* We have a new definition. */
686 (void) macro_create(name, s, FALSE);
694 /* Process line for macros. The line is in big_buffer starting at offset len.
695 Expand big_buffer if needed. Handle definitions of new macros, and
696 imacro expansions, rewriting the line in thw buffer.
699 len Offset in buffer of start of line
700 newlen Pointer to offset of end of line, updated on return
701 macro_found Pointer to return that a macro was expanded
703 Return: pointer to first nonblank char in line
707 macros_expand(int len, int * newlen, BOOL * macro_found)
709 uschar * ss = big_buffer + len;
712 /* Find the true start of the physical line - leading spaces are always
715 while (isspace(*ss)) ss++;
717 /* Process the physical line for macros. If this is the start of the logical
718 line, skip over initial text at the start of the line if it starts with an
719 upper case character followed by a sequence of name characters and an equals
720 sign, because that is the definition of a new macro, and we don't do
721 replacement therein. */
724 if (len == 0 && isupper(*s))
726 while (isalnum(*s) || *s == '_') s++;
727 while (isspace(*s)) s++;
728 if (*s != '=') s = ss; /* Not a macro definition */
731 /* Scan the line (from after XXX= if present), replacing any macros. Rescan
732 after replacement for any later-defined macros. */
734 *macro_found = FALSE;
737 if (isupper(*s) || *s == '_' && isupper(s[1]))
742 while ((m = macro_search_largest_prefix(s)) && m->m_number > mnum)
747 /* Expand the buffer if necessary */
749 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
751 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
752 uschar *newbuffer = store_malloc(newsize);
753 memcpy(newbuffer, big_buffer, *newlen + 1);
754 s = newbuffer + (s - big_buffer);
755 ss = newbuffer + (ss - big_buffer);
756 big_buffer_size = newsize;
757 store_free(big_buffer);
758 big_buffer = newbuffer;
761 /* Shuffle the remaining characters up or down in the buffer before
762 copying in the replacement text. Don't rescan the replacement for this
766 if ((moveby = m->replen - m->namelen) != 0)
768 memmove(s + m->replen, pp, (big_buffer + *newlen) - pp + 1);
771 Ustrncpy(s, m->tnode.data.ptr, m->replen);
779 /* An empty macro replacement at the start of a line could mean that ss no
780 longer points to the first non-blank character. */
782 while (isspace(*ss)) ss++;
786 /*************************************************
787 * Read configuration line *
788 *************************************************/
790 /* A logical line of text is read from the configuration file into the big
791 buffer, taking account of macros, .includes, and continuations. The size of
792 big_buffer is increased if necessary. The count of configuration lines is
793 maintained. Physical input lines starting with # (ignoring leading white space,
794 and after macro replacement) and empty logical lines are always ignored.
795 Leading and trailing spaces are removed.
797 If we hit a line of the form "begin xxxx", the xxxx is placed in the
798 next_section vector, and the function returns NULL, indicating the end of a
799 configuration section. On end-of-file, NULL is returned with next_section
804 Returns: a pointer to the first non-blank in the line,
805 or NULL if eof or end of section is reached
809 get_config_line(void)
811 int startoffset = 0; /* To first non-blank char in logical line */
812 int len = 0; /* Of logical line so far */
817 /* Loop for handling continuation lines, skipping comments, and dealing with
822 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
824 if (config_file_stack != NULL) /* EOF inside .include */
826 (void)fclose(config_file);
827 config_file = config_file_stack->file;
828 config_filename = config_file_stack->filename;
829 config_directory = config_file_stack->directory;
830 config_lineno = config_file_stack->lineno;
831 config_file_stack = config_file_stack->next;
833 save_config_position(config_filename, config_lineno);
837 /* EOF at top level */
839 if (cstate_stack_ptr >= 0)
840 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
841 "Unexpected end of configuration file: .endif missing");
843 if (len != 0) break; /* EOF after continuation */
844 next_section[0] = 0; /* EOF at start of logical line */
849 newlen = len + Ustrlen(big_buffer + len);
851 if (config_lines && config_lineno == 1)
852 save_config_position(config_filename, config_lineno);
854 /* Handle pathologically long physical lines - yes, it did happen - by
855 extending big_buffer at this point. The code also copes with very long
858 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
861 big_buffer_size += BIG_BUFFER_SIZE;
862 newbuffer = store_malloc(big_buffer_size);
864 /* This use of strcpy is OK because we know that the string in the old
865 buffer is shorter than the new buffer. */
867 Ustrcpy(newbuffer, big_buffer);
868 store_free(big_buffer);
869 big_buffer = newbuffer;
870 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
872 newlen += Ustrlen(big_buffer + newlen);
875 ss = macros_expand(len, &newlen, ¯o_found);
877 /* Check for comment lines - these are physical lines. */
879 if (*ss == '#') continue;
881 /* Handle conditionals, which are also applied to physical lines. Conditions
882 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
883 expansion occured on the rest of the line. A preliminary test for the leading
884 '.' saves effort on most lines. */
890 /* Search the list of conditional directives */
892 for (i = 0; i < cond_list_size; i++)
895 cond_item *c = cond_list+i;
896 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
898 /* The following character must be white space or end of string */
900 n = ss[1 + c->namelen];
901 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
903 /* .ifdef and .ifndef push the current state onto the stack, then set
904 a new one from the table. Stack overflow is an error */
908 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
909 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
910 ".%s nested too deeply", c->name);
911 cstate_stack[++cstate_stack_ptr] = cstate;
912 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
915 /* For any of the others, stack underflow is an error. The next state
916 comes either from the stack (.endif) or from the table. */
920 if (cstate_stack_ptr < 0)
921 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
922 ".%s without matching .ifdef", c->name);
923 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
924 next_cstate[cstate][macro_found? c->action1 : c->action2];
927 /* Having dealt with a directive, break the loop */
932 /* If we have handled a conditional directive, continue with the next
933 physical line. Otherwise, fall through. */
935 if (i < cond_list_size) continue;
938 /* If the conditional state is not 0 (actively using these lines), ignore
941 if (cstate != 0) continue; /* Conditional skip */
943 /* Handle .include lines - these are also physical lines. */
945 if (Ustrncmp(ss, ".include", 8) == 0 &&
947 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
950 int include_if_exists = isspace(ss[8])? 0 : 10;
951 config_file_item *save;
954 ss += 9 + include_if_exists;
955 while (isspace(*ss)) ss++;
956 t = ss + Ustrlen(ss);
957 while (t > ss && isspace(t[-1])) t--;
958 if (*ss == '\"' && t[-1] == '\"')
965 /* We allow relative file names. For security reasons currently
966 relative names not allowed with .include_if_exists. For .include_if_exists
967 we need to check the permissions/ownership of the containing folder */
969 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
970 "absolute path \"%s\"", ss);
973 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
974 ss = string_from_gstring(g);
977 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
980 save_config_position(config_filename, config_lineno);
981 save = store_get(sizeof(config_file_item));
982 save->next = config_file_stack;
983 config_file_stack = save;
984 save->file = config_file;
985 save->filename = config_filename;
986 save->directory = config_directory;
987 save->lineno = config_lineno;
989 if (!(config_file = Ufopen(ss, "rb")))
990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
991 "configuration file %s", ss);
993 config_filename = string_copy(ss);
994 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
999 /* If this is the start of the logical line, remember where the non-blank
1000 data starts. Otherwise shuffle down continuation lines to remove leading
1004 startoffset = ss - big_buffer;
1007 s = big_buffer + len;
1010 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1015 /* Accept the new addition to the line. Remove trailing white space. */
1018 while (len > 0 && isspace(big_buffer[len-1])) len--;
1019 big_buffer[len] = 0;
1021 /* We are done if the line does not end in backslash and contains some data.
1022 Empty logical lines are ignored. For continuations, remove the backslash and
1023 go round the loop to read the continuation line. */
1027 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1028 big_buffer[--len] = 0; /* Remove backslash */
1030 } /* Loop for reading multiple physical lines */
1032 /* We now have a logical line. Test for the end of a configuration section (or,
1033 more accurately, for the start of the next section). Place the name of the next
1034 section in next_section, and return NULL. If the name given is longer than
1035 next_section, truncate it. It will be unrecognized later, because all the known
1036 section names do fit. Leave space for pluralizing. */
1038 s = big_buffer + startoffset; /* First non-space character */
1041 save_config_line(s);
1043 if (strncmpic(s, US"begin ", 6) == 0)
1046 while (isspace(*s)) s++;
1047 if (big_buffer + len - s > sizeof(next_section) - 2)
1048 s[sizeof(next_section) - 2] = 0;
1049 Ustrcpy(next_section, s);
1053 /* Return the first non-blank character. */
1060 /*************************************************
1062 *************************************************/
1064 /* The yield is the pointer to the next uschar. Names longer than the
1065 output space are silently truncated. This function is also used from acl.c when
1069 name where to put the name
1073 Returns: new input pointer
1077 readconf_readname(uschar *name, int len, uschar *s)
1080 while (isspace(*s)) s++;
1083 while (isalnum(*s) || *s == '_')
1085 if (p < len-1) name[p++] = *s;
1090 while (isspace(*s)) s++;
1097 /*************************************************
1098 * Read a time value *
1099 *************************************************/
1101 /* This function is also called from outside, to read argument
1102 time values. The format of a time value is:
1104 [<n>w][<n>d][<n>h][<n>m][<n>s]
1106 as long as at least one is present. If a format error is encountered,
1107 return a negative value. The value must be terminated by the given
1112 terminator required terminating character
1113 return_msec if TRUE, allow fractional seconds and return milliseconds
1115 Returns: the time value, or -1 on syntax error
1116 value is seconds if return_msec is FALSE
1117 value is milliseconds if return_msec is TRUE
1121 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1129 if (!isdigit(*s)) return -1;
1130 (void)sscanf(CCS s, "%d%n", &value, &count);
1135 case 'w': value *= 7;
1136 case 'd': value *= 24;
1137 case 'h': value *= 60;
1138 case 'm': value *= 60;
1143 if (!return_msec) return -1;
1144 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1146 if (*s++ != 's') return -1;
1147 yield += (int)(fraction * 1000.0);
1153 if (return_msec) value *= 1000;
1155 if (*s == terminator) return yield;
1157 /* Control never reaches here. */
1162 /*************************************************
1163 * Read a fixed point value *
1164 *************************************************/
1166 /* The value is returned *1000
1170 terminator required terminator
1172 Returns: the value, or -1 on error
1176 readconf_readfixed(const uschar *s, int terminator)
1180 if (!isdigit(*s)) return -1;
1181 (void)sscanf(CS s, "%d%n", &value, &count);
1183 yield = value * 1000;
1187 while (isdigit((*(++s))))
1189 yield += (*s - '0') * m;
1194 return (*s == terminator)? yield : (-1);
1199 /*************************************************
1200 * Find option in list *
1201 *************************************************/
1203 /* The lists are always in order, so binary chop can be used.
1206 name the option name to search for
1207 ol the first entry in the option list
1208 last one more than the offset of the last entry in the option list
1210 Returns: pointer to an option entry, or NULL if not found
1214 find_option(uschar *name, optionlist *ol, int last)
1217 while (last > first)
1219 int middle = (first + last)/2;
1220 int c = Ustrcmp(name, ol[middle].name);
1222 if (c == 0) return ol + middle;
1223 else if (c > 0) first = middle + 1;
1231 /*************************************************
1232 * Find a set flag in option list *
1233 *************************************************/
1235 /* Because some versions of Unix make no restrictions on the values of uids and
1236 gids (even negative ones), we cannot represent "unset" by a special value.
1237 There is therefore a separate boolean variable for each one indicating whether
1238 a value is set or not. This function returns a pointer to the boolean, given
1239 the original option name. It is a major disaster if the flag cannot be found.
1242 name the name of the uid or gid option
1243 oltop points to the start of the relevant option list
1244 last one more than the offset of the last item in the option list
1245 data_block NULL when reading main options => data values in the option
1246 list are absolute addresses; otherwise they are byte offsets
1247 in data_block (used for driver options)
1249 Returns: a pointer to the boolean flag.
1253 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1257 sprintf(CS name2, "*set_%.50s", name);
1258 ol = find_option(name2, oltop, last);
1259 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1260 "Exim internal error: missing set flag for %s", name);
1261 return (data_block == NULL)? (BOOL *)(ol->value) :
1262 (BOOL *)(US data_block + (long int)(ol->value));
1268 /*************************************************
1269 * Output extra characters message and die *
1270 *************************************************/
1272 /* Called when an option line has junk on the end. Sometimes this is because
1273 the sysadmin thinks comments are permitted.
1276 s points to the extra characters
1277 t1..t3 strings to insert in the log message
1279 Returns: doesn't return; dies
1283 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1285 uschar *comment = US"";
1286 if (*s == '#') comment = US" (# is comment only at line start)";
1287 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1288 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1293 /*************************************************
1294 * Read rewrite information *
1295 *************************************************/
1297 /* Each line of rewrite information contains:
1299 . A complete address in the form user@domain, possibly with
1300 leading * for each part; or alternatively, a regex.
1302 . A replacement string (which will be expanded).
1304 . An optional sequence of one-letter flags, indicating which
1305 headers etc. to apply this rule to.
1307 All this is decoded and placed into a control block. The OR of the flags is
1308 maintained in a common word.
1311 p points to the string that makes up the rule
1312 existflags points to the overall flag word
1313 isglobal TRUE if reading global rewrite rules
1315 Returns: the control block for the parsed rule.
1318 static rewrite_rule *
1319 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1321 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1324 next->key = string_dequote(&p);
1326 while (isspace(*p)) p++;
1328 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1329 "missing rewrite replacement string");
1332 next->replacement = string_dequote(&p);
1334 while (*p != 0) switch (*p++)
1336 case ' ': case '\t': break;
1338 case 'q': next->flags |= rewrite_quit; break;
1339 case 'w': next->flags |= rewrite_whole; break;
1341 case 'h': next->flags |= rewrite_all_headers; break;
1342 case 's': next->flags |= rewrite_sender; break;
1343 case 'f': next->flags |= rewrite_from; break;
1344 case 't': next->flags |= rewrite_to; break;
1345 case 'c': next->flags |= rewrite_cc; break;
1346 case 'b': next->flags |= rewrite_bcc; break;
1347 case 'r': next->flags |= rewrite_replyto; break;
1349 case 'E': next->flags |= rewrite_all_envelope; break;
1350 case 'F': next->flags |= rewrite_envfrom; break;
1351 case 'T': next->flags |= rewrite_envto; break;
1353 case 'Q': next->flags |= rewrite_qualify; break;
1354 case 'R': next->flags |= rewrite_repeat; break;
1357 next->flags |= rewrite_smtp;
1358 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1359 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1360 "rewrite rule has the S flag but is not a regular expression");
1364 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1365 "unknown rewrite flag character '%c' "
1366 "(could be missing quotes round replacement item)", p[-1]);
1370 /* If no action flags are set, set all the "normal" rewrites. */
1372 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1373 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1375 /* Remember which exist, for optimization, and return the rule */
1377 *existflags |= next->flags;
1384 /*************************************************
1385 * Read global rewrite information *
1386 *************************************************/
1388 /* Each line is a single rewrite rule; it is parsed into a control block
1389 by readconf_one_rewrite(), and its flags are ORed into the global flag
1390 word rewrite_existflags. */
1393 readconf_rewrites(void)
1395 rewrite_rule **chain = &global_rewrite_rules;
1398 while ((p = get_config_line()) != NULL)
1400 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1402 chain = &(next->next);
1408 /*************************************************
1410 *************************************************/
1412 /* Strings are read into the normal store pool. As long we aren't too
1413 near the end of the current block, the string will just use what is necessary
1414 on the top of the stacking pool, because string_cat() uses the extension
1418 s the rest of the input line
1419 name the option name (for errors)
1421 Returns: pointer to the string
1425 read_string(const uschar *s, const uschar *name)
1430 if (*s != '\"') return string_copy(s);
1433 yield = string_dequote(&s);
1435 if (s == ss+1 || s[-1] != '\"')
1436 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1437 "missing quote at end of string value for %s", name);
1439 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1445 /*************************************************
1446 * Custom-handler options *
1447 *************************************************/
1449 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1452 smtp_receive_timeout_s = string_copy(str);
1455 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1456 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1457 if (smtp_receive_timeout < 0)
1458 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1463 /*************************************************
1464 * Handle option line *
1465 *************************************************/
1467 /* This function is called from several places to process a line containing the
1468 setting of an option. The first argument is the line to be decoded; it has been
1469 checked not to be empty and not to start with '#'. Trailing newlines and white
1470 space have been removed. The second argument is a pointer to the list of
1471 variable names that are to be recognized, together with their types and
1472 locations, and the third argument gives the number of entries in the list.
1474 The fourth argument is a pointer to a data block. If it is NULL, then the data
1475 values in the options list are absolute addresses. Otherwise, they are byte
1476 offsets in the data block.
1478 String option data may continue onto several lines; this function reads further
1479 data from config_file if necessary.
1481 The yield of this function is normally zero. If a string continues onto
1482 multiple lines, then the data value is permitted to be followed by a comma
1483 or a semicolon (for use in drivers) and the yield is that character.
1486 buffer contains the configuration line to be handled
1487 oltop points to the start of the relevant option list
1488 last one more than the offset of the last item in the option list
1489 data_block NULL when reading main options => data values in the option
1490 list are absolute addresses; otherwise they are byte offsets
1491 in data_block when they have opt_public set; otherwise
1492 they are byte offsets in data_block->options_block.
1493 unknown_txt format string to use in panic message for unknown option;
1494 must contain %s for option name
1495 if given as NULL, don't panic on unknown option
1497 Returns: TRUE if an option was read successfully,
1498 FALSE false for an unknown option if unknown_txt == NULL,
1499 otherwise panic and die on an unknown option
1503 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1504 void *data_block, uschar *unknown_txt)
1508 int n, count, type, value;
1512 BOOL boolvalue = TRUE;
1513 BOOL freesptr = TRUE;
1514 optionlist *ol, *ol2;
1518 uschar *inttype = US"";
1521 uschar **str_target;
1525 /* There may be leading spaces; thereafter, we expect an option name starting
1528 while (isspace(*s)) s++;
1530 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1532 /* Read the name of the option, and skip any subsequent white space. If
1533 it turns out that what we read was "hide", set the flag indicating that
1534 this is a secure option, and loop to read the next word. */
1536 for (n = 0; n < 2; n++)
1538 while (isalnum(*s) || *s == '_')
1540 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1544 while (isspace(*s)) s++;
1545 if (Ustrcmp(name, "hide") != 0) break;
1546 issecure = opt_secure;
1550 /* Deal with "no_" or "not_" here for booleans */
1552 if (Ustrncmp(name, "no_", 3) == 0)
1558 if (Ustrncmp(name, "not_", 4) == 0)
1564 /* Search the list for the given name. A non-existent name, or an option that
1565 is set twice, is a disaster. */
1567 if (!(ol = find_option(name + offset, oltop, last)))
1569 if (unknown_txt == NULL) return FALSE;
1570 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1573 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1574 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1575 "\"%s\" option set for the second time", name);
1577 ol->type |= opt_set | issecure;
1578 type = ol->type & opt_mask;
1580 /* Types with data values must be followed by '='; the "no[t]_" prefix
1581 applies only to boolean values. */
1583 if (type < opt_bool || type > opt_bool_last)
1586 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1587 "negation prefix applied to a non-boolean option");
1589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1590 "unexpected end of line (data missing) after %s", name);
1592 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1595 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1596 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1597 ultimately expands to one of those values. */
1599 else if (*s != 0 && (offset != 0 || *s != '='))
1600 extra_chars_error(s, US"boolean option ", name, US"");
1602 /* Skip white space after = */
1604 if (*s == '=') while (isspace((*(++s))));
1606 /* If there is a data block and the opt_public flag is not set, change
1607 the data block pointer to the private options block. */
1609 if (data_block != NULL && (ol->type & opt_public) == 0)
1610 data_block = (void *)(((driver_instance *)data_block)->options_block);
1612 /* Now get the data according to the type. */
1616 /* If a string value is not enclosed in quotes, it consists of
1617 the rest of the current line, verbatim. Otherwise, string escapes
1620 A transport is specified as a string, which is then looked up in the
1621 list of transports. A search type is specified as one of a number of
1624 A set or rewrite rules for a driver is specified as a string, which is
1625 then parsed into a suitable chain of control blocks.
1627 Uids and gids are specified as strings which are then looked up in the
1628 passwd file. Lists of uids and gids are similarly specified as colon-
1629 separated strings. */
1634 case opt_expand_uid:
1635 case opt_expand_gid:
1640 reset_point = sptr = read_string(s, name);
1642 /* Having read a string, we now have several different ways of using it,
1643 depending on the data type, so do another switch. If keeping the actual
1644 string is not required (because it is interpreted), freesptr is set TRUE,
1645 and at the end we reset the pool. */
1649 /* If this was a string, set the variable to point to the new string,
1650 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1651 rules, we still keep the string (for printing), and parse the rules into a
1652 control block and flags word. */
1655 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1657 if (ol->type & opt_rep_con)
1659 uschar * saved_condition;
1660 /* We already have a condition, we're conducting a crude hack to let
1661 multiple condition rules be chained together, despite storing them in
1663 *str_target = string_copy_malloc( (saved_condition = *str_target)
1664 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1665 saved_condition, sptr)
1667 /* TODO(pdp): there is a memory leak here and just below
1668 when we set 3 or more conditions; I still don't
1669 understand the store mechanism enough to know
1670 what's the safe way to free content from an earlier store.
1671 AFAICT, stores stack, so freeing an early stored item also stores
1672 all data alloc'd after it. If we knew conditions were adjacent,
1673 we could survive that, but we don't. So I *think* we need to take
1674 another bit from opt_type to indicate "malloced"; this seems like
1675 quite a hack, especially for this one case. It also means that
1676 we can't ever reclaim the store from the *first* condition.
1678 Because we only do this once, near process start-up, I'm prepared to
1679 let this slide for the time being, even though it rankles. */
1681 else if (ol->type & opt_rep_str)
1683 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1684 int sep_i = -(int)sep_o;
1685 const uschar * list = sptr;
1687 gstring * list_o = NULL;
1691 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1692 list_o = string_cat(list_o, *str_target);
1695 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1696 list_o = string_append_listele(list_o, sep_o, s);
1699 *str_target = string_copy_malloc(string_from_gstring(list_o));
1710 *USS (US data_block + (long int)(ol->value)) = sptr;
1712 *USS (ol->value) = sptr;
1714 if (type == opt_rewrite)
1719 rewrite_rule **chain;
1722 sprintf(CS name2, "*%.50s_rules", name);
1723 ol2 = find_option(name2, oltop, last);
1724 sprintf(CS name2, "*%.50s_flags", name);
1725 ol3 = find_option(name2, oltop, last);
1727 if (ol2 == NULL || ol3 == NULL)
1728 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1729 "rewrite rules not available for driver");
1731 if (data_block == NULL)
1733 chain = (rewrite_rule **)(ol2->value);
1734 flagptr = (int *)(ol3->value);
1738 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1739 flagptr = (int *)(US data_block + (long int)(ol3->value));
1742 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1744 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1746 chain = &(next->next);
1749 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1750 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1751 "non-header rewrite - not allowed at transport time -");
1755 /* If it was an expanded uid, see if there is any expansion to be
1756 done by checking for the presence of a $ character. If there is, save it
1757 in the corresponding *expand_user option field. Otherwise, fall through
1758 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1761 case opt_expand_uid:
1762 sprintf(CS name2, "*expand_%.50s", name);
1763 ol2 = find_option(name2, oltop, last);
1766 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1768 if (data_block == NULL)
1769 *((uschar **)(ol2->value)) = ss;
1771 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1775 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1781 /* Look up a fixed uid, and also make use of the corresponding gid
1782 if a passwd entry is returned and the gid has not been set. */
1785 if (!route_finduser(sptr, &pw, &uid))
1786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1787 if (data_block == NULL)
1788 *((uid_t *)(ol->value)) = uid;
1790 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1792 /* Set the flag indicating a fixed value is set */
1794 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1796 /* Handle matching gid if we have a passwd entry: done by finding the
1797 same name with terminating "user" changed to "group"; if not found,
1798 ignore. Also ignore if the value is already set. */
1800 if (pw == NULL) break;
1801 Ustrcpy(name+Ustrlen(name)-4, "group");
1802 ol2 = find_option(name, oltop, last);
1803 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1804 (ol2->type & opt_mask) == opt_expand_gid))
1806 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1809 if (data_block == NULL)
1810 *((gid_t *)(ol2->value)) = pw->pw_gid;
1812 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1818 /* If it was an expanded gid, see if there is any expansion to be
1819 done by checking for the presence of a $ character. If there is, save it
1820 in the corresponding *expand_user option field. Otherwise, fall through
1821 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1824 case opt_expand_gid:
1825 sprintf(CS name2, "*expand_%.50s", name);
1826 ol2 = find_option(name2, oltop, last);
1829 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1831 if (data_block == NULL)
1832 *((uschar **)(ol2->value)) = ss;
1834 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1838 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1844 /* Handle freestanding gid */
1847 if (!route_findgroup(sptr, &gid))
1848 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1849 if (data_block == NULL)
1850 *((gid_t *)(ol->value)) = gid;
1852 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1853 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1856 /* If it was a uid list, look up each individual entry, and build
1857 a vector of uids, with a count in the first element. Put the vector
1858 in malloc store so we can free the string. (We are reading into
1859 permanent store already.) */
1867 const uschar *op = expand_string (sptr);
1870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1871 name, expand_string_message);
1874 if (*p != 0) count++;
1875 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1876 list = store_malloc(count*sizeof(uid_t));
1877 list[ptr++] = (uid_t)(count - 1);
1879 if (data_block == NULL)
1880 *((uid_t **)(ol->value)) = list;
1882 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1888 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1889 if (!route_finduser(big_buffer, NULL, &uid))
1890 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1897 /* If it was a gid list, look up each individual entry, and build
1898 a vector of gids, with a count in the first element. Put the vector
1899 in malloc store so we can free the string. (We are reading into permanent
1908 const uschar *op = expand_string (sptr);
1911 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1912 name, expand_string_message);
1915 if (*p != 0) count++;
1916 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1917 list = store_malloc(count*sizeof(gid_t));
1918 list[ptr++] = (gid_t)(count - 1);
1920 if (data_block == NULL)
1921 *((gid_t **)(ol->value)) = list;
1923 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
1929 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1930 if (!route_findgroup(big_buffer, &gid))
1931 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1939 /* Release store if the value of the string doesn't need to be kept. */
1941 if (freesptr) store_reset(reset_point);
1944 /* Expanded boolean: if no characters follow, or if there are no dollar
1945 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1946 save the string for later expansion in the alternate place. */
1948 case opt_expand_bool:
1949 if (*s != 0 && Ustrchr(s, '$') != 0)
1951 sprintf(CS name2, "*expand_%.50s", name);
1952 ol2 = find_option(name2, oltop, last);
1955 reset_point = sptr = read_string(s, name);
1956 if (data_block == NULL)
1957 *((uschar **)(ol2->value)) = sptr;
1959 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
1966 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1967 look for yes/not/true/false. Some booleans are stored in a single bit in
1968 a single int. There's a special fudge for verify settings; without a suffix
1969 they set both xx_sender and xx_recipient. The table points to the sender
1970 value; search subsequently for the recipient. There's another special case:
1971 opt_bool_set also notes when a boolean has been set. */
1975 case opt_bool_verify:
1979 s = readconf_readname(name2, 64, s);
1980 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1982 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1984 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1985 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1986 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1987 US"for boolean option ", name);
1990 /* Handle single-bit type. */
1992 if (type == opt_bit)
1994 int bit = 1 << ((ol->type >> 16) & 31);
1995 int *ptr = (data_block == NULL)?
1996 (int *)(ol->value) :
1997 (int *)(US data_block + (long int)ol->value);
1998 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2002 /* Handle full BOOL types */
2004 if (data_block == NULL)
2005 *((BOOL *)(ol->value)) = boolvalue;
2007 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2011 if (type == opt_bool_verify)
2013 sprintf(CS name2, "%.50s_recipient", name + offset);
2014 ol2 = find_option(name2, oltop, last);
2017 if (data_block == NULL)
2018 *((BOOL *)(ol2->value)) = boolvalue;
2020 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2024 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2026 else if (type == opt_bool_set)
2028 sprintf(CS name2, "*set_%.50s", name + offset);
2029 ol2 = find_option(name2, oltop, last);
2032 if (data_block == NULL)
2033 *((BOOL *)(ol2->value)) = TRUE;
2035 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2044 inttype = US"octal ";
2046 /* Integer: a simple(ish) case; allow octal and hex formats, and
2047 suffixes K, M and G. The different types affect output, not input. */
2056 lvalue = strtol(CS s, CSS &endptr, intbase);
2059 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2062 if (errno != ERANGE)
2063 if (tolower(*endptr) == 'k')
2065 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2066 else lvalue *= 1024;
2069 else if (tolower(*endptr) == 'm')
2071 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2073 else lvalue *= 1024*1024;
2076 else if (tolower(*endptr) == 'g')
2078 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2080 else lvalue *= 1024*1024*1024;
2084 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2085 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2086 "absolute value of integer \"%s\" is too large (overflow)", s);
2088 while (isspace(*endptr)) endptr++;
2090 extra_chars_error(endptr, inttype, US"integer value for ", name);
2092 value = (int)lvalue;
2095 if (data_block == NULL)
2096 *((int *)(ol->value)) = value;
2098 *((int *)(US data_block + (long int)(ol->value))) = value;
2101 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2103 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2109 value = strtol(CS s, CSS &endptr, intbase);
2112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2115 if (errno != ERANGE)
2116 if (tolower(*endptr) == 'g')
2118 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2124 else if (tolower(*endptr) == 'm')
2126 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2132 else if (tolower(*endptr) == 'k')
2135 value = (value + 512)/1024;
2137 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2138 "absolute value of integer \"%s\" is too large (overflow)", s);
2140 while (isspace(*endptr)) endptr++;
2142 extra_chars_error(endptr, inttype, US"integer value for ", name);
2145 if (data_block == NULL)
2146 *((int *)(ol->value)) = value;
2148 *((int *)(US data_block + (long int)(ol->value))) = value;
2151 /* Fixed-point number: held to 3 decimal places. */
2154 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2155 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2156 "fixed-point number expected for %s", name);
2158 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2159 "integer \"%s\" is too large (overflow)", s);
2163 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2164 "integer \"%s\" is too large (overflow)", s);
2166 /* We get a coverity error here for using count, as it derived
2167 from the tainted buffer pointed to by s, as parsed by sscanf().
2168 By the definition of sscanf we must be accessing between start
2169 and end of s (assuming it is nul-terminated...) so ignore the error. */
2170 /* coverity[tainted_data] */
2171 if (s[count] == '.')
2174 while (isdigit(s[++count]))
2176 value += (s[count] - '0') * d;
2181 while (isspace(s[count])) count++;
2184 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2186 if (data_block == NULL)
2187 *((int *)(ol->value)) = value;
2189 *((int *)(US data_block + (long int)(ol->value))) = value;
2192 /* There's a special routine to read time values. */
2195 value = readconf_readtime(s, 0, FALSE);
2197 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2199 if (data_block == NULL)
2200 *((int *)(ol->value)) = value;
2202 *((int *)(US data_block + (long int)(ol->value))) = value;
2205 /* A time list is a list of colon-separated times, with the first
2206 element holding the size of the list and the second the number of
2212 int *list = (data_block == NULL)?
2213 (int *)(ol->value) :
2214 (int *)(US data_block + (long int)(ol->value));
2216 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2219 uschar *snext = Ustrchr(s, ':');
2223 while (ss > s && isspace(ss[-1])) ss--;
2226 value = readconf_readtime(s, terminator, FALSE);
2228 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2230 if (count > 1 && value <= list[count])
2231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2232 "time value out of order for %s", name);
2233 list[count+1] = value;
2234 if (snext == NULL) break;
2236 while (isspace(*s)) s++;
2239 if (count > list[0] - 2)
2240 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2242 if (count > 0 && list[2] == 0) count = 0;
2249 void (*fn)() = ol->value;
2260 /*************************************************
2261 * Print a time value *
2262 *************************************************/
2265 Argument: a time value in seconds
2266 Returns: pointer to a fixed buffer containing the time as a string,
2267 in readconf_readtime() format
2271 readconf_printtime(int t)
2274 uschar *p = time_buffer;
2291 if (w > 0) p += sprintf(CS p, "%dw", w);
2292 if (d > 0) p += sprintf(CS p, "%dd", d);
2293 if (h > 0) p += sprintf(CS p, "%dh", h);
2294 if (m > 0) p += sprintf(CS p, "%dm", m);
2295 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2302 /*************************************************
2303 * Print an individual option value *
2304 *************************************************/
2306 /* This is used by the -bP option, so prints to the standard output.
2307 The entire options list is passed in as an argument, because some options come
2308 in pairs - typically uid/gid settings, which can either be explicit numerical
2309 values, or strings to be expanded later. If the numerical value is unset,
2310 search for "*expand_<name>" to see if there is a string equivalent.
2313 ol option entry, or NULL for an unknown option
2315 options_block NULL for main configuration options; otherwise points to
2316 a driver block; if the option doesn't have opt_public
2317 set, then options_block->options_block is where the item
2319 oltop points to the option list in which ol exists
2320 last one more than the offset of the last entry in optop
2321 no_labels do not show "foo = " at the start.
2323 Returns: boolean success
2327 print_ol(optionlist *ol, uschar *name, void *options_block,
2328 optionlist *oltop, int last, BOOL no_labels)
2341 printf("%s is not a known option\n", name);
2345 /* Non-admin callers cannot see options that have been flagged secure by the
2348 if (!admin_user && ol->type & opt_secure)
2351 printf("%s\n", hidden);
2353 printf("%s = %s\n", name, hidden);
2357 /* Else show the value of the option */
2362 if (!(ol->type & opt_public))
2363 options_block = (void *)(((driver_instance *)options_block)->options_block);
2364 value = (void *)(US options_block + (long int)value);
2367 switch(ol->type & opt_mask)
2370 case opt_rewrite: /* Show the text value */
2372 if (!no_labels) printf("%s = ", name);
2373 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2377 if (!no_labels) printf("%s = ", name);
2378 printf("%d\n", *((int *)value));
2383 int x = *((int *)value);
2384 if (x != 0 && (x & 1023) == 0)
2388 if ((x & 1023) == 0)
2393 if (!no_labels) printf("%s = ", name);
2394 printf("%d%c\n", x, c);
2398 if (!no_labels) printf("%s = ", name);
2406 int x = *((int *)value);
2407 if (!no_labels) printf("%s = ", name);
2408 if (x == 0) printf("0\n");
2409 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2410 else printf("%dK\n", x);
2415 if (!no_labels) printf("%s = ", name);
2416 printf("%#o\n", *((int *)value));
2419 /* Can be negative only when "unset", in which case integer */
2423 int x = *((int *)value);
2426 if (x < 0) printf("%s =\n", name); else
2428 if (!no_labels) printf("%s = ", name);
2429 printf("%d.", x/1000);
2442 /* If the numerical value is unset, try for the string value */
2444 case opt_expand_uid:
2445 if (! *get_set_flag(name, oltop, last, options_block))
2447 sprintf(CS name2, "*expand_%.50s", name);
2448 if ((ol2 = find_option(name2, oltop, last)))
2450 void *value2 = ol2->value;
2452 value2 = (void *)(US options_block + (long int)value2);
2454 if (!no_labels) printf("%s = ", name);
2455 printf("%s\n", s ? string_printing(s) : US"");
2460 /* Else fall through */
2463 if (!no_labels) printf("%s = ", name);
2464 if (! *get_set_flag(name, oltop, last, options_block))
2467 if ((pw = getpwuid(*((uid_t *)value))))
2468 printf("%s\n", pw->pw_name);
2470 printf("%ld\n", (long int)(*((uid_t *)value)));
2473 /* If the numerical value is unset, try for the string value */
2475 case opt_expand_gid:
2476 if (! *get_set_flag(name, oltop, last, options_block))
2478 sprintf(CS name2, "*expand_%.50s", name);
2479 if ( (ol2 = find_option(name2, oltop, last))
2480 && (ol2->type & opt_mask) == opt_stringptr)
2482 void *value2 = ol2->value;
2484 value2 = (void *)(US options_block + (long int)value2);
2486 if (!no_labels) printf("%s = ", name);
2487 printf("%s\n", s ? string_printing(s) : US"");
2492 /* Else fall through */
2495 if (!no_labels) printf("%s = ", name);
2496 if (! *get_set_flag(name, oltop, last, options_block))
2499 if ((gr = getgrgid(*((int *)value))))
2500 printf("%s\n", gr->gr_name);
2502 printf("%ld\n", (long int)(*((int *)value)));
2506 uidlist = *((uid_t **)value);
2507 if (!no_labels) printf("%s =", name);
2511 uschar sep = no_labels ? '\0' : ' ';
2512 for (i = 1; i <= (int)(uidlist[0]); i++)
2514 uschar *name = NULL;
2515 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2516 if (sep != '\0') printf("%c", sep);
2517 if (name) printf("%s", name);
2518 else printf("%ld", (long int)(uidlist[i]));
2526 gidlist = *((gid_t **)value);
2527 if (!no_labels) printf("%s =", name);
2531 uschar sep = no_labels ? '\0' : ' ';
2532 for (i = 1; i <= (int)(gidlist[0]); i++)
2534 uschar *name = NULL;
2535 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2536 if (sep != '\0') printf("%c", sep);
2537 if (name) printf("%s", name);
2538 else printf("%ld", (long int)(gidlist[i]));
2546 if (!no_labels) printf("%s = ", name);
2547 printf("%s\n", readconf_printtime(*((int *)value)));
2553 int *list = (int *)value;
2554 if (!no_labels) printf("%s = ", name);
2555 for (i = 0; i < list[1]; i++)
2556 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2562 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2566 case opt_expand_bool:
2567 sprintf(CS name2, "*expand_%.50s", name);
2568 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2570 void *value2 = ol2->value;
2572 value2 = (void *)(US options_block + (long int)value2);
2576 if (!no_labels) printf("%s = ", name);
2577 printf("%s\n", string_printing(s));
2580 /* s == NULL => string not set; fall through */
2586 case opt_bool_verify:
2588 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2596 /*************************************************
2597 * Print value from main configuration *
2598 *************************************************/
2600 /* This function, called as a result of encountering the -bP option,
2601 causes the value of any main configuration variable to be output if the
2602 second argument is NULL. There are some special values:
2604 all print all main configuration options
2605 config_file print the name of the configuration file
2606 (configure_file will still work, for backward
2608 routers print the routers' configurations
2609 transports print the transports' configuration
2610 authenticators print the authenticators' configuration
2611 macros print the macros' configuration
2612 router_list print a list of router names
2613 transport_list print a list of transport names
2614 authenticator_list print a list of authentication mechanism names
2615 macro_list print a list of macro names
2616 +name print a named list item
2617 local_scan print the local_scan options
2618 config print the configuration as it is parsed
2619 environment print the used execution environment
2621 If the second argument is not NULL, it must be one of "router", "transport",
2622 "authenticator" or "macro" in which case the first argument identifies the
2623 driver whose options are to be printed.
2626 name option name if type == NULL; else driver name
2627 type NULL or driver type name, as described above
2628 no_labels avoid the "foo = " at the start of an item
2630 Returns: Boolean success
2634 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2636 BOOL names_only = FALSE;
2638 optionlist *ol2 = NULL;
2639 driver_instance *d = NULL;
2650 static uschar *types[] = { US"address", US"domain", US"host",
2652 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2653 &hostlist_anchor, &localpartlist_anchor };
2655 for (i = 0; i < 4; i++)
2656 if ((t = tree_search(*(anchors[i]), name+1)))
2660 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2662 printf("%slist %s = %s\n", types[i], name+1,
2663 ((namedlist_block *)(t->data.ptr))->string);
2667 printf("no address, domain, host, or local part list called \"%s\" "
2668 "exists\n", name+1);
2673 if ( Ustrcmp(name, "configure_file") == 0
2674 || Ustrcmp(name, "config_file") == 0)
2676 printf("%s\n", CS config_main_filename);
2680 if (Ustrcmp(name, "all") == 0)
2682 for (ol = optionlist_config;
2683 ol < optionlist_config + nelem(optionlist_config); ol++)
2684 if (!(ol->type & opt_hidden))
2685 (void) print_ol(ol, US ol->name, NULL,
2686 optionlist_config, nelem(optionlist_config),
2691 if (Ustrcmp(name, "local_scan") == 0)
2693 #ifndef LOCAL_SCAN_HAS_OPTIONS
2694 printf("local_scan() options are not supported\n");
2697 for (ol = local_scan_options;
2698 ol < local_scan_options + local_scan_options_count; ol++)
2699 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2700 local_scan_options_count, no_labels);
2705 if (Ustrcmp(name, "config") == 0)
2707 print_config(admin_user, no_labels);
2711 if (Ustrcmp(name, "routers") == 0)
2716 else if (Ustrcmp(name, "transports") == 0)
2718 type = US"transport";
2721 else if (Ustrcmp(name, "authenticators") == 0)
2723 type = US"authenticator";
2726 else if (Ustrcmp(name, "macros") == 0)
2731 else if (Ustrcmp(name, "router_list") == 0)
2737 else if (Ustrcmp(name, "transport_list") == 0)
2739 type = US"transport";
2743 else if (Ustrcmp(name, "authenticator_list") == 0)
2745 type = US"authenticator";
2749 else if (Ustrcmp(name, "macro_list") == 0)
2755 else if (Ustrcmp(name, "environment") == 0)
2760 for (p = USS environ; *p; p++) ;
2761 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2763 for (p = USS environ; *p; p++)
2766 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2774 return print_ol(find_option(name,
2775 optionlist_config, nelem(optionlist_config)),
2776 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2779 /* Handle the options for a router or transport. Skip options that are flagged
2780 as hidden. Some of these are options with names starting with '*', used for
2781 internal alternative representations of other options (which the printing
2782 function will sort out). Others are synonyms kept for backward compatibility.
2785 if (Ustrcmp(type, "router") == 0)
2787 d = (driver_instance *)routers;
2788 ol2 = optionlist_routers;
2789 size = optionlist_routers_size;
2791 else if (Ustrcmp(type, "transport") == 0)
2793 d = (driver_instance *)transports;
2794 ol2 = optionlist_transports;
2795 size = optionlist_transports_size;
2797 else if (Ustrcmp(type, "authenticator") == 0)
2799 d = (driver_instance *)auths;
2800 ol2 = optionlist_auths;
2801 size = optionlist_auths_size;
2804 else if (Ustrcmp(type, "macro") == 0)
2806 /* People store passwords in macros and they were previously not available
2807 for printing. So we have an admin_users restriction. */
2810 fprintf(stderr, "exim: permission denied\n");
2815 if ((m = macro_search(name)))
2816 macro_print(m->tnode.name, m->tnode.data.ptr, (void *)(long)names_only);
2819 printf("%s %s not found\n", type, name);
2823 tree_walk(tree_macros, macro_print, (void *)(long)names_only);
2830 for (; d; d = d->next) printf("%s\n", CS d->name);
2834 /* Either search for a given driver, or print all of them */
2836 for (; d; d = d->next)
2840 printf("\n%s %s:\n", d->name, type);
2841 else if (Ustrcmp(d->name, name) != 0)
2844 for (ol = ol2; ol < ol2 + size; ol++)
2845 if (!(ol->type & opt_hidden))
2846 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2848 for (ol = d->info->options;
2849 ol < d->info->options + *(d->info->options_count); ol++)
2850 if (!(ol->type & opt_hidden))
2851 rc |= print_ol(ol, US ol->name, d, d->info->options,
2852 *d->info->options_count, no_labels);
2854 if (name) return rc;
2856 if (!name) return TRUE;
2858 printf("%s %s not found\n", type, name);
2864 /*************************************************
2865 * Read a named list item *
2866 *************************************************/
2868 /* This function reads a name and a list (i.e. string). The name is used to
2869 save the list in a tree, sorted by its name. Each entry also has a number,
2870 which can be used for caching tests, but if the string contains any expansion
2871 items other than $key, the number is set negative to inhibit caching. This
2872 mechanism is used for domain, host, and address lists that are referenced by
2876 anchorp points to the tree anchor
2877 numberp points to the current number for this tree
2878 max the maximum number permitted
2879 s the text of the option line, starting immediately after the name
2881 tname the name of the list type, for messages
2887 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2890 BOOL forcecache = FALSE;
2893 namedlist_block *nb = store_get(sizeof(namedlist_block));
2895 if (Ustrncmp(s, "_cache", 6) == 0)
2902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2904 if (*numberp >= max)
2905 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2908 while (isspace(*s)) s++;
2910 while (isalnum(*s) || *s == '_') s++;
2911 t = store_get(sizeof(tree_node) + s-ss);
2912 Ustrncpy(t->name, ss, s-ss);
2914 while (isspace(*s)) s++;
2916 if (!tree_insertnode(anchorp, t))
2917 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2918 "duplicate name \"%s\" for a named %s", t->name, tname);
2921 nb->number = *numberp;
2924 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2925 "missing '=' after \"%s\"", t->name);
2926 while (isspace(*s)) s++;
2927 nb->string = read_string(s, t->name);
2928 nb->cache_data = NULL;
2930 /* Check the string for any expansions; if any are found, mark this list
2931 uncacheable unless the user has explicited forced caching. */
2933 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2939 /*************************************************
2940 * Unpick data for a rate limit *
2941 *************************************************/
2943 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2947 s string, in the form t,b,f,l
2948 where t is the threshold (integer)
2949 b is the initial delay (time)
2950 f is the multiplicative factor (fixed point)
2951 k is the maximum time (time)
2952 threshold where to store threshold
2953 base where to store base in milliseconds
2954 factor where to store factor in milliseconds
2955 limit where to store limit
2957 Returns: nothing (panics on error)
2961 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2964 uschar bstring[16], lstring[16];
2966 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2967 factor, lstring) == 4)
2969 *base = readconf_readtime(bstring, 0, TRUE);
2970 *limit = readconf_readtime(lstring, 0, TRUE);
2971 if (*base >= 0 && *limit >= 0) return;
2973 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2979 /*************************************************
2980 * Drop privs for checking TLS config *
2981 *************************************************/
2983 /* We want to validate TLS options during readconf, but do not want to be
2984 root when we call into the TLS library, in case of library linkage errors
2985 which cause segfaults; before this check, those were always done as the Exim
2986 runtime user and it makes sense to continue with that.
2988 Assumes: tls_require_ciphers has been set, if it will be
2989 exim_user has been set, if it will be
2990 exim_group has been set, if it will be
2992 Returns: bool for "okay"; false will cause caller to immediately exit.
2997 tls_dropprivs_validate_require_cipher(BOOL nowarn)
2999 const uschar *errmsg;
3002 void (*oldsignal)(int);
3004 /* If TLS will never be used, no point checking ciphers */
3006 if ( !tls_advertise_hosts
3007 || !*tls_advertise_hosts
3008 || Ustrcmp(tls_advertise_hosts, ":") == 0
3011 else if (!nowarn && !tls_certificate)
3012 log_write(0, LOG_MAIN,
3013 "Warning: No server certificate defined; will use a selfsigned one.\n"
3014 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3016 oldsignal = signal(SIGCHLD, SIG_DFL);
3019 if ((pid = fork()) < 0)
3020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3024 /* in some modes, will have dropped privilege already */
3026 exim_setugid(exim_uid, exim_gid, FALSE,
3027 US"calling tls_validate_require_cipher");
3029 if ((errmsg = tls_validate_require_cipher()))
3030 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3031 "tls_require_ciphers invalid: %s", errmsg);
3037 rc = waitpid(pid, &status, 0);
3038 } while (rc < 0 && errno == EINTR);
3041 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3044 signal(SIGCHLD, oldsignal);
3048 #endif /* SUPPORT_TLS */
3053 /*************************************************
3054 * Read main configuration options *
3055 *************************************************/
3057 /* This function is the first to be called for configuration reading. It
3058 opens the configuration file and reads general configuration settings until
3059 it reaches the end of the configuration section. The file is then left open so
3060 that the remaining configuration data can subsequently be read if needed for
3063 The configuration file must be owned either by root or exim, and be writeable
3064 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3065 in the config file, so the test is done on the compiled in values. A slight
3066 anomaly, to be carefully documented.
3068 The name of the configuration file is taken from a list that is included in the
3069 binary of Exim. It can be altered from the command line, but if that is done,
3070 root privilege is immediately withdrawn unless the caller is root or exim.
3071 The first file on the list that exists is used.
3073 For use on multiple systems that share file systems, first look for a
3074 configuration file whose name has the current node name on the end. If that is
3075 not found, try the generic name. For really contorted configurations, that run
3076 multiple Exims with different uid settings, first try adding the effective uid
3077 before the node name. These complications are going to waste resources on most
3078 systems. Therefore they are available only when requested by compile-time
3082 readconf_main(BOOL nowarn)
3085 struct stat statbuf;
3086 uschar *s, *filename;
3087 const uschar *list = config_main_filelist;
3089 /* Loop through the possible file names */
3091 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3094 /* Cut out all the fancy processing unless specifically wanted */
3096 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3097 uschar *suffix = filename + Ustrlen(filename);
3099 /* Try for the node-specific file if a node name exists */
3101 #ifdef CONFIGURE_FILE_USE_NODE
3103 if (uname(&uts) >= 0)
3105 #ifdef CONFIGURE_FILE_USE_EUID
3106 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3107 config_file = Ufopen(filename, "rb");
3108 if (config_file == NULL)
3109 #endif /* CONFIGURE_FILE_USE_EUID */
3111 sprintf(CS suffix, ".%.256s", uts.nodename);
3112 config_file = Ufopen(filename, "rb");
3115 #endif /* CONFIGURE_FILE_USE_NODE */
3117 /* Otherwise, try the generic name, possibly with the euid added */
3119 #ifdef CONFIGURE_FILE_USE_EUID
3120 if (config_file == NULL)
3122 sprintf(CS suffix, ".%ld", (long int)original_euid);
3123 config_file = Ufopen(filename, "rb");
3125 #endif /* CONFIGURE_FILE_USE_EUID */
3127 /* Finally, try the unadorned name */
3129 if (config_file == NULL)
3132 config_file = Ufopen(filename, "rb");
3134 #else /* if neither defined */
3136 /* This is the common case when the fancy processing is not included. */
3138 config_file = Ufopen(filename, "rb");
3141 /* If the file does not exist, continue to try any others. For any other
3142 error, break out (and die). */
3144 if (config_file != NULL || errno != ENOENT) break;
3147 /* On success, save the name for verification; config_filename is used when
3148 logging configuration errors (it changes for .included files) whereas
3149 config_main_filename is the name shown by -bP. Failure to open a configuration
3150 file is a serious disaster. */
3154 uschar *last_slash = Ustrrchr(filename, '/');
3155 config_filename = config_main_filename = string_copy(filename);
3157 /* The config_main_directory we need for the $config_dir expansion.
3158 config_main_filename we need for $config_file expansion.
3159 And config_dir is the directory of the current configuration, used for
3160 relative .includes. We do need to know it's name, as we change our working
3163 if (filename[0] == '/')
3164 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3167 /* relative configuration file name: working dir + / + basename(filename) */
3169 uschar buf[PATH_MAX];
3172 if (os_getcwd(buf, PATH_MAX) == NULL)
3174 perror("exim: getcwd");
3177 g = string_cat(NULL, buf);
3179 /* If the dir does not end with a "/", append one */
3180 if (g->s[g->ptr-1] != '/')
3181 g = string_catn(g, US"/", 1);
3183 /* If the config file contains a "/", extract the directory part */
3185 g = string_catn(g, filename, last_slash - filename);
3187 config_main_directory = string_from_gstring(g);
3189 config_directory = config_main_directory;
3193 if (filename == NULL)
3194 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3195 "%s", config_main_filelist);
3197 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3198 "configuration file %s", filename));
3201 /* Now, once we found and opened our configuration file, we change the directory
3202 to a safe place. Later we change to $spool_directory. */
3204 if (Uchdir("/") < 0)
3206 perror("exim: chdir `/': ");
3210 /* Check the status of the file we have opened, if we have retained root
3211 privileges and the file isn't /dev/null (which *should* be 0666). */
3213 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3215 if (fstat(fileno(config_file), &statbuf) != 0)
3216 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3219 if ((statbuf.st_uid != root_uid /* owner not root */
3220 #ifdef CONFIGURE_OWNER
3221 && statbuf.st_uid != config_uid /* owner not the special one */
3224 (statbuf.st_gid != root_gid /* group not root & */
3225 #ifdef CONFIGURE_GROUP
3226 && statbuf.st_gid != config_gid /* group not the special one */
3228 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3230 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3232 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3233 "wrong owner, group, or mode", big_buffer);
3236 /* Process the main configuration settings. They all begin with a lower case
3237 letter. If we see something starting with an upper case letter, it is taken as
3238 a macro definition. */
3240 while ((s = get_config_line()))
3242 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3244 "found unexpected BOM (Byte Order Mark)");
3247 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3249 else if (Ustrncmp(s, "domainlist", 10) == 0)
3250 read_named_list(&domainlist_anchor, &domainlist_count,
3251 MAX_NAMED_LIST, s+10, US"domain list");
3253 else if (Ustrncmp(s, "hostlist", 8) == 0)
3254 read_named_list(&hostlist_anchor, &hostlist_count,
3255 MAX_NAMED_LIST, s+8, US"host list");
3257 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3258 read_named_list(&addresslist_anchor, &addresslist_count,
3259 MAX_NAMED_LIST, s+11, US"address list");
3261 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3262 read_named_list(&localpartlist_anchor, &localpartlist_count,
3263 MAX_NAMED_LIST, s+13, US"local part list");
3266 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3267 NULL, US"main option \"%s\" unknown");
3271 /* If local_sender_retain is set, local_from_check must be unset. */
3273 if (local_sender_retain && local_from_check)
3274 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3275 "local_sender_retain are set; this combination is not allowed");
3277 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3280 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3282 /* The max retry interval must not be greater than 24 hours. */
3284 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3286 /* remote_max_parallel must be > 0 */
3288 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3290 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3291 start of a new SMTP message. */
3293 freeze_tell_config = freeze_tell;
3295 /* The primary host name may be required for expansion of spool_directory
3296 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3297 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3298 canonize it. Some people like upper case letters in their host names, so we
3299 don't force the case. */
3301 if (primary_hostname == NULL)
3303 const uschar *hostname;
3305 if (uname(&uts) < 0)
3306 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3307 hostname = US uts.nodename;
3309 if (Ustrchr(hostname, '.') == NULL)
3312 struct hostent *hostdata;
3315 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3316 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3317 MCL_DOMAIN, TRUE, NULL) != OK))
3326 #if HAVE_GETIPNODEBYNAME
3328 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3330 hostdata = gethostbyname2(CS hostname, af);
3333 hostdata = gethostbyname(CS hostname);
3336 if (hostdata != NULL)
3338 hostname = US hostdata->h_name;
3342 if (af == AF_INET) break;
3347 primary_hostname = string_copy(hostname);
3350 /* Set up default value for smtp_active_hostname */
3352 smtp_active_hostname = primary_hostname;
3354 /* If spool_directory wasn't set in the build-time configuration, it must have
3355 got set above. Of course, writing to the log may not work if log_file_path is
3356 not set, but it will at least get to syslog or somewhere, with any luck. */
3358 if (*spool_directory == 0)
3359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3362 /* Expand the spool directory name; it may, for example, contain the primary
3363 host name. Same comment about failure. */
3365 s = expand_string(spool_directory);
3367 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3368 "\"%s\": %s", spool_directory, expand_string_message);
3369 spool_directory = s;
3371 /* Expand log_file_path, which must contain "%s" in any component that isn't
3372 the null string or "syslog". It is also allowed to contain one instance of %D
3373 or %M. However, it must NOT contain % followed by anything else. */
3375 if (*log_file_path != 0)
3377 const uschar *ss, *sss;
3378 int sep = ':'; /* Fixed for log file path */
3379 s = expand_string(log_file_path);
3381 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3382 "\"%s\": %s", log_file_path, expand_string_message);
3385 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3388 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3389 t = Ustrstr(sss, "%s");
3391 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3392 "contain \"%%s\"", sss);
3394 t = Ustrchr(sss, '%');
3397 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3398 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3399 "unexpected \"%%\" character", s);
3406 /* Interpret syslog_facility into an integer argument for 'ident' param to
3407 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3410 if (syslog_facility_str)
3413 uschar *s = syslog_facility_str;
3415 if ((Ustrlen(syslog_facility_str) >= 4) &&
3416 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3419 for (i = 0; i < syslog_list_size; i++)
3420 if (strcmpic(s, syslog_list[i].name) == 0)
3422 syslog_facility = syslog_list[i].value;
3426 if (i >= syslog_list_size)
3427 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3428 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3431 /* Expand pid_file_path */
3433 if (*pid_file_path != 0)
3435 if (!(s = expand_string(pid_file_path)))
3436 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3437 "\"%s\": %s", pid_file_path, expand_string_message);
3441 /* Set default value of process_log_path */
3443 if (!process_log_path || *process_log_path =='\0')
3444 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3446 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3449 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3451 /* Unpick the SMTP rate limiting options, if set */
3453 if (smtp_ratelimit_mail)
3454 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3455 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3457 if (smtp_ratelimit_rcpt)
3458 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3459 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3461 /* The qualify domains default to the primary host name */
3463 if (!qualify_domain_sender)
3464 qualify_domain_sender = primary_hostname;
3465 if (!qualify_domain_recipient)
3466 qualify_domain_recipient = qualify_domain_sender;
3468 /* Setting system_filter_user in the configuration sets the gid as well if a
3469 name is given, but a numerical value does not. */
3471 if (system_filter_uid_set && !system_filter_gid_set)
3473 struct passwd *pw = getpwuid(system_filter_uid);
3475 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3476 (long int)system_filter_uid);
3477 system_filter_gid = pw->pw_gid;
3478 system_filter_gid_set = TRUE;
3481 /* If the errors_reply_to field is set, check that it is syntactically valid
3482 and ensure it contains a domain. */
3484 if (errors_reply_to)
3487 int start, end, domain;
3488 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3489 &start, &end, &domain, FALSE);
3492 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3493 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3496 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3497 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3500 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3501 smtp_accept_max must also be set. */
3503 if (smtp_accept_max == 0 &&
3504 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3505 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3506 "smtp_accept_max must be set if smtp_accept_queue or "
3507 "smtp_accept_max_per_host is set");
3509 /* Set up the host number if anything is specified. It is an expanded string
3510 so that it can be computed from the host name, for example. We do this last
3511 so as to ensure that everything else is set up before the expansion. */
3513 if (host_number_string)
3517 uschar *s = expand_string(host_number_string);
3520 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3521 "failed to expand localhost_number \"%s\": %s",
3522 host_number_string, expand_string_message);
3523 n = Ustrtol(s, &end, 0);
3524 while (isspace(*end)) end++;
3526 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3527 "localhost_number value is not a number: %s", s);
3528 if (n > LOCALHOST_MAX)
3529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3530 "localhost_number is greater than the maximum allowed value (%d)",
3536 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3538 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3540 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3541 tls_verify_hosts ? "" : "try_");
3543 /* This also checks that the library linkage is working and we can call
3544 routines in it, so call even if tls_require_ciphers is unset */
3545 if (!tls_dropprivs_validate_require_cipher(nowarn))
3548 /* Magic number: at time of writing, 1024 has been the long-standing value
3549 used by so many clients, and what Exim used to use always, that it makes
3550 sense to just min-clamp this max-clamp at that. */
3551 if (tls_dh_max_bits < 1024)
3552 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3553 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3555 /* If openssl_options is set, validate it */
3556 if (openssl_options)
3559 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3560 "openssl_options is set but we're using GnuTLS");
3563 if (!tls_openssl_options_parse(openssl_options, &dummy))
3564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3565 "openssl_options parse error: %s", openssl_options);
3568 #endif /*SUPPORT_TLS*/
3570 if (!nowarn && !keep_environment && environ && *environ)
3571 log_write(0, LOG_MAIN,
3572 "Warning: purging the environment.\n"
3573 " Suggested action: use keep_environment.");
3578 /*************************************************
3579 * Initialize one driver *
3580 *************************************************/
3582 /* This is called once the driver's generic options, if any, have been read.
3583 We can now find the driver, set up defaults for the private options, and
3584 unset any "set" bits in the private options table (which might have been
3585 set by another incarnation of the same driver).
3588 d pointer to driver instance block, with generic
3590 drivers_available vector of available drivers
3591 size_of_info size of each block in drivers_available
3592 class class of driver, for error message
3594 Returns: pointer to the driver info block
3597 static driver_info *
3598 init_driver(driver_instance *d, driver_info *drivers_available,
3599 int size_of_info, uschar *class)
3603 for (dd = drivers_available; dd->driver_name[0] != 0;
3604 dd = (driver_info *)((US dd) + size_of_info))
3606 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3609 int len = dd->options_len;
3611 d->options_block = store_get(len);
3612 memcpy(d->options_block, dd->options_block, len);
3613 for (i = 0; i < *(dd->options_count); i++)
3614 dd->options[i].type &= ~opt_set;
3619 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3620 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3622 return NULL; /* never obeyed */
3628 /*************************************************
3629 * Initialize driver list *
3630 *************************************************/
3632 /* This function is called for routers, transports, and authentication
3633 mechanisms. It reads the data from the current point in the configuration file
3634 up to the end of the section, and sets up a chain of instance blocks according
3635 to the file's contents. The file will already have been opened by a call to
3636 readconf_main, and must be left open for subsequent reading of further data.
3638 Any errors cause a panic crash. Note that the blocks with names driver_info and
3639 driver_instance must map the first portions of all the _info and _instance
3640 blocks for this shared code to work.
3643 class "router", "transport", or "authenticator"
3644 anchor &routers, &transports, &auths
3645 drivers_available available drivers
3646 size_of_info size of each info block
3647 instance_default points to default data for an instance
3648 instance_size size of instance block
3649 driver_optionlist generic option list
3650 driver_optionlist_count count of generic option list
3656 readconf_driver_init(
3658 driver_instance **anchor,
3659 driver_info *drivers_available,
3661 void *instance_default,
3663 optionlist *driver_optionlist,
3664 int driver_optionlist_count)
3666 driver_instance **p = anchor;
3667 driver_instance *d = NULL;
3670 while ((buffer = get_config_line()) != NULL)
3675 /* Read the first name on the line and test for the start of a new driver. A
3676 macro definition indicates the end of the previous driver. If this isn't the
3677 start of a new driver, the line will be re-read. */
3679 s = readconf_readname(name, sizeof(name), buffer);
3681 /* Handle macro definition, first finishing off the initialization of the
3682 previous driver, if any. */
3684 if (isupper(*name) && *s == '=')
3688 if (!d->driver_name)
3689 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3690 "no driver defined for %s \"%s\"", class, d->name);
3694 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3698 /* If the line starts with a name terminated by a colon, we are at the
3699 start of the definition of a new driver. The rest of the line must be
3706 /* Finish off initializing the previous driver. */
3710 if (!d->driver_name)
3711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3712 "no driver defined for %s \"%s\"", class, d->name);
3716 /* Check that we haven't already got a driver of this name */
3718 for (d = *anchor; d; d = d->next)
3719 if (Ustrcmp(name, d->name) == 0)
3720 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3721 "there are two %ss called \"%s\"", class, name);
3723 /* Set up a new driver instance data block on the chain, with
3724 its default values installed. */
3726 d = store_get(instance_size);
3727 memcpy(d, instance_default, instance_size);
3730 d->name = string_copy(name);
3732 /* Clear out the "set" bits in the generic options */
3734 for (i = 0; i < driver_optionlist_count; i++)
3735 driver_optionlist[i].type &= ~opt_set;
3737 /* Check nothing more on this line, then do the next loop iteration. */
3739 while (isspace(*s)) s++;
3740 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3744 /* Not the start of a new driver. Give an error if we have not set up a
3745 current driver yet. */
3748 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3750 /* First look to see if this is a generic option; if it is "driver",
3751 initialize the driver. If is it not a generic option, we can look for a
3752 private option provided that the driver has been previously set up. */
3754 if (readconf_handle_option(buffer, driver_optionlist,
3755 driver_optionlist_count, d, NULL))
3757 if (!d->info && d->driver_name)
3758 init_driver(d, drivers_available, size_of_info, class);
3761 /* Handle private options - pass the generic block because some may
3762 live therein. A flag with each option indicates if it is in the public
3766 readconf_handle_option(buffer, d->info->options,
3767 *(d->info->options_count), d, US"option \"%s\" unknown");
3769 /* The option is not generic and the driver name has not yet been given. */
3771 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3772 "(\"driver\" must be specified before any private options)", name);
3775 /* Run the initialization function for the final driver. */
3779 if (!d->driver_name)
3780 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3781 "no driver defined for %s \"%s\"", class, d->name);
3788 /*************************************************
3789 * Check driver dependency *
3790 *************************************************/
3792 /* This function is passed a driver instance and a string. It checks whether
3793 any of the string options for the driver contains the given string as an
3797 d points to a driver instance block
3798 s the string to search for
3800 Returns: TRUE if a dependency is found
3804 readconf_depends(driver_instance *d, uschar *s)
3806 int count = *(d->info->options_count);
3810 for (ol = d->info->options; ol < d->info->options + count; ol++)
3812 void *options_block;
3814 int type = ol->type & opt_mask;
3815 if (type != opt_stringptr) continue;
3816 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3817 value = *(uschar **)(US options_block + (long int)(ol->value));
3818 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3820 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3821 isalnum(ss[Ustrlen(s)])) continue;
3822 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3823 d->name, ol->name, s);
3828 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3835 /*************************************************
3836 * Decode an error type for retries *
3837 *************************************************/
3839 /* This function is global because it is also called from the main
3840 program when testing retry information. It decodes strings such as "quota_7d"
3841 into numerical error codes.
3844 pp points to start of text
3845 p points past end of text
3846 basic_errno points to an int to receive the main error number
3847 more_errno points to an int to receive the secondary error data
3849 Returns: NULL if decoded correctly; else points to error text
3853 readconf_retry_error(const uschar *pp, const uschar *p,
3854 int *basic_errno, int *more_errno)
3857 const uschar *q = pp;
3858 while (q < p && *q != '_') q++;
3861 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3863 *basic_errno = ERRNO_EXIMQUOTA;
3864 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3865 return US"bad time value";
3868 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3870 *basic_errno = ECONNREFUSED;
3873 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3874 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3875 else return US"A or MX expected after \"refused\"";
3879 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3881 *basic_errno = ETIMEDOUT;
3885 int xlen = p - q - 1;
3886 const uschar *x = q + 1;
3888 static uschar *extras[] =
3889 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3890 static int values[] =
3891 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3893 for (i = 0; i < nelem(extras); i++)
3894 if (strncmpic(x, extras[i], xlen) == 0)
3896 *more_errno = values[i];
3900 if (i >= nelem(extras))
3901 if (strncmpic(x, US"DNS", xlen) == 0)
3902 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3903 "available in retry rules (it has never worked) - treated as "
3906 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3910 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3911 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3912 strncmpic(pp, US"data_4", 6) == 0)
3915 int x = 255; /* means "any 4xx code" */
3916 if (p != pp + 8) bad = TRUE; else
3918 int a = pp[6], b = pp[7];
3922 if (isdigit(b)) x += b - '0';
3923 else if (b == 'x') x += 100;
3926 else if (a != 'x' || b != 'x') bad = TRUE;
3930 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3931 "x is literal and d is any digit", pp);
3933 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3934 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3935 *more_errno = x << 8;
3938 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3939 strncmpic(q+1, US"failed", p-q-1) == 0)
3940 *basic_errno = ERRNO_AUTHFAIL;
3942 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3943 *basic_errno = ERRNO_SMTPCLOSED;
3945 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3946 *basic_errno = ERRNO_TLSREQUIRED;
3948 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3949 *basic_errno = ERRNO_UNKNOWNHOST;
3951 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3952 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3960 /*************************************************
3961 * Read retry information *
3962 *************************************************/
3964 /* Each line of retry information contains:
3966 . A domain name pattern or an address pattern;
3968 . An error name, possibly with additional data, or *;
3970 . An optional sequence of retry items, each consisting of an identifying
3971 letter, a cutoff time, and optional parameters.
3973 All this is decoded and placed into a control block. */
3976 /* Subroutine to read an argument, preceded by a comma and terminated
3977 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3978 1 = fixed point number (returned *1000).
3981 paddr pointer to pointer to current character; updated
3982 type 0 => read a time; 1 => read a fixed point number
3984 Returns: time in seconds or fixed point number * 1000
3988 retry_arg(const uschar **paddr, int type)
3990 const uschar *p = *paddr;
3993 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3995 while (isspace(*p)) p++;
3997 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3999 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4005 case 0: return readconf_readtime(pp, *p, FALSE);
4006 case 1: return readconf_readfixed(pp, *p);
4008 return 0; /* Keep picky compilers happy */
4011 /* The function proper */
4014 readconf_retries(void)
4016 retry_config **chain = &retries;
4020 while ((p = get_config_line()))
4022 retry_rule **rchain;
4026 next = store_get(sizeof(retry_config));
4029 chain = &(next->next);
4030 next->basic_errno = next->more_errno = 0;
4031 next->senders = NULL;
4033 rchain = &(next->rules);
4035 next->pattern = string_dequote(&p);
4036 while (isspace(*p)) p++;
4038 while (mac_isgraph(*p)) p++;
4039 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4040 "missing error type in retry rule");
4042 /* Test error names for things we understand. */
4044 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4045 &next->more_errno)))
4046 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4048 /* There may be an optional address list of senders to be used as another
4049 constraint on the rule. This was added later, so the syntax is a bit of a
4050 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4053 while (isspace(*p)) p++;
4054 if (Ustrncmp(p, "senders", 7) == 0)
4057 while (isspace(*p)) p++;
4058 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4059 "\"=\" expected after \"senders\" in retry rule");
4060 while (isspace(*p)) p++;
4061 next->senders = string_dequote(&p);
4064 /* Now the retry rules. Keep the maximum timeout encountered. */
4066 while (isspace(*p)) p++;
4070 retry_rule *rule = store_get(sizeof(retry_rule));
4072 rchain = &(rule->next);
4074 rule->rule = toupper(*p++);
4075 rule->timeout = retry_arg(&p, 0);
4076 if (rule->timeout > retry_maximum_timeout)
4077 retry_maximum_timeout = rule->timeout;
4081 case 'F': /* Fixed interval */
4082 rule->p1 = retry_arg(&p, 0);
4085 case 'G': /* Geometrically increasing intervals */
4086 case 'H': /* Ditto, but with randomness */
4087 rule->p1 = retry_arg(&p, 0);
4088 rule->p2 = retry_arg(&p, 1);
4092 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4096 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4097 (rule->rule != 'F' && rule->p2 < 1000))
4098 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4099 "bad parameters for retry rule");
4101 while (isspace(*p)) p++;
4105 while (isspace(*p)) p++;
4108 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4115 /*************************************************
4116 * Initialize authenticators *
4117 *************************************************/
4119 /* Read the authenticators section of the configuration file.
4128 auth_instance *au, *bu;
4130 readconf_driver_init(US"authenticator",
4131 (driver_instance **)(&auths), /* chain anchor */
4132 (driver_info *)auths_available, /* available drivers */
4133 sizeof(auth_info), /* size of info block */
4134 &auth_defaults, /* default values for generic options */
4135 sizeof(auth_instance), /* size of instance block */
4136 optionlist_auths, /* generic options */
4137 optionlist_auths_size);
4139 for (au = auths; au; au = au->next)
4141 if (!au->public_name)
4142 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4143 "the %s authenticator", au->name);
4145 for (bu = au->next; bu; bu = bu->next)
4146 if (strcmpic(au->public_name, bu->public_name) == 0)
4147 if ((au->client && bu->client) || (au->server && bu->server))
4148 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4149 "(%s and %s) have the same public name (%s)",
4150 au->client ? US"client" : US"server", au->name, bu->name,
4158 /*************************************************
4159 * Read ACL information *
4160 *************************************************/
4162 /* If this run of Exim is not doing something that involves receiving a
4163 message, we can just skip over the ACL information. No need to parse it.
4165 First, we have a function for acl_read() to call back to get the next line. We
4166 need to remember the line we passed, because at the end it will contain the
4167 name of the next ACL. */
4169 static uschar *acl_line;
4174 acl_line = get_config_line();
4179 /* Now the main function:
4190 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4193 acl_line = get_config_line();
4201 p = readconf_readname(name, sizeof(name), acl_line);
4202 if (isupper(*name) && *p == '=')
4204 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4205 acl_line = get_config_line();
4209 if (*p != ':' || name[0] == 0)
4210 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4212 node = store_get(sizeof(tree_node) + Ustrlen(name));
4213 Ustrcpy(node->name, name);
4214 if (!tree_insertnode(&acl_anchor, node))
4215 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4216 "there are two ACLs called \"%s\"", name);
4218 node->data.ptr = acl_read(acl_callback, &error);
4220 if (node->data.ptr == NULL && error != NULL)
4221 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4227 /*************************************************
4228 * Read configuration for local_scan() *
4229 *************************************************/
4231 /* This function is called after "begin local_scan" is encountered in the
4232 configuration file. If the local_scan() function allows for configuration
4233 options, we can process them. Otherwise, we expire in a panic.
4240 local_scan_init(void)
4242 #ifndef LOCAL_SCAN_HAS_OPTIONS
4243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4244 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4248 while ((p = get_config_line()))
4250 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4251 NULL, US"local_scan option \"%s\" unknown");
4258 /*************************************************
4259 * Read rest of configuration (after main) *
4260 *************************************************/
4262 /* This function reads the rest of the runtime configuration, after the main
4263 configuration. It is called only when actually needed. Each subsequent section
4264 of the configuration starts with a line of the form
4268 where the name is "routers", "transports", etc. A section is terminated by
4269 hitting the next "begin" line, and the next name is left in next_section.
4270 Because it may confuse people as to whether the names are singular or plural,
4271 we add "s" if it's missing. There is always enough room in next_section for
4272 this. This function is basically just a switch.
4278 static uschar *section_list[] = {
4292 while(next_section[0] != 0)
4296 int last = nelem(section_list);
4298 int n = Ustrlen(next_section);
4300 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4304 int c = strcmpic(next_section, section_list[mid]);
4306 if (c > 0) first = mid + 1; else last = mid;
4308 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4309 "\"%.*s\" is not a known configuration section name", n, next_section);
4310 mid = (last + first)/2;
4314 if (((had ^= bit) & bit) == 0)
4315 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4316 "\"%.*s\" section is repeated in the configuration file", n,
4321 case 0: readconf_acl(); break;
4322 case 1: auths_init(); break;
4323 case 2: local_scan_init(); break;
4324 case 3: readconf_retries(); break;
4325 case 4: readconf_rewrites(); break;
4326 case 5: route_init(); break;
4327 case 6: transport_init(); break;
4331 (void)fclose(config_file);
4334 /* Init the storage for the pre-parsed config lines */
4336 readconf_save_config(const uschar *s)
4338 save_config_line(string_sprintf("# Exim Configuration (%s)",
4339 running_in_test_harness ? US"X" : s));
4343 save_config_position(const uschar *file, int line)
4345 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4348 /* Append a pre-parsed logical line to the config lines store,
4349 this operates on a global (static) list that holds all the pre-parsed
4350 config lines, we do no further processing here, output formatting and
4351 honouring of <hide> or macros will be done during output */
4354 save_config_line(const uschar* line)
4356 static config_line_item *current;
4357 config_line_item *next;
4359 next = (config_line_item*) store_get(sizeof(config_line_item));
4360 next->line = string_copy(line);
4363 if (!config_lines) config_lines = next;
4364 else current->next = next;
4369 /* List the parsed config lines, care about nice formatting and
4370 hide the <hide> values unless we're the admin user */
4372 print_config(BOOL admin, BOOL terse)
4374 config_line_item *i;
4375 const int TS = terse ? 0 : 2;
4378 for (i = config_lines; i; i = i->next)
4383 /* skip over to the first non-space */
4384 for (current = i->line; *current && isspace(*current); ++current)
4387 if (*current == '\0')
4390 /* Collapse runs of spaces. We stop this if we encounter one of the
4391 * following characters: "'$, as this may indicate careful formatting */
4392 for (p = current; *p; ++p)
4395 if (!isspace(*p)) continue;
4396 if (*p != ' ') *p = ' ';
4398 for (next = p; isspace(*next); ++next)
4402 memmove(p+1, next, Ustrlen(next)+1);
4404 if (*next == '"' || *next == '\'' || *next == '$')
4409 if (current[0] == '#')
4412 /* begin lines are left aligned */
4413 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4415 if (!terse) puts("");
4420 /* router/acl/transport block names */
4421 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4423 if (!terse) puts("");
4424 printf("%*s%s\n", TS, "", current);
4428 /* hidden lines (all MACROS or lines prefixed with "hide") */
4430 && ( isupper(*current)
4431 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4435 if ((p = Ustrchr(current, '=')))
4438 printf("%*s%s= %s\n", indent, "", current, hidden);
4440 /* e.g.: hide split_spool_directory */
4442 printf("%*s\n", indent, hidden);
4446 /* rest is public */
4447 printf("%*s%s\n", indent, "", current);
4451 #endif /*!MACRO_PREDEF*/
4454 /* End of readconf.c */