1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
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 },
307 #ifdef EXPERIMENTAL_SPF
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 == (char *)(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 : (char *)t->options_block
584 + (long int)op->value)
595 /*************************************************
596 * Deal with an assignment to a macro *
597 *************************************************/
599 /* We have a new definition; append to the list.
602 name Name of the macro. Must be in storage persistent past the call
603 val Expansion result for the macro. Ditto persistence.
607 macro_create(const uschar * name, const uschar * val, BOOL command_line)
609 macro_item * m = store_get(sizeof(macro_item));
611 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val); */
613 m->command_line = command_line;
614 m->namelen = Ustrlen(name);
615 m->replen = Ustrlen(val);
617 m->replacement = val;
624 /* This function is called when a line that starts with an upper case letter is
625 encountered. The argument "line" should contain a complete logical line, and
626 start with the first letter of the macro name. The macro name and the
627 replacement text are extracted and stored. Redefinition of existing,
628 non-command line, macros is permitted using '==' instead of '='.
631 s points to the start of the logical line
637 read_macro_assignment(uschar *s)
644 while (isalnum(*s) || *s == '_')
646 if (namelen >= sizeof(name) - 1)
647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
648 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
649 name[namelen++] = *s++;
653 while (isspace(*s)) s++;
655 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
662 while (isspace(*s)) s++;
664 /* If an existing macro of the same name was defined on the command line, we
665 just skip this definition. It's an error to attempt to redefine a macro without
666 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
667 It is also an error to define a macro whose name begins with the name of a
668 previously defined macro. This is the requirement that make using a tree
669 for macros hard; we must check all macros for the substring. Perhaps a
670 sorted list, and a bsearch, would work?
671 Note: it is documented that the other way round works. */
673 for (m = macros; m; m = m->next)
675 if (Ustrcmp(m->name, name) == 0)
677 if (!m->command_line && !redef)
678 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
679 "defined (use \"==\" if you want to redefine it", name);
683 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
684 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
685 "a macro because previously defined macro \"%s\" is a substring",
688 /* We cannot have this test, because it is documented that a substring
689 macro is permitted (there is even an example).
691 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
692 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
693 * "a macro because it is a substring of previously defined macro \"%s\"",
698 /* Check for an overriding command-line definition. */
700 if (m && m->command_line) return;
702 /* Redefinition must refer to an existing macro. */
707 m->replen = Ustrlen(s);
708 m->replacement = string_copy(s);
711 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
714 /* We have a new definition. */
716 (void) macro_create(string_copy(name), string_copy(s), FALSE);
723 /*************************************************
724 * Read configuration line *
725 *************************************************/
727 /* A logical line of text is read from the configuration file into the big
728 buffer, taking account of macros, .includes, and continuations. The size of
729 big_buffer is increased if necessary. The count of configuration lines is
730 maintained. Physical input lines starting with # (ignoring leading white space,
731 and after macro replacement) and empty logical lines are always ignored.
732 Leading and trailing spaces are removed.
734 If we hit a line of the form "begin xxxx", the xxxx is placed in the
735 next_section vector, and the function returns NULL, indicating the end of a
736 configuration section. On end-of-file, NULL is returned with next_section
741 Returns: a pointer to the first non-blank in the line,
742 or NULL if eof or end of section is reached
746 get_config_line(void)
748 int startoffset = 0; /* To first non-blank char in logical line */
749 int len = 0; /* Of logical line so far */
755 /* Loop for handling continuation lines, skipping comments, and dealing with
760 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
762 if (config_file_stack != NULL) /* EOF inside .include */
764 (void)fclose(config_file);
765 config_file = config_file_stack->file;
766 config_filename = config_file_stack->filename;
767 config_directory = config_file_stack->directory;
768 config_lineno = config_file_stack->lineno;
769 config_file_stack = config_file_stack->next;
771 save_config_position(config_filename, config_lineno);
775 /* EOF at top level */
777 if (cstate_stack_ptr >= 0)
778 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
779 "Unexpected end of configuration file: .endif missing");
781 if (len != 0) break; /* EOF after continuation */
782 next_section[0] = 0; /* EOF at start of logical line */
787 newlen = len + Ustrlen(big_buffer + len);
789 if (config_lines && config_lineno == 1)
790 save_config_position(config_filename, config_lineno);
792 /* Handle pathologically long physical lines - yes, it did happen - by
793 extending big_buffer at this point. The code also copes with very long
796 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
799 big_buffer_size += BIG_BUFFER_SIZE;
800 newbuffer = store_malloc(big_buffer_size);
802 /* This use of strcpy is OK because we know that the string in the old
803 buffer is shorter than the new buffer. */
805 Ustrcpy(newbuffer, big_buffer);
806 store_free(big_buffer);
807 big_buffer = newbuffer;
808 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
810 newlen += Ustrlen(big_buffer + newlen);
813 /* Find the true start of the physical line - leading spaces are always
816 ss = big_buffer + len;
817 while (isspace(*ss)) ss++;
819 /* Process the physical line for macros. If this is the start of the logical
820 line, skip over initial text at the start of the line if it starts with an
821 upper case character followed by a sequence of name characters and an equals
822 sign, because that is the definition of a new macro, and we don't do
823 replacement therein. */
826 if (len == 0 && isupper(*s))
828 while (isalnum(*s) || *s == '_') s++;
829 while (isspace(*s)) s++;
830 if (*s != '=') s = ss; /* Not a macro definition */
833 /* Skip leading chars which cannot start a macro name, to avoid multiple
834 pointless rescans in Ustrstr calls. */
836 while (*s && !isupper(*s) && *s != '_') s++;
838 /* For each defined macro, scan the line (from after XXX= if present),
839 replacing all occurrences of the macro. */
842 for (m = macros; m; m = m->next)
847 while ((p = Ustrstr(t, m->name)) != NULL)
851 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, ss); */
852 /* Expand the buffer if necessary */
854 while (newlen - m->namelen + m->replen + 1 > big_buffer_size)
856 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
857 uschar *newbuffer = store_malloc(newsize);
858 memcpy(newbuffer, big_buffer, newlen + 1);
859 p = newbuffer + (p - big_buffer);
860 s = newbuffer + (s - big_buffer);
861 ss = newbuffer + (ss - big_buffer);
862 t = newbuffer + (t - big_buffer);
863 big_buffer_size = newsize;
864 store_free(big_buffer);
865 big_buffer = newbuffer;
868 /* Shuffle the remaining characters up or down in the buffer before
869 copying in the replacement text. Don't rescan the replacement for this
873 if ((moveby = m->replen - m->namelen) != 0)
875 memmove(p + m->replen, pp, (big_buffer + newlen) - pp + 1);
878 Ustrncpy(p, m->replacement, m->replen);
880 while (*t && !isupper(*t) && *t != '_') t++;
885 /* An empty macro replacement at the start of a line could mean that ss no
886 longer points to the first non-blank character. */
888 while (isspace(*ss)) ss++;
890 /* Check for comment lines - these are physical lines. */
892 if (*ss == '#') continue;
894 /* Handle conditionals, which are also applied to physical lines. Conditions
895 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
896 expansion occured on the rest of the line. A preliminary test for the leading
897 '.' saves effort on most lines. */
903 /* Search the list of conditional directives */
905 for (i = 0; i < cond_list_size; i++)
908 cond_item *c = cond_list+i;
909 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
911 /* The following character must be white space or end of string */
913 n = ss[1 + c->namelen];
914 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
916 /* .ifdef and .ifndef push the current state onto the stack, then set
917 a new one from the table. Stack overflow is an error */
921 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
922 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
923 ".%s nested too deeply", c->name);
924 cstate_stack[++cstate_stack_ptr] = cstate;
925 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
928 /* For any of the others, stack underflow is an error. The next state
929 comes either from the stack (.endif) or from the table. */
933 if (cstate_stack_ptr < 0)
934 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
935 ".%s without matching .ifdef", c->name);
936 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
937 next_cstate[cstate][macro_found? c->action1 : c->action2];
940 /* Having dealt with a directive, break the loop */
945 /* If we have handled a conditional directive, continue with the next
946 physical line. Otherwise, fall through. */
948 if (i < cond_list_size) continue;
951 /* If the conditional state is not 0 (actively using these lines), ignore
954 if (cstate != 0) continue; /* Conditional skip */
956 /* Handle .include lines - these are also physical lines. */
958 if (Ustrncmp(ss, ".include", 8) == 0 &&
960 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
963 int include_if_exists = isspace(ss[8])? 0 : 10;
964 config_file_item *save;
967 ss += 9 + include_if_exists;
968 while (isspace(*ss)) ss++;
969 t = ss + Ustrlen(ss);
970 while (t > ss && isspace(t[-1])) t--;
971 if (*ss == '\"' && t[-1] == '\"')
978 /* We allow relative file names. For security reasons currently
979 relative names not allowed with .include_if_exists. For .include_if_exists
980 we need to check the permissions/ownership of the containing folder */
982 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
983 "absolute path \"%s\"", ss);
988 ss = string_append(NULL, &size, &offset, 3, config_directory, "/", ss);
989 ss[offset] = '\0'; /* string_append() does not zero terminate the string! */
992 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
995 save_config_position(config_filename, config_lineno);
996 save = store_get(sizeof(config_file_item));
997 save->next = config_file_stack;
998 config_file_stack = save;
999 save->file = config_file;
1000 save->filename = config_filename;
1001 save->directory = config_directory;
1002 save->lineno = config_lineno;
1004 if (!(config_file = Ufopen(ss, "rb")))
1005 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1006 "configuration file %s", ss);
1008 config_filename = string_copy(ss);
1009 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1014 /* If this is the start of the logical line, remember where the non-blank
1015 data starts. Otherwise shuffle down continuation lines to remove leading
1019 startoffset = ss - big_buffer;
1022 s = big_buffer + len;
1025 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1030 /* Accept the new addition to the line. Remove trailing white space. */
1033 while (len > 0 && isspace(big_buffer[len-1])) len--;
1034 big_buffer[len] = 0;
1036 /* We are done if the line does not end in backslash and contains some data.
1037 Empty logical lines are ignored. For continuations, remove the backslash and
1038 go round the loop to read the continuation line. */
1042 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1043 big_buffer[--len] = 0; /* Remove backslash */
1045 } /* Loop for reading multiple physical lines */
1047 /* We now have a logical line. Test for the end of a configuration section (or,
1048 more accurately, for the start of the next section). Place the name of the next
1049 section in next_section, and return NULL. If the name given is longer than
1050 next_section, truncate it. It will be unrecognized later, because all the known
1051 section names do fit. Leave space for pluralizing. */
1053 s = big_buffer + startoffset; /* First non-space character */
1056 save_config_line(s);
1058 if (strncmpic(s, US"begin ", 6) == 0)
1061 while (isspace(*s)) s++;
1062 if (big_buffer + len - s > sizeof(next_section) - 2)
1063 s[sizeof(next_section) - 2] = 0;
1064 Ustrcpy(next_section, s);
1068 /* Return the first non-blank character. */
1075 /*************************************************
1077 *************************************************/
1079 /* The yield is the pointer to the next uschar. Names longer than the
1080 output space are silently truncated. This function is also used from acl.c when
1084 name where to put the name
1088 Returns: new input pointer
1092 readconf_readname(uschar *name, int len, uschar *s)
1095 while (isspace(*s)) s++;
1098 while (isalnum(*s) || *s == '_')
1100 if (p < len-1) name[p++] = *s;
1105 while (isspace(*s)) s++;
1112 /*************************************************
1113 * Read a time value *
1114 *************************************************/
1116 /* This function is also called from outside, to read argument
1117 time values. The format of a time value is:
1119 [<n>w][<n>d][<n>h][<n>m][<n>s]
1121 as long as at least one is present. If a format error is encountered,
1122 return a negative value. The value must be terminated by the given
1127 terminator required terminating character
1128 return_msec if TRUE, allow fractional seconds and return milliseconds
1130 Returns: the time value, or -1 on syntax error
1131 value is seconds if return_msec is FALSE
1132 value is milliseconds if return_msec is TRUE
1136 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1144 if (!isdigit(*s)) return -1;
1145 (void)sscanf(CCS s, "%d%n", &value, &count);
1150 case 'w': value *= 7;
1151 case 'd': value *= 24;
1152 case 'h': value *= 60;
1153 case 'm': value *= 60;
1158 if (!return_msec) return -1;
1159 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1161 if (*s++ != 's') return -1;
1162 yield += (int)(fraction * 1000.0);
1168 if (return_msec) value *= 1000;
1170 if (*s == terminator) return yield;
1172 /* Control never reaches here. */
1177 /*************************************************
1178 * Read a fixed point value *
1179 *************************************************/
1181 /* The value is returned *1000
1185 terminator required terminator
1187 Returns: the value, or -1 on error
1191 readconf_readfixed(const uschar *s, int terminator)
1195 if (!isdigit(*s)) return -1;
1196 (void)sscanf(CS s, "%d%n", &value, &count);
1198 yield = value * 1000;
1202 while (isdigit((*(++s))))
1204 yield += (*s - '0') * m;
1209 return (*s == terminator)? yield : (-1);
1214 /*************************************************
1215 * Find option in list *
1216 *************************************************/
1218 /* The lists are always in order, so binary chop can be used.
1221 name the option name to search for
1222 ol the first entry in the option list
1223 last one more than the offset of the last entry in the option list
1225 Returns: pointer to an option entry, or NULL if not found
1229 find_option(uschar *name, optionlist *ol, int last)
1232 while (last > first)
1234 int middle = (first + last)/2;
1235 int c = Ustrcmp(name, ol[middle].name);
1237 if (c == 0) return ol + middle;
1238 else if (c > 0) first = middle + 1;
1246 /*************************************************
1247 * Find a set flag in option list *
1248 *************************************************/
1250 /* Because some versions of Unix make no restrictions on the values of uids and
1251 gids (even negative ones), we cannot represent "unset" by a special value.
1252 There is therefore a separate boolean variable for each one indicating whether
1253 a value is set or not. This function returns a pointer to the boolean, given
1254 the original option name. It is a major disaster if the flag cannot be found.
1257 name the name of the uid or gid option
1258 oltop points to the start of the relevant option list
1259 last one more than the offset of the last item in the option list
1260 data_block NULL when reading main options => data values in the option
1261 list are absolute addresses; otherwise they are byte offsets
1262 in data_block (used for driver options)
1264 Returns: a pointer to the boolean flag.
1268 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1272 sprintf(CS name2, "*set_%.50s", name);
1273 ol = find_option(name2, oltop, last);
1274 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1275 "Exim internal error: missing set flag for %s", name);
1276 return (data_block == NULL)? (BOOL *)(ol->value) :
1277 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1283 /*************************************************
1284 * Output extra characters message and die *
1285 *************************************************/
1287 /* Called when an option line has junk on the end. Sometimes this is because
1288 the sysadmin thinks comments are permitted.
1291 s points to the extra characters
1292 t1..t3 strings to insert in the log message
1294 Returns: doesn't return; dies
1298 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1300 uschar *comment = US"";
1301 if (*s == '#') comment = US" (# is comment only at line start)";
1302 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1303 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1308 /*************************************************
1309 * Read rewrite information *
1310 *************************************************/
1312 /* Each line of rewrite information contains:
1314 . A complete address in the form user@domain, possibly with
1315 leading * for each part; or alternatively, a regex.
1317 . A replacement string (which will be expanded).
1319 . An optional sequence of one-letter flags, indicating which
1320 headers etc. to apply this rule to.
1322 All this is decoded and placed into a control block. The OR of the flags is
1323 maintained in a common word.
1326 p points to the string that makes up the rule
1327 existflags points to the overall flag word
1328 isglobal TRUE if reading global rewrite rules
1330 Returns: the control block for the parsed rule.
1333 static rewrite_rule *
1334 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1336 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1339 next->key = string_dequote(&p);
1341 while (isspace(*p)) p++;
1343 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1344 "missing rewrite replacement string");
1347 next->replacement = string_dequote(&p);
1349 while (*p != 0) switch (*p++)
1351 case ' ': case '\t': break;
1353 case 'q': next->flags |= rewrite_quit; break;
1354 case 'w': next->flags |= rewrite_whole; break;
1356 case 'h': next->flags |= rewrite_all_headers; break;
1357 case 's': next->flags |= rewrite_sender; break;
1358 case 'f': next->flags |= rewrite_from; break;
1359 case 't': next->flags |= rewrite_to; break;
1360 case 'c': next->flags |= rewrite_cc; break;
1361 case 'b': next->flags |= rewrite_bcc; break;
1362 case 'r': next->flags |= rewrite_replyto; break;
1364 case 'E': next->flags |= rewrite_all_envelope; break;
1365 case 'F': next->flags |= rewrite_envfrom; break;
1366 case 'T': next->flags |= rewrite_envto; break;
1368 case 'Q': next->flags |= rewrite_qualify; break;
1369 case 'R': next->flags |= rewrite_repeat; break;
1372 next->flags |= rewrite_smtp;
1373 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1374 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1375 "rewrite rule has the S flag but is not a regular expression");
1379 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1380 "unknown rewrite flag character '%c' "
1381 "(could be missing quotes round replacement item)", p[-1]);
1385 /* If no action flags are set, set all the "normal" rewrites. */
1387 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1388 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1390 /* Remember which exist, for optimization, and return the rule */
1392 *existflags |= next->flags;
1399 /*************************************************
1400 * Read global rewrite information *
1401 *************************************************/
1403 /* Each line is a single rewrite rule; it is parsed into a control block
1404 by readconf_one_rewrite(), and its flags are ORed into the global flag
1405 word rewrite_existflags. */
1408 readconf_rewrites(void)
1410 rewrite_rule **chain = &global_rewrite_rules;
1413 while ((p = get_config_line()) != NULL)
1415 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1417 chain = &(next->next);
1423 /*************************************************
1425 *************************************************/
1427 /* Strings are read into the normal store pool. As long we aren't too
1428 near the end of the current block, the string will just use what is necessary
1429 on the top of the stacking pool, because string_cat() uses the extension
1433 s the rest of the input line
1434 name the option name (for errors)
1436 Returns: pointer to the string
1440 read_string(const uschar *s, const uschar *name)
1445 if (*s != '\"') return string_copy(s);
1448 yield = string_dequote(&s);
1450 if (s == ss+1 || s[-1] != '\"')
1451 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1452 "missing quote at end of string value for %s", name);
1454 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1460 /*************************************************
1461 * Custom-handler options *
1462 *************************************************/
1464 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1467 smtp_receive_timeout_s = string_copy(str);
1470 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1471 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1472 if (smtp_receive_timeout < 0)
1473 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1478 /*************************************************
1479 * Handle option line *
1480 *************************************************/
1482 /* This function is called from several places to process a line containing the
1483 setting of an option. The first argument is the line to be decoded; it has been
1484 checked not to be empty and not to start with '#'. Trailing newlines and white
1485 space have been removed. The second argument is a pointer to the list of
1486 variable names that are to be recognized, together with their types and
1487 locations, and the third argument gives the number of entries in the list.
1489 The fourth argument is a pointer to a data block. If it is NULL, then the data
1490 values in the options list are absolute addresses. Otherwise, they are byte
1491 offsets in the data block.
1493 String option data may continue onto several lines; this function reads further
1494 data from config_file if necessary.
1496 The yield of this function is normally zero. If a string continues onto
1497 multiple lines, then the data value is permitted to be followed by a comma
1498 or a semicolon (for use in drivers) and the yield is that character.
1501 buffer contains the configuration line to be handled
1502 oltop points to the start of the relevant option list
1503 last one more than the offset of the last item in the option list
1504 data_block NULL when reading main options => data values in the option
1505 list are absolute addresses; otherwise they are byte offsets
1506 in data_block when they have opt_public set; otherwise
1507 they are byte offsets in data_block->options_block.
1508 unknown_txt format string to use in panic message for unknown option;
1509 must contain %s for option name
1510 if given as NULL, don't panic on unknown option
1512 Returns: TRUE if an option was read successfully,
1513 FALSE false for an unknown option if unknown_txt == NULL,
1514 otherwise panic and die on an unknown option
1518 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1519 void *data_block, uschar *unknown_txt)
1523 int n, count, type, value;
1527 BOOL boolvalue = TRUE;
1528 BOOL freesptr = TRUE;
1529 optionlist *ol, *ol2;
1533 uschar *inttype = US"";
1536 uschar **str_target;
1540 /* There may be leading spaces; thereafter, we expect an option name starting
1543 while (isspace(*s)) s++;
1545 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1547 /* Read the name of the option, and skip any subsequent white space. If
1548 it turns out that what we read was "hide", set the flag indicating that
1549 this is a secure option, and loop to read the next word. */
1551 for (n = 0; n < 2; n++)
1553 while (isalnum(*s) || *s == '_')
1555 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1559 while (isspace(*s)) s++;
1560 if (Ustrcmp(name, "hide") != 0) break;
1561 issecure = opt_secure;
1565 /* Deal with "no_" or "not_" here for booleans */
1567 if (Ustrncmp(name, "no_", 3) == 0)
1573 if (Ustrncmp(name, "not_", 4) == 0)
1579 /* Search the list for the given name. A non-existent name, or an option that
1580 is set twice, is a disaster. */
1582 if (!(ol = find_option(name + offset, oltop, last)))
1584 if (unknown_txt == NULL) return FALSE;
1585 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1588 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1590 "\"%s\" option set for the second time", name);
1592 ol->type |= opt_set | issecure;
1593 type = ol->type & opt_mask;
1595 /* Types with data values must be followed by '='; the "no[t]_" prefix
1596 applies only to boolean values. */
1598 if (type < opt_bool || type > opt_bool_last)
1601 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1602 "negation prefix applied to a non-boolean option");
1604 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1605 "unexpected end of line (data missing) after %s", name);
1607 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1610 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1611 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1612 ultimately expands to one of those values. */
1614 else if (*s != 0 && (offset != 0 || *s != '='))
1615 extra_chars_error(s, US"boolean option ", name, US"");
1617 /* Skip white space after = */
1619 if (*s == '=') while (isspace((*(++s))));
1621 /* If there is a data block and the opt_public flag is not set, change
1622 the data block pointer to the private options block. */
1624 if (data_block != NULL && (ol->type & opt_public) == 0)
1625 data_block = (void *)(((driver_instance *)data_block)->options_block);
1627 /* Now get the data according to the type. */
1631 /* If a string value is not enclosed in quotes, it consists of
1632 the rest of the current line, verbatim. Otherwise, string escapes
1635 A transport is specified as a string, which is then looked up in the
1636 list of transports. A search type is specified as one of a number of
1639 A set or rewrite rules for a driver is specified as a string, which is
1640 then parsed into a suitable chain of control blocks.
1642 Uids and gids are specified as strings which are then looked up in the
1643 passwd file. Lists of uids and gids are similarly specified as colon-
1644 separated strings. */
1649 case opt_expand_uid:
1650 case opt_expand_gid:
1655 reset_point = sptr = read_string(s, name);
1657 /* Having read a string, we now have several different ways of using it,
1658 depending on the data type, so do another switch. If keeping the actual
1659 string is not required (because it is interpreted), freesptr is set TRUE,
1660 and at the end we reset the pool. */
1664 /* If this was a string, set the variable to point to the new string,
1665 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1666 rules, we still keep the string (for printing), and parse the rules into a
1667 control block and flags word. */
1670 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1672 if (ol->type & opt_rep_con)
1674 uschar * saved_condition;
1675 /* We already have a condition, we're conducting a crude hack to let
1676 multiple condition rules be chained together, despite storing them in
1678 *str_target = string_copy_malloc( (saved_condition = *str_target)
1679 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1680 saved_condition, sptr)
1682 /* TODO(pdp): there is a memory leak here and just below
1683 when we set 3 or more conditions; I still don't
1684 understand the store mechanism enough to know
1685 what's the safe way to free content from an earlier store.
1686 AFAICT, stores stack, so freeing an early stored item also stores
1687 all data alloc'd after it. If we knew conditions were adjacent,
1688 we could survive that, but we don't. So I *think* we need to take
1689 another bit from opt_type to indicate "malloced"; this seems like
1690 quite a hack, especially for this one case. It also means that
1691 we can't ever reclaim the store from the *first* condition.
1693 Because we only do this once, near process start-up, I'm prepared to
1694 let this slide for the time being, even though it rankles. */
1696 else if (ol->type & opt_rep_str)
1698 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1699 int sep_i = -(int)sep_o;
1700 const uschar * list = sptr;
1702 uschar * list_o = *str_target;
1703 int size = 0, len = 0;
1706 size = (len = Ustrlen(list_o)) + 1;
1708 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1709 list_o = string_append_listele(list_o, &size, &len, sep_o, s);
1711 *str_target = string_copy_malloc(list_o);
1722 *USS (US data_block + (long int)(ol->value)) = sptr;
1724 *USS (ol->value) = sptr;
1726 if (type == opt_rewrite)
1731 rewrite_rule **chain;
1734 sprintf(CS name2, "*%.50s_rules", name);
1735 ol2 = find_option(name2, oltop, last);
1736 sprintf(CS name2, "*%.50s_flags", name);
1737 ol3 = find_option(name2, oltop, last);
1739 if (ol2 == NULL || ol3 == NULL)
1740 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1741 "rewrite rules not available for driver");
1743 if (data_block == NULL)
1745 chain = (rewrite_rule **)(ol2->value);
1746 flagptr = (int *)(ol3->value);
1750 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1751 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1754 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1756 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1758 chain = &(next->next);
1761 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1763 "non-header rewrite - not allowed at transport time -");
1767 /* If it was an expanded uid, see if there is any expansion to be
1768 done by checking for the presence of a $ character. If there is, save it
1769 in the corresponding *expand_user option field. Otherwise, fall through
1770 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1773 case opt_expand_uid:
1774 sprintf(CS name2, "*expand_%.50s", name);
1775 ol2 = find_option(name2, oltop, last);
1778 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1780 if (data_block == NULL)
1781 *((uschar **)(ol2->value)) = ss;
1783 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1787 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1793 /* Look up a fixed uid, and also make use of the corresponding gid
1794 if a passwd entry is returned and the gid has not been set. */
1797 if (!route_finduser(sptr, &pw, &uid))
1798 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1799 if (data_block == NULL)
1800 *((uid_t *)(ol->value)) = uid;
1802 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1804 /* Set the flag indicating a fixed value is set */
1806 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1808 /* Handle matching gid if we have a passwd entry: done by finding the
1809 same name with terminating "user" changed to "group"; if not found,
1810 ignore. Also ignore if the value is already set. */
1812 if (pw == NULL) break;
1813 Ustrcpy(name+Ustrlen(name)-4, "group");
1814 ol2 = find_option(name, oltop, last);
1815 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1816 (ol2->type & opt_mask) == opt_expand_gid))
1818 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1821 if (data_block == NULL)
1822 *((gid_t *)(ol2->value)) = pw->pw_gid;
1824 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1830 /* If it was an expanded gid, see if there is any expansion to be
1831 done by checking for the presence of a $ character. If there is, save it
1832 in the corresponding *expand_user option field. Otherwise, fall through
1833 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1836 case opt_expand_gid:
1837 sprintf(CS name2, "*expand_%.50s", name);
1838 ol2 = find_option(name2, oltop, last);
1841 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1843 if (data_block == NULL)
1844 *((uschar **)(ol2->value)) = ss;
1846 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1850 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1856 /* Handle freestanding gid */
1859 if (!route_findgroup(sptr, &gid))
1860 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1861 if (data_block == NULL)
1862 *((gid_t *)(ol->value)) = gid;
1864 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1865 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1868 /* If it was a uid list, look up each individual entry, and build
1869 a vector of uids, with a count in the first element. Put the vector
1870 in malloc store so we can free the string. (We are reading into
1871 permanent store already.) */
1879 const uschar *op = expand_string (sptr);
1882 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1883 name, expand_string_message);
1886 if (*p != 0) count++;
1887 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1888 list = store_malloc(count*sizeof(uid_t));
1889 list[ptr++] = (uid_t)(count - 1);
1891 if (data_block == NULL)
1892 *((uid_t **)(ol->value)) = list;
1894 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1900 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1901 if (!route_finduser(big_buffer, NULL, &uid))
1902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1909 /* If it was a gid list, look up each individual entry, and build
1910 a vector of gids, with a count in the first element. Put the vector
1911 in malloc store so we can free the string. (We are reading into permanent
1920 const uschar *op = expand_string (sptr);
1923 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1924 name, expand_string_message);
1927 if (*p != 0) count++;
1928 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1929 list = store_malloc(count*sizeof(gid_t));
1930 list[ptr++] = (gid_t)(count - 1);
1932 if (data_block == NULL)
1933 *((gid_t **)(ol->value)) = list;
1935 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1941 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1942 if (!route_findgroup(big_buffer, &gid))
1943 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1951 /* Release store if the value of the string doesn't need to be kept. */
1953 if (freesptr) store_reset(reset_point);
1956 /* Expanded boolean: if no characters follow, or if there are no dollar
1957 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1958 save the string for later expansion in the alternate place. */
1960 case opt_expand_bool:
1961 if (*s != 0 && Ustrchr(s, '$') != 0)
1963 sprintf(CS name2, "*expand_%.50s", name);
1964 ol2 = find_option(name2, oltop, last);
1967 reset_point = sptr = read_string(s, name);
1968 if (data_block == NULL)
1969 *((uschar **)(ol2->value)) = sptr;
1971 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1978 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1979 look for yes/not/true/false. Some booleans are stored in a single bit in
1980 a single int. There's a special fudge for verify settings; without a suffix
1981 they set both xx_sender and xx_recipient. The table points to the sender
1982 value; search subsequently for the recipient. There's another special case:
1983 opt_bool_set also notes when a boolean has been set. */
1987 case opt_bool_verify:
1991 s = readconf_readname(name2, 64, s);
1992 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1994 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1996 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1997 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1998 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1999 US"for boolean option ", name);
2002 /* Handle single-bit type. */
2004 if (type == opt_bit)
2006 int bit = 1 << ((ol->type >> 16) & 31);
2007 int *ptr = (data_block == NULL)?
2008 (int *)(ol->value) :
2009 (int *)((uschar *)data_block + (long int)ol->value);
2010 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2014 /* Handle full BOOL types */
2016 if (data_block == NULL)
2017 *((BOOL *)(ol->value)) = boolvalue;
2019 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
2023 if (type == opt_bool_verify)
2025 sprintf(CS name2, "%.50s_recipient", name + offset);
2026 ol2 = find_option(name2, oltop, last);
2029 if (data_block == NULL)
2030 *((BOOL *)(ol2->value)) = boolvalue;
2032 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
2036 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2038 else if (type == opt_bool_set)
2040 sprintf(CS name2, "*set_%.50s", name + offset);
2041 ol2 = find_option(name2, oltop, last);
2044 if (data_block == NULL)
2045 *((BOOL *)(ol2->value)) = TRUE;
2047 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
2056 inttype = US"octal ";
2058 /* Integer: a simple(ish) case; allow octal and hex formats, and
2059 suffixes K, M and G. The different types affect output, not input. */
2068 lvalue = strtol(CS s, CSS &endptr, intbase);
2071 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2074 if (errno != ERANGE)
2075 if (tolower(*endptr) == 'k')
2077 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2078 else lvalue *= 1024;
2081 else if (tolower(*endptr) == 'm')
2083 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2085 else lvalue *= 1024*1024;
2088 else if (tolower(*endptr) == 'g')
2090 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2092 else lvalue *= 1024*1024*1024;
2096 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2098 "absolute value of integer \"%s\" is too large (overflow)", s);
2100 while (isspace(*endptr)) endptr++;
2102 extra_chars_error(endptr, inttype, US"integer value for ", name);
2104 value = (int)lvalue;
2107 if (data_block == NULL)
2108 *((int *)(ol->value)) = value;
2110 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2113 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2115 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2121 value = strtol(CS s, CSS &endptr, intbase);
2124 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2127 if (errno != ERANGE)
2128 if (tolower(*endptr) == 'g')
2130 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2136 else if (tolower(*endptr) == 'm')
2138 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2144 else if (tolower(*endptr) == 'k')
2147 value = (value + 512)/1024;
2149 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2150 "absolute value of integer \"%s\" is too large (overflow)", s);
2152 while (isspace(*endptr)) endptr++;
2154 extra_chars_error(endptr, inttype, US"integer value for ", name);
2157 if (data_block == NULL)
2158 *((int *)(ol->value)) = value;
2160 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2163 /* Fixed-point number: held to 3 decimal places. */
2166 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2167 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2168 "fixed-point number expected for %s", name);
2170 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2171 "integer \"%s\" is too large (overflow)", s);
2175 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2176 "integer \"%s\" is too large (overflow)", s);
2178 /* We get a coverity error here for using count, as it derived
2179 from the tainted buffer pointed to by s, as parsed by sscanf().
2180 By the definition of sscanf we must be accessing between start
2181 and end of s (assuming it is nul-terminated...) so ignore the error. */
2182 /* coverity[tainted_data] */
2183 if (s[count] == '.')
2186 while (isdigit(s[++count]))
2188 value += (s[count] - '0') * d;
2193 while (isspace(s[count])) count++;
2196 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2198 if (data_block == NULL)
2199 *((int *)(ol->value)) = value;
2201 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2204 /* There's a special routine to read time values. */
2207 value = readconf_readtime(s, 0, FALSE);
2209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2211 if (data_block == NULL)
2212 *((int *)(ol->value)) = value;
2214 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2217 /* A time list is a list of colon-separated times, with the first
2218 element holding the size of the list and the second the number of
2224 int *list = (data_block == NULL)?
2225 (int *)(ol->value) :
2226 (int *)((uschar *)data_block + (long int)(ol->value));
2228 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2231 uschar *snext = Ustrchr(s, ':');
2235 while (ss > s && isspace(ss[-1])) ss--;
2238 value = readconf_readtime(s, terminator, FALSE);
2240 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2242 if (count > 1 && value <= list[count])
2243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2244 "time value out of order for %s", name);
2245 list[count+1] = value;
2246 if (snext == NULL) break;
2248 while (isspace(*s)) s++;
2251 if (count > list[0] - 2)
2252 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2254 if (count > 0 && list[2] == 0) count = 0;
2261 void (*fn)() = ol->value;
2272 /*************************************************
2273 * Print a time value *
2274 *************************************************/
2277 Argument: a time value in seconds
2278 Returns: pointer to a fixed buffer containing the time as a string,
2279 in readconf_readtime() format
2283 readconf_printtime(int t)
2286 uschar *p = time_buffer;
2303 if (w > 0) p += sprintf(CS p, "%dw", w);
2304 if (d > 0) p += sprintf(CS p, "%dd", d);
2305 if (h > 0) p += sprintf(CS p, "%dh", h);
2306 if (m > 0) p += sprintf(CS p, "%dm", m);
2307 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2314 /*************************************************
2315 * Print an individual option value *
2316 *************************************************/
2318 /* This is used by the -bP option, so prints to the standard output.
2319 The entire options list is passed in as an argument, because some options come
2320 in pairs - typically uid/gid settings, which can either be explicit numerical
2321 values, or strings to be expanded later. If the numerical value is unset,
2322 search for "*expand_<name>" to see if there is a string equivalent.
2325 ol option entry, or NULL for an unknown option
2327 options_block NULL for main configuration options; otherwise points to
2328 a driver block; if the option doesn't have opt_public
2329 set, then options_block->options_block is where the item
2331 oltop points to the option list in which ol exists
2332 last one more than the offset of the last entry in optop
2333 no_labels do not show "foo = " at the start.
2339 print_ol(optionlist *ol, uschar *name, void *options_block,
2340 optionlist *oltop, int last, BOOL no_labels)
2353 printf("%s is not a known option\n", name);
2357 /* Non-admin callers cannot see options that have been flagged secure by the
2360 if (!admin_user && (ol->type & opt_secure) != 0)
2363 printf("%s\n", hidden);
2365 printf("%s = %s\n", name, hidden);
2369 /* Else show the value of the option */
2372 if (options_block != NULL)
2374 if ((ol->type & opt_public) == 0)
2375 options_block = (void *)(((driver_instance *)options_block)->options_block);
2376 value = (void *)((uschar *)options_block + (long int)value);
2379 switch(ol->type & opt_mask)
2382 case opt_rewrite: /* Show the text value */
2383 s = *((uschar **)value);
2384 if (!no_labels) printf("%s = ", name);
2385 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2389 if (!no_labels) printf("%s = ", name);
2390 printf("%d\n", *((int *)value));
2395 int x = *((int *)value);
2396 if (x != 0 && (x & 1023) == 0)
2400 if ((x & 1023) == 0)
2405 if (!no_labels) printf("%s = ", name);
2406 printf("%d%c\n", x, c);
2410 if (!no_labels) printf("%s = ", name);
2418 int x = *((int *)value);
2419 if (!no_labels) printf("%s = ", name);
2420 if (x == 0) printf("0\n");
2421 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2422 else printf("%dK\n", x);
2427 if (!no_labels) printf("%s = ", name);
2428 printf("%#o\n", *((int *)value));
2431 /* Can be negative only when "unset", in which case integer */
2435 int x = *((int *)value);
2438 if (x < 0) printf("%s =\n", name); else
2440 if (!no_labels) printf("%s = ", name);
2441 printf("%d.", x/1000);
2454 /* If the numerical value is unset, try for the string value */
2456 case opt_expand_uid:
2457 if (! *get_set_flag(name, oltop, last, options_block))
2459 sprintf(CS name2, "*expand_%.50s", name);
2460 ol2 = find_option(name2, oltop, last);
2463 void *value2 = ol2->value;
2464 if (options_block != NULL)
2465 value2 = (void *)((uschar *)options_block + (long int)value2);
2466 s = *((uschar **)value2);
2467 if (!no_labels) printf("%s = ", name);
2468 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2473 /* Else fall through */
2476 if (!no_labels) printf("%s = ", name);
2477 if (! *get_set_flag(name, oltop, last, options_block))
2481 pw = getpwuid(*((uid_t *)value));
2483 printf("%ld\n", (long int)(*((uid_t *)value)));
2484 else printf("%s\n", pw->pw_name);
2488 /* If the numerical value is unset, try for the string value */
2490 case opt_expand_gid:
2491 if (! *get_set_flag(name, oltop, last, options_block))
2493 sprintf(CS name2, "*expand_%.50s", name);
2494 ol2 = find_option(name2, oltop, last);
2495 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2497 void *value2 = ol2->value;
2498 if (options_block != NULL)
2499 value2 = (void *)((uschar *)options_block + (long int)value2);
2500 s = *((uschar **)value2);
2501 if (!no_labels) printf("%s = ", name);
2502 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2507 /* Else fall through */
2510 if (!no_labels) printf("%s = ", name);
2511 if (! *get_set_flag(name, oltop, last, options_block))
2515 gr = getgrgid(*((int *)value));
2517 printf("%ld\n", (long int)(*((int *)value)));
2518 else printf("%s\n", gr->gr_name);
2523 uidlist = *((uid_t **)value);
2524 if (!no_labels) printf("%s =", name);
2525 if (uidlist != NULL)
2529 if (no_labels) sep = '\0';
2530 for (i = 1; i <= (int)(uidlist[0]); i++)
2532 uschar *name = NULL;
2533 pw = getpwuid(uidlist[i]);
2534 if (pw != NULL) name = US pw->pw_name;
2535 if (sep != '\0') printf("%c", sep);
2536 if (name != NULL) printf("%s", name);
2537 else printf("%ld", (long int)(uidlist[i]));
2545 gidlist = *((gid_t **)value);
2546 if (!no_labels) printf("%s =", name);
2547 if (gidlist != NULL)
2551 if (no_labels) sep = '\0';
2552 for (i = 1; i <= (int)(gidlist[0]); i++)
2554 uschar *name = NULL;
2555 gr = getgrgid(gidlist[i]);
2556 if (gr != NULL) name = US gr->gr_name;
2557 if (sep != '\0') printf("%c", sep);
2558 if (name != NULL) printf("%s", name);
2559 else printf("%ld", (long int)(gidlist[i]));
2567 if (!no_labels) printf("%s = ", name);
2568 printf("%s\n", readconf_printtime(*((int *)value)));
2574 int *list = (int *)value;
2575 if (!no_labels) printf("%s = ", name);
2576 for (i = 0; i < list[1]; i++)
2577 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2583 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2587 case opt_expand_bool:
2588 sprintf(CS name2, "*expand_%.50s", name);
2589 ol2 = find_option(name2, oltop, last);
2590 if (ol2 != NULL && ol2->value != NULL)
2592 void *value2 = ol2->value;
2593 if (options_block != NULL)
2594 value2 = (void *)((uschar *)options_block + (long int)value2);
2595 s = *((uschar **)value2);
2598 if (!no_labels) printf("%s = ", name);
2599 printf("%s\n", string_printing(s));
2602 /* s == NULL => string not set; fall through */
2608 case opt_bool_verify:
2610 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2617 /*************************************************
2618 * Print value from main configuration *
2619 *************************************************/
2621 /* This function, called as a result of encountering the -bP option,
2622 causes the value of any main configuration variable to be output if the
2623 second argument is NULL. There are some special values:
2625 all print all main configuration options
2626 config_file print the name of the configuration file
2627 (configure_file will still work, for backward
2629 routers print the routers' configurations
2630 transports print the transports' configuration
2631 authenticators print the authenticators' configuration
2632 macros print the macros' configuration
2633 router_list print a list of router names
2634 transport_list print a list of transport names
2635 authenticator_list print a list of authentication mechanism names
2636 macro_list print a list of macro names
2637 +name print a named list item
2638 local_scan print the local_scan options
2639 config print the configuration as it is parsed
2640 environment print the used execution environment
2642 If the second argument is not NULL, it must be one of "router", "transport",
2643 "authenticator" or "macro" in which case the first argument identifies the
2644 driver whose options are to be printed.
2647 name option name if type == NULL; else driver name
2648 type NULL or driver type name, as described above
2649 no_labels avoid the "foo = " at the start of an item
2655 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2657 BOOL names_only = FALSE;
2659 optionlist *ol2 = NULL;
2660 driver_instance *d = NULL;
2671 static uschar *types[] = { US"address", US"domain", US"host",
2673 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2674 &hostlist_anchor, &localpartlist_anchor };
2676 for (i = 0; i < 4; i++)
2678 t = tree_search(*(anchors[i]), name+1);
2683 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2685 printf("%slist %s = %s\n", types[i], name+1,
2686 ((namedlist_block *)(t->data.ptr))->string);
2691 printf("no address, domain, host, or local part list called \"%s\" "
2692 "exists\n", name+1);
2697 if ( Ustrcmp(name, "configure_file") == 0
2698 || Ustrcmp(name, "config_file") == 0)
2700 printf("%s\n", CS config_main_filename);
2704 if (Ustrcmp(name, "all") == 0)
2706 for (ol = optionlist_config;
2707 ol < optionlist_config + nelem(optionlist_config); ol++)
2709 if ((ol->type & opt_hidden) == 0)
2710 print_ol(ol, US ol->name, NULL,
2711 optionlist_config, nelem(optionlist_config),
2717 if (Ustrcmp(name, "local_scan") == 0)
2719 #ifndef LOCAL_SCAN_HAS_OPTIONS
2720 printf("local_scan() options are not supported\n");
2722 for (ol = local_scan_options;
2723 ol < local_scan_options + local_scan_options_count; ol++)
2725 print_ol(ol, US ol->name, NULL, local_scan_options,
2726 local_scan_options_count, no_labels);
2732 if (Ustrcmp(name, "config") == 0)
2734 print_config(admin_user, no_labels);
2738 if (Ustrcmp(name, "routers") == 0)
2743 else if (Ustrcmp(name, "transports") == 0)
2745 type = US"transport";
2749 else if (Ustrcmp(name, "authenticators") == 0)
2751 type = US"authenticator";
2755 else if (Ustrcmp(name, "macros") == 0)
2761 else if (Ustrcmp(name, "router_list") == 0)
2768 else if (Ustrcmp(name, "transport_list") == 0)
2770 type = US"transport";
2775 else if (Ustrcmp(name, "authenticator_list") == 0)
2777 type = US"authenticator";
2782 else if (Ustrcmp(name, "macro_list") == 0)
2789 else if (Ustrcmp(name, "environment") == 0)
2794 for (p = USS environ; *p; p++) ;
2795 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2797 for (p = USS environ; *p; p++)
2800 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2809 print_ol(find_option(name, optionlist_config, nelem(optionlist_config)),
2810 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2815 /* Handle the options for a router or transport. Skip options that are flagged
2816 as hidden. Some of these are options with names starting with '*', used for
2817 internal alternative representations of other options (which the printing
2818 function will sort out). Others are synonyms kept for backward compatibility.
2821 if (Ustrcmp(type, "router") == 0)
2823 d = (driver_instance *)routers;
2824 ol2 = optionlist_routers;
2825 size = optionlist_routers_size;
2827 else if (Ustrcmp(type, "transport") == 0)
2829 d = (driver_instance *)transports;
2830 ol2 = optionlist_transports;
2831 size = optionlist_transports_size;
2833 else if (Ustrcmp(type, "authenticator") == 0)
2835 d = (driver_instance *)auths;
2836 ol2 = optionlist_auths;
2837 size = optionlist_auths_size;
2840 else if (Ustrcmp(type, "macro") == 0)
2842 /* People store passwords in macros and they were previously not available
2843 for printing. So we have an admin_users restriction. */
2846 fprintf(stderr, "exim: permission denied\n");
2849 for (m = macros; m; m = m->next)
2850 if (!name || Ustrcmp(name, m->name) == 0)
2853 printf("%s\n", CS m->name);
2855 printf("%s=%s\n", CS m->name, CS m->replacement);
2860 printf("%s %s not found\n", type, name);
2866 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2870 /* Either search for a given driver, or print all of them */
2872 for (; d != NULL; d = d->next)
2875 printf("\n%s %s:\n", d->name, type);
2876 else if (Ustrcmp(d->name, name) != 0) continue;
2878 for (ol = ol2; ol < ol2 + size; ol++)
2880 if ((ol->type & opt_hidden) == 0)
2881 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2884 for (ol = d->info->options;
2885 ol < d->info->options + *(d->info->options_count); ol++)
2887 if ((ol->type & opt_hidden) == 0)
2888 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2890 if (name != NULL) return;
2892 if (name != NULL) printf("%s %s not found\n", type, name);
2897 /*************************************************
2898 * Read a named list item *
2899 *************************************************/
2901 /* This function reads a name and a list (i.e. string). The name is used to
2902 save the list in a tree, sorted by its name. Each entry also has a number,
2903 which can be used for caching tests, but if the string contains any expansion
2904 items other than $key, the number is set negative to inhibit caching. This
2905 mechanism is used for domain, host, and address lists that are referenced by
2909 anchorp points to the tree anchor
2910 numberp points to the current number for this tree
2911 max the maximum number permitted
2912 s the text of the option line, starting immediately after the name
2914 tname the name of the list type, for messages
2920 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2923 BOOL forcecache = FALSE;
2926 namedlist_block *nb = store_get(sizeof(namedlist_block));
2928 if (Ustrncmp(s, "_cache", 6) == 0)
2935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2937 if (*numberp >= max)
2938 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2941 while (isspace(*s)) s++;
2943 while (isalnum(*s) || *s == '_') s++;
2944 t = store_get(sizeof(tree_node) + s-ss);
2945 Ustrncpy(t->name, ss, s-ss);
2947 while (isspace(*s)) s++;
2949 if (!tree_insertnode(anchorp, t))
2950 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2951 "duplicate name \"%s\" for a named %s", t->name, tname);
2954 nb->number = *numberp;
2957 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2958 "missing '=' after \"%s\"", t->name);
2959 while (isspace(*s)) s++;
2960 nb->string = read_string(s, t->name);
2961 nb->cache_data = NULL;
2963 /* Check the string for any expansions; if any are found, mark this list
2964 uncacheable unless the user has explicited forced caching. */
2966 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2972 /*************************************************
2973 * Unpick data for a rate limit *
2974 *************************************************/
2976 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2980 s string, in the form t,b,f,l
2981 where t is the threshold (integer)
2982 b is the initial delay (time)
2983 f is the multiplicative factor (fixed point)
2984 k is the maximum time (time)
2985 threshold where to store threshold
2986 base where to store base in milliseconds
2987 factor where to store factor in milliseconds
2988 limit where to store limit
2990 Returns: nothing (panics on error)
2994 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2997 uschar bstring[16], lstring[16];
2999 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3000 factor, lstring) == 4)
3002 *base = readconf_readtime(bstring, 0, TRUE);
3003 *limit = readconf_readtime(lstring, 0, TRUE);
3004 if (*base >= 0 && *limit >= 0) return;
3006 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3012 /*************************************************
3013 * Drop privs for checking TLS config *
3014 *************************************************/
3016 /* We want to validate TLS options during readconf, but do not want to be
3017 root when we call into the TLS library, in case of library linkage errors
3018 which cause segfaults; before this check, those were always done as the Exim
3019 runtime user and it makes sense to continue with that.
3021 Assumes: tls_require_ciphers has been set, if it will be
3022 exim_user has been set, if it will be
3023 exim_group has been set, if it will be
3025 Returns: bool for "okay"; false will cause caller to immediately exit.
3030 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3032 const uschar *errmsg;
3035 void (*oldsignal)(int);
3037 /* If TLS will never be used, no point checking ciphers */
3039 if ( !tls_advertise_hosts
3040 || !*tls_advertise_hosts
3041 || Ustrcmp(tls_advertise_hosts, ":") == 0
3044 else if (!nowarn && !tls_certificate)
3045 log_write(0, LOG_MAIN,
3046 "Warning: No server certificate defined; will use a selfsigned one.\n"
3047 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3049 oldsignal = signal(SIGCHLD, SIG_DFL);
3052 if ((pid = fork()) < 0)
3053 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3057 /* in some modes, will have dropped privilege already */
3059 exim_setugid(exim_uid, exim_gid, FALSE,
3060 US"calling tls_validate_require_cipher");
3062 if ((errmsg = tls_validate_require_cipher()))
3063 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3064 "tls_require_ciphers invalid: %s", errmsg);
3070 rc = waitpid(pid, &status, 0);
3071 } while (rc < 0 && errno == EINTR);
3074 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3077 signal(SIGCHLD, oldsignal);
3081 #endif /* SUPPORT_TLS */
3086 /*************************************************
3087 * Read main configuration options *
3088 *************************************************/
3090 /* This function is the first to be called for configuration reading. It
3091 opens the configuration file and reads general configuration settings until
3092 it reaches the end of the configuration section. The file is then left open so
3093 that the remaining configuration data can subsequently be read if needed for
3096 The configuration file must be owned either by root or exim, and be writeable
3097 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3098 in the config file, so the test is done on the compiled in values. A slight
3099 anomaly, to be carefully documented.
3101 The name of the configuration file is taken from a list that is included in the
3102 binary of Exim. It can be altered from the command line, but if that is done,
3103 root privilege is immediately withdrawn unless the caller is root or exim.
3104 The first file on the list that exists is used.
3106 For use on multiple systems that share file systems, first look for a
3107 configuration file whose name has the current node name on the end. If that is
3108 not found, try the generic name. For really contorted configurations, that run
3109 multiple Exims with different uid settings, first try adding the effective uid
3110 before the node name. These complications are going to waste resources on most
3111 systems. Therefore they are available only when requested by compile-time
3115 readconf_main(BOOL nowarn)
3118 struct stat statbuf;
3119 uschar *s, *filename;
3120 const uschar *list = config_main_filelist;
3122 /* Loop through the possible file names */
3124 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3127 /* Cut out all the fancy processing unless specifically wanted */
3129 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3130 uschar *suffix = filename + Ustrlen(filename);
3132 /* Try for the node-specific file if a node name exists */
3134 #ifdef CONFIGURE_FILE_USE_NODE
3136 if (uname(&uts) >= 0)
3138 #ifdef CONFIGURE_FILE_USE_EUID
3139 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3140 config_file = Ufopen(filename, "rb");
3141 if (config_file == NULL)
3142 #endif /* CONFIGURE_FILE_USE_EUID */
3144 sprintf(CS suffix, ".%.256s", uts.nodename);
3145 config_file = Ufopen(filename, "rb");
3148 #endif /* CONFIGURE_FILE_USE_NODE */
3150 /* Otherwise, try the generic name, possibly with the euid added */
3152 #ifdef CONFIGURE_FILE_USE_EUID
3153 if (config_file == NULL)
3155 sprintf(CS suffix, ".%ld", (long int)original_euid);
3156 config_file = Ufopen(filename, "rb");
3158 #endif /* CONFIGURE_FILE_USE_EUID */
3160 /* Finally, try the unadorned name */
3162 if (config_file == NULL)
3165 config_file = Ufopen(filename, "rb");
3167 #else /* if neither defined */
3169 /* This is the common case when the fancy processing is not included. */
3171 config_file = Ufopen(filename, "rb");
3174 /* If the file does not exist, continue to try any others. For any other
3175 error, break out (and die). */
3177 if (config_file != NULL || errno != ENOENT) break;
3180 /* On success, save the name for verification; config_filename is used when
3181 logging configuration errors (it changes for .included files) whereas
3182 config_main_filename is the name shown by -bP. Failure to open a configuration
3183 file is a serious disaster. */
3187 uschar *last_slash = Ustrrchr(filename, '/');
3188 config_filename = config_main_filename = string_copy(filename);
3190 /* The config_main_directory we need for the $config_dir expansion.
3191 config_main_filename we need for $config_file expansion.
3192 And config_dir is the directory of the current configuration, used for
3193 relative .includes. We do need to know it's name, as we change our working
3196 if (filename[0] == '/')
3197 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3200 /* relative configuration file name: working dir + / + basename(filename) */
3202 uschar buf[PATH_MAX];
3206 if (os_getcwd(buf, PATH_MAX) == NULL)
3208 perror("exim: getcwd");
3211 config_main_directory = string_cat(NULL, &size, &offset, buf);
3213 /* If the dir does not end with a "/", append one */
3214 if (config_main_directory[offset-1] != '/')
3215 config_main_directory = string_catn(config_main_directory, &size, &offset, US"/", 1);
3217 /* If the config file contains a "/", extract the directory part */
3219 config_main_directory = string_catn(config_main_directory, &size, &offset, filename, last_slash - filename);
3221 config_main_directory[offset] = '\0';
3223 config_directory = config_main_directory;
3227 if (filename == NULL)
3228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3229 "%s", config_main_filelist);
3231 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3232 "configuration file %s", filename));
3235 /* Now, once we found and opened our configuration file, we change the directory
3236 to a safe place. Later we change to $spool_directory. */
3238 if (Uchdir("/") < 0)
3240 perror("exim: chdir `/': ");
3244 /* Check the status of the file we have opened, if we have retained root
3245 privileges and the file isn't /dev/null (which *should* be 0666). */
3247 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3249 if (fstat(fileno(config_file), &statbuf) != 0)
3250 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3253 if ((statbuf.st_uid != root_uid /* owner not root */
3254 #ifdef CONFIGURE_OWNER
3255 && statbuf.st_uid != config_uid /* owner not the special one */
3258 (statbuf.st_gid != root_gid /* group not root & */
3259 #ifdef CONFIGURE_GROUP
3260 && statbuf.st_gid != config_gid /* group not the special one */
3262 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3264 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3266 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3267 "wrong owner, group, or mode", big_buffer);
3270 /* Process the main configuration settings. They all begin with a lower case
3271 letter. If we see something starting with an upper case letter, it is taken as
3272 a macro definition. */
3274 while ((s = get_config_line()) != NULL)
3277 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3278 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3279 "found unexpected BOM (Byte Order Mark)");
3281 if (isupper(s[0])) read_macro_assignment(s);
3283 else if (Ustrncmp(s, "domainlist", 10) == 0)
3284 read_named_list(&domainlist_anchor, &domainlist_count,
3285 MAX_NAMED_LIST, s+10, US"domain list");
3287 else if (Ustrncmp(s, "hostlist", 8) == 0)
3288 read_named_list(&hostlist_anchor, &hostlist_count,
3289 MAX_NAMED_LIST, s+8, US"host list");
3291 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3292 read_named_list(&addresslist_anchor, &addresslist_count,
3293 MAX_NAMED_LIST, s+11, US"address list");
3295 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3296 read_named_list(&localpartlist_anchor, &localpartlist_count,
3297 MAX_NAMED_LIST, s+13, US"local part list");
3300 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3301 NULL, US"main option \"%s\" unknown");
3305 /* If local_sender_retain is set, local_from_check must be unset. */
3307 if (local_sender_retain && local_from_check)
3308 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3309 "local_sender_retain are set; this combination is not allowed");
3311 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3314 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3316 /* The max retry interval must not be greater than 24 hours. */
3318 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3320 /* remote_max_parallel must be > 0 */
3322 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3324 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3325 start of a new SMTP message. */
3327 freeze_tell_config = freeze_tell;
3329 /* The primary host name may be required for expansion of spool_directory
3330 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3331 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3332 canonize it. Some people like upper case letters in their host names, so we
3333 don't force the case. */
3335 if (primary_hostname == NULL)
3337 const uschar *hostname;
3339 if (uname(&uts) < 0)
3340 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3341 hostname = US uts.nodename;
3343 if (Ustrchr(hostname, '.') == NULL)
3346 struct hostent *hostdata;
3349 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3350 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3351 MCL_DOMAIN, TRUE, NULL) != OK))
3360 #if HAVE_GETIPNODEBYNAME
3362 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3364 hostdata = gethostbyname2(CS hostname, af);
3367 hostdata = gethostbyname(CS hostname);
3370 if (hostdata != NULL)
3372 hostname = US hostdata->h_name;
3376 if (af == AF_INET) break;
3381 primary_hostname = string_copy(hostname);
3384 /* Set up default value for smtp_active_hostname */
3386 smtp_active_hostname = primary_hostname;
3388 /* If spool_directory wasn't set in the build-time configuration, it must have
3389 got set above. Of course, writing to the log may not work if log_file_path is
3390 not set, but it will at least get to syslog or somewhere, with any luck. */
3392 if (*spool_directory == 0)
3393 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3396 /* Expand the spool directory name; it may, for example, contain the primary
3397 host name. Same comment about failure. */
3399 s = expand_string(spool_directory);
3401 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3402 "\"%s\": %s", spool_directory, expand_string_message);
3403 spool_directory = s;
3405 /* Expand log_file_path, which must contain "%s" in any component that isn't
3406 the null string or "syslog". It is also allowed to contain one instance of %D
3407 or %M. However, it must NOT contain % followed by anything else. */
3409 if (*log_file_path != 0)
3411 const uschar *ss, *sss;
3412 int sep = ':'; /* Fixed for log file path */
3413 s = expand_string(log_file_path);
3415 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3416 "\"%s\": %s", log_file_path, expand_string_message);
3419 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3422 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3423 t = Ustrstr(sss, "%s");
3425 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3426 "contain \"%%s\"", sss);
3428 t = Ustrchr(sss, '%');
3431 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3432 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3433 "unexpected \"%%\" character", s);
3440 /* Interpret syslog_facility into an integer argument for 'ident' param to
3441 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3444 if (syslog_facility_str != NULL)
3447 uschar *s = syslog_facility_str;
3449 if ((Ustrlen(syslog_facility_str) >= 4) &&
3450 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3453 for (i = 0; i < syslog_list_size; i++)
3455 if (strcmpic(s, syslog_list[i].name) == 0)
3457 syslog_facility = syslog_list[i].value;
3462 if (i >= syslog_list_size)
3464 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3465 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3469 /* Expand pid_file_path */
3471 if (*pid_file_path != 0)
3473 s = expand_string(pid_file_path);
3475 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3476 "\"%s\": %s", pid_file_path, expand_string_message);
3480 /* Set default value of process_log_path */
3482 if (process_log_path == NULL || *process_log_path =='\0')
3483 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3485 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3488 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3490 /* Unpick the SMTP rate limiting options, if set */
3492 if (smtp_ratelimit_mail != NULL)
3494 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3495 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3498 if (smtp_ratelimit_rcpt != NULL)
3500 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3501 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3504 /* The qualify domains default to the primary host name */
3506 if (qualify_domain_sender == NULL)
3507 qualify_domain_sender = primary_hostname;
3508 if (qualify_domain_recipient == NULL)
3509 qualify_domain_recipient = qualify_domain_sender;
3511 /* Setting system_filter_user in the configuration sets the gid as well if a
3512 name is given, but a numerical value does not. */
3514 if (system_filter_uid_set && !system_filter_gid_set)
3516 struct passwd *pw = getpwuid(system_filter_uid);
3518 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3519 (long int)system_filter_uid);
3520 system_filter_gid = pw->pw_gid;
3521 system_filter_gid_set = TRUE;
3524 /* If the errors_reply_to field is set, check that it is syntactically valid
3525 and ensure it contains a domain. */
3527 if (errors_reply_to != NULL)
3530 int start, end, domain;
3531 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3532 &start, &end, &domain, FALSE);
3534 if (recipient == NULL)
3535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3536 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3540 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3543 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3544 smtp_accept_max must also be set. */
3546 if (smtp_accept_max == 0 &&
3547 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3548 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3549 "smtp_accept_max must be set if smtp_accept_queue or "
3550 "smtp_accept_max_per_host is set");
3552 /* Set up the host number if anything is specified. It is an expanded string
3553 so that it can be computed from the host name, for example. We do this last
3554 so as to ensure that everything else is set up before the expansion. */
3556 if (host_number_string != NULL)
3560 uschar *s = expand_string(host_number_string);
3562 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3563 "failed to expand localhost_number \"%s\": %s",
3564 host_number_string, expand_string_message);
3565 n = Ustrtol(s, &end, 0);
3566 while (isspace(*end)) end++;
3568 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3569 "localhost_number value is not a number: %s", s);
3570 if (n > LOCALHOST_MAX)
3571 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3572 "localhost_number is greater than the maximum allowed value (%d)",
3578 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3580 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3581 tls_verify_certificates == NULL)
3582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3583 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3584 (tls_verify_hosts != NULL)? "" : "try_");
3586 /* This also checks that the library linkage is working and we can call
3587 routines in it, so call even if tls_require_ciphers is unset */
3588 if (!tls_dropprivs_validate_require_cipher(nowarn))
3591 /* Magic number: at time of writing, 1024 has been the long-standing value
3592 used by so many clients, and what Exim used to use always, that it makes
3593 sense to just min-clamp this max-clamp at that. */
3594 if (tls_dh_max_bits < 1024)
3595 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3596 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3598 /* If openssl_options is set, validate it */
3599 if (openssl_options)
3602 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3603 "openssl_options is set but we're using GnuTLS");
3606 if (!tls_openssl_options_parse(openssl_options, &dummy))
3607 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3608 "openssl_options parse error: %s", openssl_options);
3611 #endif /*SUPPORT_TLS*/
3613 if (!nowarn && !keep_environment && environ && *environ)
3614 log_write(0, LOG_MAIN,
3615 "Warning: purging the environment.\n"
3616 " Suggested action: use keep_environment.");
3621 /*************************************************
3622 * Initialize one driver *
3623 *************************************************/
3625 /* This is called once the driver's generic options, if any, have been read.
3626 We can now find the driver, set up defaults for the private options, and
3627 unset any "set" bits in the private options table (which might have been
3628 set by another incarnation of the same driver).
3631 d pointer to driver instance block, with generic
3633 drivers_available vector of available drivers
3634 size_of_info size of each block in drivers_available
3635 class class of driver, for error message
3637 Returns: pointer to the driver info block
3640 static driver_info *
3641 init_driver(driver_instance *d, driver_info *drivers_available,
3642 int size_of_info, uschar *class)
3646 for (dd = drivers_available; dd->driver_name[0] != 0;
3647 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3649 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3652 int len = dd->options_len;
3654 d->options_block = store_get(len);
3655 memcpy(d->options_block, dd->options_block, len);
3656 for (i = 0; i < *(dd->options_count); i++)
3657 dd->options[i].type &= ~opt_set;
3662 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3663 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3665 return NULL; /* never obeyed */
3671 /*************************************************
3672 * Initialize driver list *
3673 *************************************************/
3675 /* This function is called for routers, transports, and authentication
3676 mechanisms. It reads the data from the current point in the configuration file
3677 up to the end of the section, and sets up a chain of instance blocks according
3678 to the file's contents. The file will already have been opened by a call to
3679 readconf_main, and must be left open for subsequent reading of further data.
3681 Any errors cause a panic crash. Note that the blocks with names driver_info and
3682 driver_instance must map the first portions of all the _info and _instance
3683 blocks for this shared code to work.
3686 class "router", "transport", or "authenticator"
3687 anchor &routers, &transports, &auths
3688 drivers_available available drivers
3689 size_of_info size of each info block
3690 instance_default points to default data for an instance
3691 instance_size size of instance block
3692 driver_optionlist generic option list
3693 driver_optionlist_count count of generic option list
3699 readconf_driver_init(
3701 driver_instance **anchor,
3702 driver_info *drivers_available,
3704 void *instance_default,
3706 optionlist *driver_optionlist,
3707 int driver_optionlist_count)
3709 driver_instance **p = anchor;
3710 driver_instance *d = NULL;
3713 while ((buffer = get_config_line()) != NULL)
3718 /* Read the first name on the line and test for the start of a new driver. A
3719 macro definition indicates the end of the previous driver. If this isn't the
3720 start of a new driver, the line will be re-read. */
3722 s = readconf_readname(name, sizeof(name), buffer);
3724 /* Handle macro definition, first finishing off the initialization of the
3725 previous driver, if any. */
3727 if (isupper(*name) && *s == '=')
3731 if (!d->driver_name)
3732 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3733 "no driver defined for %s \"%s\"", class, d->name);
3737 read_macro_assignment(buffer);
3741 /* If the line starts with a name terminated by a colon, we are at the
3742 start of the definition of a new driver. The rest of the line must be
3749 /* Finish off initializing the previous driver. */
3753 if (!d->driver_name)
3754 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3755 "no driver defined for %s \"%s\"", class, d->name);
3759 /* Check that we haven't already got a driver of this name */
3761 for (d = *anchor; d; d = d->next)
3762 if (Ustrcmp(name, d->name) == 0)
3763 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3764 "there are two %ss called \"%s\"", class, name);
3766 /* Set up a new driver instance data block on the chain, with
3767 its default values installed. */
3769 d = store_get(instance_size);
3770 memcpy(d, instance_default, instance_size);
3773 d->name = string_copy(name);
3775 /* Clear out the "set" bits in the generic options */
3777 for (i = 0; i < driver_optionlist_count; i++)
3778 driver_optionlist[i].type &= ~opt_set;
3780 /* Check nothing more on this line, then do the next loop iteration. */
3782 while (isspace(*s)) s++;
3783 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3787 /* Not the start of a new driver. Give an error if we have not set up a
3788 current driver yet. */
3791 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3793 /* First look to see if this is a generic option; if it is "driver",
3794 initialize the driver. If is it not a generic option, we can look for a
3795 private option provided that the driver has been previously set up. */
3797 if (readconf_handle_option(buffer, driver_optionlist,
3798 driver_optionlist_count, d, NULL))
3800 if (!d->info && d->driver_name)
3801 init_driver(d, drivers_available, size_of_info, class);
3804 /* Handle private options - pass the generic block because some may
3805 live therein. A flag with each option indicates if it is in the public
3809 readconf_handle_option(buffer, d->info->options,
3810 *(d->info->options_count), d, US"option \"%s\" unknown");
3812 /* The option is not generic and the driver name has not yet been given. */
3814 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3815 "(\"driver\" must be specified before any private options)", name);
3818 /* Run the initialization function for the final driver. */
3822 if (!d->driver_name)
3823 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3824 "no driver defined for %s \"%s\"", class, d->name);
3831 /*************************************************
3832 * Check driver dependency *
3833 *************************************************/
3835 /* This function is passed a driver instance and a string. It checks whether
3836 any of the string options for the driver contains the given string as an
3840 d points to a driver instance block
3841 s the string to search for
3843 Returns: TRUE if a dependency is found
3847 readconf_depends(driver_instance *d, uschar *s)
3849 int count = *(d->info->options_count);
3853 for (ol = d->info->options; ol < d->info->options + count; ol++)
3855 void *options_block;
3857 int type = ol->type & opt_mask;
3858 if (type != opt_stringptr) continue;
3859 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3860 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3861 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3863 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3864 isalnum(ss[Ustrlen(s)])) continue;
3865 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3866 d->name, ol->name, s);
3871 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3878 /*************************************************
3879 * Decode an error type for retries *
3880 *************************************************/
3882 /* This function is global because it is also called from the main
3883 program when testing retry information. It decodes strings such as "quota_7d"
3884 into numerical error codes.
3887 pp points to start of text
3888 p points past end of text
3889 basic_errno points to an int to receive the main error number
3890 more_errno points to an int to receive the secondary error data
3892 Returns: NULL if decoded correctly; else points to error text
3896 readconf_retry_error(const uschar *pp, const uschar *p,
3897 int *basic_errno, int *more_errno)
3900 const uschar *q = pp;
3901 while (q < p && *q != '_') q++;
3904 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3906 *basic_errno = ERRNO_EXIMQUOTA;
3907 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3908 return US"bad time value";
3911 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3913 *basic_errno = ECONNREFUSED;
3916 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3917 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3918 else return US"A or MX expected after \"refused\"";
3922 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3924 *basic_errno = ETIMEDOUT;
3928 int xlen = p - q - 1;
3929 const uschar *x = q + 1;
3931 static uschar *extras[] =
3932 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3933 static int values[] =
3934 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3936 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3937 if (strncmpic(x, extras[i], xlen) == 0)
3939 *more_errno = values[i];
3943 if (i >= sizeof(extras)/sizeof(uschar *))
3944 if (strncmpic(x, US"DNS", xlen) == 0)
3945 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3946 "available in retry rules (it has never worked) - treated as "
3949 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3953 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3954 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3955 strncmpic(pp, US"data_4", 6) == 0)
3958 int x = 255; /* means "any 4xx code" */
3959 if (p != pp + 8) bad = TRUE; else
3961 int a = pp[6], b = pp[7];
3965 if (isdigit(b)) x += b - '0';
3966 else if (b == 'x') x += 100;
3969 else if (a != 'x' || b != 'x') bad = TRUE;
3973 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3974 "x is literal and d is any digit", pp);
3976 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3977 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3978 *more_errno = x << 8;
3981 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3982 strncmpic(q+1, US"failed", p-q-1) == 0)
3983 *basic_errno = ERRNO_AUTHFAIL;
3985 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3986 *basic_errno = ERRNO_SMTPCLOSED;
3988 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3989 *basic_errno = ERRNO_TLSREQUIRED;
3991 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3992 *basic_errno = ERRNO_UNKNOWNHOST;
3994 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3995 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4003 /*************************************************
4004 * Read retry information *
4005 *************************************************/
4007 /* Each line of retry information contains:
4009 . A domain name pattern or an address pattern;
4011 . An error name, possibly with additional data, or *;
4013 . An optional sequence of retry items, each consisting of an identifying
4014 letter, a cutoff time, and optional parameters.
4016 All this is decoded and placed into a control block. */
4019 /* Subroutine to read an argument, preceded by a comma and terminated
4020 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4021 1 = fixed point number (returned *1000).
4024 paddr pointer to pointer to current character; updated
4025 type 0 => read a time; 1 => read a fixed point number
4027 Returns: time in seconds or fixed point number * 1000
4031 retry_arg(const uschar **paddr, int type)
4033 const uschar *p = *paddr;
4036 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4038 while (isspace(*p)) p++;
4040 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4042 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4043 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4048 case 0: return readconf_readtime(pp, *p, FALSE);
4049 case 1: return readconf_readfixed(pp, *p);
4051 return 0; /* Keep picky compilers happy */
4054 /* The function proper */
4057 readconf_retries(void)
4059 retry_config **chain = &retries;
4063 while ((p = get_config_line()))
4065 retry_rule **rchain;
4069 next = store_get(sizeof(retry_config));
4072 chain = &(next->next);
4073 next->basic_errno = next->more_errno = 0;
4074 next->senders = NULL;
4076 rchain = &(next->rules);
4078 next->pattern = string_dequote(&p);
4079 while (isspace(*p)) p++;
4081 while (mac_isgraph(*p)) p++;
4082 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4083 "missing error type in retry rule");
4085 /* Test error names for things we understand. */
4087 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4088 &next->more_errno)))
4089 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4091 /* There may be an optional address list of senders to be used as another
4092 constraint on the rule. This was added later, so the syntax is a bit of a
4093 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4096 while (isspace(*p)) p++;
4097 if (Ustrncmp(p, "senders", 7) == 0)
4100 while (isspace(*p)) p++;
4101 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4102 "\"=\" expected after \"senders\" in retry rule");
4103 while (isspace(*p)) p++;
4104 next->senders = string_dequote(&p);
4107 /* Now the retry rules. Keep the maximum timeout encountered. */
4109 while (isspace(*p)) p++;
4113 retry_rule *rule = store_get(sizeof(retry_rule));
4115 rchain = &(rule->next);
4117 rule->rule = toupper(*p++);
4118 rule->timeout = retry_arg(&p, 0);
4119 if (rule->timeout > retry_maximum_timeout)
4120 retry_maximum_timeout = rule->timeout;
4124 case 'F': /* Fixed interval */
4125 rule->p1 = retry_arg(&p, 0);
4128 case 'G': /* Geometrically increasing intervals */
4129 case 'H': /* Ditto, but with randomness */
4130 rule->p1 = retry_arg(&p, 0);
4131 rule->p2 = retry_arg(&p, 1);
4135 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4139 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4140 (rule->rule != 'F' && rule->p2 < 1000))
4141 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4142 "bad parameters for retry rule");
4144 while (isspace(*p)) p++;
4148 while (isspace(*p)) p++;
4151 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4158 /*************************************************
4159 * Initialize authenticators *
4160 *************************************************/
4162 /* Read the authenticators section of the configuration file.
4171 auth_instance *au, *bu;
4173 readconf_driver_init(US"authenticator",
4174 (driver_instance **)(&auths), /* chain anchor */
4175 (driver_info *)auths_available, /* available drivers */
4176 sizeof(auth_info), /* size of info block */
4177 &auth_defaults, /* default values for generic options */
4178 sizeof(auth_instance), /* size of instance block */
4179 optionlist_auths, /* generic options */
4180 optionlist_auths_size);
4182 for (au = auths; au; au = au->next)
4184 if (!au->public_name)
4185 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4186 "the %s authenticator", au->name);
4188 for (bu = au->next; bu; bu = bu->next)
4189 if (strcmpic(au->public_name, bu->public_name) == 0)
4190 if ((au->client && bu->client) || (au->server && bu->server))
4191 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4192 "(%s and %s) have the same public name (%s)",
4193 au->client ? US"client" : US"server", au->name, bu->name,
4201 /*************************************************
4202 * Read ACL information *
4203 *************************************************/
4205 /* If this run of Exim is not doing something that involves receiving a
4206 message, we can just skip over the ACL information. No need to parse it.
4208 First, we have a function for acl_read() to call back to get the next line. We
4209 need to remember the line we passed, because at the end it will contain the
4210 name of the next ACL. */
4212 static uschar *acl_line;
4217 acl_line = get_config_line();
4222 /* Now the main function:
4233 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4236 acl_line = get_config_line();
4238 while(acl_line != NULL)
4244 p = readconf_readname(name, sizeof(name), acl_line);
4245 if (isupper(*name) && *p == '=')
4247 read_macro_assignment(acl_line);
4248 acl_line = get_config_line();
4252 if (*p != ':' || name[0] == 0)
4253 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4255 node = store_get(sizeof(tree_node) + Ustrlen(name));
4256 Ustrcpy(node->name, name);
4257 if (!tree_insertnode(&acl_anchor, node))
4258 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4259 "there are two ACLs called \"%s\"", name);
4261 node->data.ptr = acl_read(acl_callback, &error);
4263 if (node->data.ptr == NULL && error != NULL)
4264 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4270 /*************************************************
4271 * Read configuration for local_scan() *
4272 *************************************************/
4274 /* This function is called after "begin local_scan" is encountered in the
4275 configuration file. If the local_scan() function allows for configuration
4276 options, we can process them. Otherwise, we expire in a panic.
4283 local_scan_init(void)
4285 #ifndef LOCAL_SCAN_HAS_OPTIONS
4286 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4287 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4291 while ((p = get_config_line()) != NULL)
4293 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4294 NULL, US"local_scan option \"%s\" unknown");
4301 /*************************************************
4302 * Read rest of configuration (after main) *
4303 *************************************************/
4305 /* This function reads the rest of the runtime configuration, after the main
4306 configuration. It is called only when actually needed. Each subsequent section
4307 of the configuration starts with a line of the form
4311 where the name is "routers", "transports", etc. A section is terminated by
4312 hitting the next "begin" line, and the next name is left in next_section.
4313 Because it may confuse people as to whether the names are singular or plural,
4314 we add "s" if it's missing. There is always enough room in next_section for
4315 this. This function is basically just a switch.
4321 static uschar *section_list[] = {
4335 while(next_section[0] != 0)
4339 int last = sizeof(section_list) / sizeof(uschar *);
4341 int n = Ustrlen(next_section);
4343 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4347 int c = strcmpic(next_section, section_list[mid]);
4349 if (c > 0) first = mid + 1; else last = mid;
4351 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4352 "\"%.*s\" is not a known configuration section name", n, next_section);
4353 mid = (last + first)/2;
4357 if (((had ^= bit) & bit) == 0)
4358 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4359 "\"%.*s\" section is repeated in the configuration file", n,
4364 case 0: readconf_acl(); break;
4365 case 1: auths_init(); break;
4366 case 2: local_scan_init(); break;
4367 case 3: readconf_retries(); break;
4368 case 4: readconf_rewrites(); break;
4369 case 5: route_init(); break;
4370 case 6: transport_init(); break;
4374 (void)fclose(config_file);
4377 /* Init the storage for the pre-parsed config lines */
4379 readconf_save_config(const uschar *s)
4381 save_config_line(string_sprintf("# Exim Configuration (%s)",
4382 running_in_test_harness ? US"X" : s));
4386 save_config_position(const uschar *file, int line)
4388 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4391 /* Append a pre-parsed logical line to the config lines store,
4392 this operates on a global (static) list that holds all the pre-parsed
4393 config lines, we do no further processing here, output formatting and
4394 honouring of <hide> or macros will be done during output */
4397 save_config_line(const uschar* line)
4399 static config_line_item *current;
4400 config_line_item *next;
4402 next = (config_line_item*) store_get(sizeof(config_line_item));
4403 next->line = string_copy(line);
4406 if (!config_lines) config_lines = next;
4407 else current->next = next;
4412 /* List the parsed config lines, care about nice formatting and
4413 hide the <hide> values unless we're the admin user */
4415 print_config(BOOL admin, BOOL terse)
4417 config_line_item *i;
4418 const int TS = terse ? 0 : 2;
4421 for (i = config_lines; i; i = i->next)
4426 /* skip over to the first non-space */
4427 for (current = i->line; *current && isspace(*current); ++current)
4430 if (*current == '\0')
4433 /* Collapse runs of spaces. We stop this if we encounter one of the
4434 * following characters: "'$, as this may indicate careful formatting */
4435 for (p = current; *p; ++p)
4438 if (!isspace(*p)) continue;
4439 if (*p != ' ') *p = ' ';
4441 for (next = p; isspace(*next); ++next)
4445 memmove(p+1, next, Ustrlen(next)+1);
4447 if (*next == '"' || *next == '\'' || *next == '$')
4452 if (current[0] == '#')
4455 /* begin lines are left aligned */
4456 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4458 if (!terse) puts("");
4463 /* router/acl/transport block names */
4464 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4466 if (!terse) puts("");
4467 printf("%*s%s\n", TS, "", current);
4471 /* hidden lines (all MACROS or lines prefixed with "hide") */
4473 && ( isupper(*current)
4474 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4478 if ((p = Ustrchr(current, '=')))
4481 printf("%*s%s= %s\n", indent, "", current, hidden);
4483 /* e.g.: hide split_spool_directory */
4485 printf("%*s\n", indent, hidden);
4489 /* rest is public */
4490 printf("%*s%s\n", indent, "", current);
4494 #endif /*!MACRO_PREDEF*/
4497 /* End of readconf.c */