1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
15 # include "macro_predef.h"
18 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_cname_loops", opt_int, &dns_cname_loops },
127 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
128 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
129 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
130 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
131 { "dns_retrans", opt_time, &dns_retrans },
132 { "dns_retry", opt_int, &dns_retry },
133 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
134 { "dns_use_edns0", opt_int, &dns_use_edns0 },
135 /* This option is now a no-op, retained for compatibility */
136 { "drop_cr", opt_bool, &drop_cr },
137 /*********************************************************/
138 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
139 { "dsn_from", opt_stringptr, &dsn_from },
140 { "envelope_to_remove", opt_bool, &envelope_to_remove },
141 { "errors_copy", opt_stringptr, &errors_copy },
142 { "errors_reply_to", opt_stringptr, &errors_reply_to },
143 #ifndef DISABLE_EVENT
144 { "event_action", opt_stringptr, &event_action },
146 { "exim_group", opt_gid, &exim_gid },
147 { "exim_path", opt_stringptr, &exim_path },
148 { "exim_user", opt_uid, &exim_uid },
149 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
150 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
151 { "finduser_retries", opt_int, &finduser_retries },
152 { "freeze_tell", opt_stringptr, &freeze_tell },
153 { "gecos_name", opt_stringptr, &gecos_name },
154 { "gecos_pattern", opt_stringptr, &gecos_pattern },
156 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
157 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
159 { "header_line_maxsize", opt_int, &header_line_maxsize },
160 { "header_maxsize", opt_int, &header_maxsize },
161 { "headers_charset", opt_stringptr, &headers_charset },
162 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
163 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
164 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
165 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
166 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
167 { "hold_domains", opt_stringptr, &hold_domains },
168 { "host_lookup", opt_stringptr, &host_lookup },
169 { "host_lookup_order", opt_stringptr, &host_lookup_order },
170 { "host_reject_connection", opt_stringptr, &host_reject_connection },
171 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
173 { "hosts_proxy", opt_stringptr, &hosts_proxy },
175 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
177 { "ibase_servers", opt_stringptr, &ibase_servers },
179 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
180 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
181 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
182 { "keep_environment", opt_stringptr, &keep_environment },
183 { "keep_malformed", opt_time, &keep_malformed },
185 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
186 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
187 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
188 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
189 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
190 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
191 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
192 { "ldap_start_tls", opt_bool, &eldap_start_tls },
193 { "ldap_version", opt_int, &eldap_version },
195 { "local_from_check", opt_bool, &local_from_check },
196 { "local_from_prefix", opt_stringptr, &local_from_prefix },
197 { "local_from_suffix", opt_stringptr, &local_from_suffix },
198 { "local_interfaces", opt_stringptr, &local_interfaces },
199 #ifdef HAVE_LOCAL_SCAN
200 { "local_scan_timeout", opt_time, &local_scan_timeout },
202 { "local_sender_retain", opt_bool, &local_sender_retain },
203 { "localhost_number", opt_stringptr, &host_number_string },
204 { "log_file_path", opt_stringptr, &log_file_path },
205 { "log_selector", opt_stringptr, &log_selector_string },
206 { "log_timezone", opt_bool, &log_timezone },
207 { "lookup_open_max", opt_int, &lookup_open_max },
208 { "max_username_length", opt_int, &max_username_length },
209 { "message_body_newlines", opt_bool, &message_body_newlines },
210 { "message_body_visible", opt_mkint, &message_body_visible },
211 { "message_id_header_domain", opt_stringptr, &message_id_domain },
212 { "message_id_header_text", opt_stringptr, &message_id_text },
213 { "message_logs", opt_bool, &message_logs },
214 { "message_size_limit", opt_stringptr, &message_size_limit },
215 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
216 { "move_frozen_messages", opt_bool, &move_frozen_messages },
218 { "mua_wrapper", opt_bool, &mua_wrapper },
220 { "mysql_servers", opt_stringptr, &mysql_servers },
222 { "never_users", opt_uidlist, &never_users },
224 { "openssl_options", opt_stringptr, &openssl_options },
227 { "oracle_servers", opt_stringptr, &oracle_servers },
229 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
231 { "perl_at_start", opt_bool, &opt_perl_at_start },
232 { "perl_startup", opt_stringptr, &opt_perl_startup },
233 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
236 { "pgsql_servers", opt_stringptr, &pgsql_servers },
238 { "pid_file_path", opt_stringptr, &pid_file_path },
239 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
241 { "prdr_enable", opt_bool, &prdr_enable },
243 { "preserve_message_logs", opt_bool, &preserve_message_logs },
244 { "primary_hostname", opt_stringptr, &primary_hostname },
245 { "print_topbitchars", opt_bool, &print_topbitchars },
246 { "process_log_path", opt_stringptr, &process_log_path },
247 { "prod_requires_admin", opt_bool, &prod_requires_admin },
248 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
249 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
250 { "queue_domains", opt_stringptr, &queue_domains },
251 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
252 { "queue_only", opt_bool, &queue_only },
253 { "queue_only_file", opt_stringptr, &queue_only_file },
254 { "queue_only_load", opt_fixed, &queue_only_load },
255 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
256 { "queue_only_override", opt_bool, &queue_only_override },
257 { "queue_run_in_order", opt_bool, &queue_run_in_order },
258 { "queue_run_max", opt_stringptr, &queue_run_max },
259 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
260 { "receive_timeout", opt_time, &receive_timeout },
261 { "received_header_text", opt_stringptr, &received_header_text },
262 { "received_headers_max", opt_int, &received_headers_max },
263 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
264 { "recipients_max", opt_int, &recipients_max },
265 { "recipients_max_reject", opt_bool, &recipients_max_reject },
267 { "redis_servers", opt_stringptr, &redis_servers },
269 { "remote_max_parallel", opt_int, &remote_max_parallel },
270 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
271 { "retry_data_expire", opt_time, &retry_data_expire },
272 { "retry_interval_max", opt_time, &retry_interval_max },
273 { "return_path_remove", opt_bool, &return_path_remove },
274 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
275 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
276 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
277 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
278 { "slow_lookup_log", opt_int, &slow_lookup_log },
279 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
280 { "smtp_accept_max", opt_int, &smtp_accept_max },
281 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
282 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
283 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
284 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
285 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
286 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
287 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
288 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
289 { "smtp_banner", opt_stringptr, &smtp_banner },
290 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
291 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
292 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
293 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
294 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
295 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
296 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
297 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
298 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
299 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
300 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
301 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
302 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
303 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
305 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
307 #ifdef WITH_CONTENT_SCAN
308 { "spamd_address", opt_stringptr, &spamd_address },
311 { "spf_guess", opt_stringptr, &spf_guess },
313 { "split_spool_directory", opt_bool, &split_spool_directory },
314 { "spool_directory", opt_stringptr, &spool_directory },
315 { "spool_wireformat", opt_bool, &spool_wireformat },
317 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
319 #ifdef EXPERIMENTAL_SRS
320 { "srs_config", opt_stringptr, &srs_config },
321 { "srs_hashlength", opt_int, &srs_hashlength },
322 { "srs_hashmin", opt_int, &srs_hashmin },
323 { "srs_maxage", opt_int, &srs_maxage },
324 { "srs_secrets", opt_stringptr, &srs_secrets },
325 { "srs_usehash", opt_bool, &srs_usehash },
326 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
328 { "strict_acl_vars", opt_bool, &strict_acl_vars },
329 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
330 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
331 { "syslog_duplication", opt_bool, &syslog_duplication },
332 { "syslog_facility", opt_stringptr, &syslog_facility_str },
333 { "syslog_pid", opt_bool, &syslog_pid },
334 { "syslog_processname", opt_stringptr, &syslog_processname },
335 { "syslog_timestamp", opt_bool, &syslog_timestamp },
336 { "system_filter", opt_stringptr, &system_filter },
337 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
338 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
339 { "system_filter_group", opt_gid, &system_filter_gid },
340 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
341 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
342 { "system_filter_user", opt_uid, &system_filter_uid },
343 { "tcp_nodelay", opt_bool, &tcp_nodelay },
344 #ifdef USE_TCP_WRAPPERS
345 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
347 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
348 { "timezone", opt_stringptr, &timezone_string },
349 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
351 # ifdef EXPERIMENTAL_REQUIRETLS
352 { "tls_advertise_requiretls", opt_stringptr, &tls_advertise_requiretls },
354 { "tls_certificate", opt_stringptr, &tls_certificate },
355 { "tls_crl", opt_stringptr, &tls_crl },
356 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
357 { "tls_dhparam", opt_stringptr, &tls_dhparam },
358 { "tls_eccurve", opt_stringptr, &tls_eccurve },
359 # ifndef DISABLE_OCSP
360 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
362 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
363 { "tls_privatekey", opt_stringptr, &tls_privatekey },
364 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
365 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
366 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
367 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
368 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
370 { "trusted_groups", opt_gidlist, &trusted_groups },
371 { "trusted_users", opt_uidlist, &trusted_users },
372 { "unknown_login", opt_stringptr, &unknown_login },
373 { "unknown_username", opt_stringptr, &unknown_username },
374 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
375 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
376 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
377 { "warn_message_file", opt_stringptr, &warn_message_file },
378 { "write_rejectlog", opt_bool, &write_rejectlog }
382 static int optionlist_config_size = nelem(optionlist_config);
388 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
393 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
399 struct auth_info * ai;
402 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
404 for (ai = auths_available; ai->driver_name[0]; ai++)
406 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
407 builtin_macro_create(buf);
408 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
413 #else /*!MACRO_PREDEF*/
415 extern char **environ;
417 static void save_config_line(const uschar* line);
418 static void save_config_position(const uschar *file, int line);
419 static void print_config(BOOL admin, BOOL terse);
422 #define CSTATE_STACK_SIZE 10
424 const uschar *config_directory = NULL;
427 /* Structure for chain (stack) of .included files */
429 typedef struct config_file_item {
430 struct config_file_item *next;
431 const uschar *filename;
432 const uschar *directory;
437 /* Structure for chain of configuration lines (-bP config) */
439 typedef struct config_line_item {
440 struct config_line_item *next;
444 static config_line_item* config_lines;
446 /* Structure of table of conditional words and their state transitions */
448 typedef struct cond_item {
456 /* Structure of table of syslog facility names and values */
458 typedef struct syslog_fac_item {
464 static const char * const hidden = "<value not displayable>";
466 /* Static variables */
468 static config_file_item *config_file_stack = NULL; /* For includes */
470 static uschar *syslog_facility_str = NULL;
471 static uschar next_section[24];
472 static uschar time_buffer[24];
474 /* State variables for conditional loading (.ifdef / .else / .endif) */
476 static int cstate = 0;
477 static int cstate_stack_ptr = -1;
478 static int cstate_stack[CSTATE_STACK_SIZE];
480 /* Table of state transitions for handling conditional inclusions. There are
481 four possible state transitions:
485 .elifdef true (or .else)
488 .endif just causes the previous cstate to be popped off the stack */
490 static int next_cstate[3][4] =
492 /* State 0: reading from file, or reading until next .else or .endif */
494 /* State 1: condition failed, skipping until next .else or .endif */
496 /* State 2: skipping until .endif */
500 /* Table of conditionals and the states to set. For each name, there are four
501 values: the length of the name (to save computing it each time), the state to
502 set if a macro was found in the line, the state to set if a macro was not found
503 in the line, and a stack manipulation setting which is:
505 -1 pull state value off the stack
506 0 don't alter the stack
507 +1 push value onto stack, before setting new state
510 static cond_item cond_list[] = {
511 { US"ifdef", 5, 0, 1, 1 },
512 { US"ifndef", 6, 1, 0, 1 },
513 { US"elifdef", 7, 2, 3, 0 },
514 { US"elifndef", 8, 3, 2, 0 },
515 { US"else", 4, 2, 2, 0 },
516 { US"endif", 5, 0, 0, -1 }
519 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
521 /* Table of syslog facility names and their values */
523 static syslog_fac_item syslog_list[] = {
524 { US"mail", LOG_MAIL },
525 { US"user", LOG_USER },
526 { US"news", LOG_NEWS },
527 { US"uucp", LOG_UUCP },
528 { US"local0", LOG_LOCAL0 },
529 { US"local1", LOG_LOCAL1 },
530 { US"local2", LOG_LOCAL2 },
531 { US"local3", LOG_LOCAL3 },
532 { US"local4", LOG_LOCAL4 },
533 { US"local5", LOG_LOCAL5 },
534 { US"local6", LOG_LOCAL6 },
535 { US"local7", LOG_LOCAL7 },
536 { US"daemon", LOG_DAEMON }
539 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
544 /*************************************************
545 * Find the name of an option *
546 *************************************************/
548 /* This function is to aid debugging. Various functions take arguments that are
549 pointer variables in the options table or in option tables for various drivers.
550 For debugging output, it is useful to be able to find the name of the option
551 which is currently being processed. This function finds it, if it exists, by
552 searching the table(s).
554 Arguments: a value that is presumed to be in the table above
555 Returns: the option name, or an empty string
559 readconf_find_option(void *p)
563 transport_instance *t;
565 for (i = 0; i < nelem(optionlist_config); i++)
566 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
568 for (r = routers; r; r = r->next)
570 router_info *ri = r->info;
571 for (i = 0; i < *ri->options_count; i++)
573 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
574 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
575 return US ri->options[i].name;
579 for (t = transports; t; t = t->next)
581 transport_info *ti = t->info;
582 for (i = 0; i < *ti->options_count; i++)
584 optionlist * op = &ti->options[i];
585 if ((op->type & opt_mask) != opt_stringptr) continue;
586 if (p == ( op->type & opt_public
588 : CS t->options_block
590 + (long int)op->value)
601 /*************************************************
602 * Deal with an assignment to a macro *
603 *************************************************/
605 /* We have a new definition; append to the list.
608 name Name of the macro; will be copied
609 val Expansion result for the macro; will be copied
613 macro_create(const uschar * name, const uschar * val, BOOL command_line)
615 macro_item * m = store_get(sizeof(macro_item));
617 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val); */
619 m->command_line = command_line;
620 m->namelen = Ustrlen(name);
621 m->replen = Ustrlen(val);
622 m->name = string_copy(name);
623 m->replacement = string_copy(val);
635 /* This function is called when a line that starts with an upper case letter is
636 encountered. The argument "line" should contain a complete logical line, and
637 start with the first letter of the macro name. The macro name and the
638 replacement text are extracted and stored. Redefinition of existing,
639 non-command line, macros is permitted using '==' instead of '='.
642 s points to the start of the logical line
644 Returns: FALSE iff fatal error
648 macro_read_assignment(uschar *s)
655 while (isalnum(*s) || *s == '_')
657 if (namelen >= sizeof(name) - 1)
659 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
660 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
663 name[namelen++] = *s++;
667 while (isspace(*s)) s++;
670 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
679 while (isspace(*s)) s++;
681 /* If an existing macro of the same name was defined on the command line, we
682 just skip this definition. It's an error to attempt to redefine a macro without
683 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
684 It is also an error to define a macro whose name begins with the name of a
685 previously defined macro. This is the requirement that make using a tree
686 for macros hard; we must check all macros for the substring. Perhaps a
687 sorted list, and a bsearch, would work?
688 Note: it is documented that the other way round works. */
690 for (m = macros; m; m = m->next)
692 if (Ustrcmp(m->name, name) == 0)
694 if (!m->command_line && !redef)
696 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
697 "defined (use \"==\" if you want to redefine it)", name);
703 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
705 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
706 "a macro because previously defined macro \"%s\" is a substring",
711 /* We cannot have this test, because it is documented that a substring
712 macro is permitted (there is even an example).
714 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
715 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
716 * "a macro because it is a substring of previously defined macro \"%s\"",
721 /* Check for an overriding command-line definition. */
723 if (m && m->command_line) return TRUE;
725 /* Redefinition must refer to an existing macro. */
730 m->replen = Ustrlen(s);
731 m->replacement = string_copy(s);
735 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
740 /* We have a new definition. */
742 (void) macro_create(name, s, FALSE);
750 /* Process line for macros. The line is in big_buffer starting at offset len.
751 Expand big_buffer if needed. Handle definitions of new macros, and
752 macro expansions, rewriting the line in the buffer.
755 len Offset in buffer of start of line
756 newlen Pointer to offset of end of line, updated on return
757 macro_found Pointer to return that a macro was expanded
759 Return: pointer to first nonblank char in line
763 macros_expand(int len, int * newlen, BOOL * macro_found)
765 uschar * ss = big_buffer + len;
769 /* Find the true start of the physical line - leading spaces are always
772 while (isspace(*ss)) ss++;
774 /* Process the physical line for macros. If this is the start of the logical
775 line, skip over initial text at the start of the line if it starts with an
776 upper case character followed by a sequence of name characters and an equals
777 sign, because that is the definition of a new macro, and we don't do
778 replacement therein. */
781 if (len == 0 && isupper(*s))
783 while (isalnum(*s) || *s == '_') s++;
784 while (isspace(*s)) s++;
785 if (*s != '=') s = ss; /* Not a macro definition */
788 /* Skip leading chars which cannot start a macro name, to avoid multiple
789 pointless rescans in Ustrstr calls. */
791 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
793 /* For each defined macro, scan the line (from after XXX= if present),
794 replacing all occurrences of the macro. */
796 *macro_found = FALSE;
797 if (*s) for (m = *s == '_' ? macros : macros_user; m; m = m->next)
802 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
806 while ((p = Ustrstr(t, m->name)) != NULL)
810 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, ss); */
811 /* Expand the buffer if necessary */
813 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
815 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
816 uschar *newbuffer = store_malloc(newsize);
817 memcpy(newbuffer, big_buffer, *newlen + 1);
818 p = newbuffer + (p - big_buffer);
819 s = newbuffer + (s - big_buffer);
820 ss = newbuffer + (ss - big_buffer);
821 t = newbuffer + (t - big_buffer);
822 big_buffer_size = newsize;
823 store_free(big_buffer);
824 big_buffer = newbuffer;
827 /* Shuffle the remaining characters up or down in the buffer before
828 copying in the replacement text. Don't rescan the replacement for this
832 if ((moveby = m->replen - m->namelen) != 0)
834 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
837 Ustrncpy(p, m->replacement, m->replen);
839 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
844 /* An empty macro replacement at the start of a line could mean that ss no
845 longer points to the first non-blank character. */
847 while (isspace(*ss)) ss++;
851 /*************************************************
852 * Read configuration line *
853 *************************************************/
855 /* A logical line of text is read from the configuration file into the big
856 buffer, taking account of macros, .includes, and continuations. The size of
857 big_buffer is increased if necessary. The count of configuration lines is
858 maintained. Physical input lines starting with # (ignoring leading white space,
859 and after macro replacement) and empty logical lines are always ignored.
860 Leading and trailing spaces are removed.
862 If we hit a line of the form "begin xxxx", the xxxx is placed in the
863 next_section vector, and the function returns NULL, indicating the end of a
864 configuration section. On end-of-file, NULL is returned with next_section
869 Returns: a pointer to the first non-blank in the line,
870 or NULL if eof or end of section is reached
874 get_config_line(void)
876 int startoffset = 0; /* To first non-blank char in logical line */
877 int len = 0; /* Of logical line so far */
882 /* Loop for handling continuation lines, skipping comments, and dealing with
887 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
889 if (config_file_stack != NULL) /* EOF inside .include */
891 (void)fclose(config_file);
892 config_file = config_file_stack->file;
893 config_filename = config_file_stack->filename;
894 config_directory = config_file_stack->directory;
895 config_lineno = config_file_stack->lineno;
896 config_file_stack = config_file_stack->next;
898 save_config_position(config_filename, config_lineno);
902 /* EOF at top level */
904 if (cstate_stack_ptr >= 0)
905 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
906 "Unexpected end of configuration file: .endif missing");
908 if (len != 0) break; /* EOF after continuation */
909 next_section[0] = 0; /* EOF at start of logical line */
914 newlen = len + Ustrlen(big_buffer + len);
916 if (config_lines && config_lineno == 1)
917 save_config_position(config_filename, config_lineno);
919 /* Handle pathologically long physical lines - yes, it did happen - by
920 extending big_buffer at this point. The code also copes with very long
923 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
926 big_buffer_size += BIG_BUFFER_SIZE;
927 newbuffer = store_malloc(big_buffer_size);
929 /* This use of strcpy is OK because we know that the string in the old
930 buffer is shorter than the new buffer. */
932 Ustrcpy(newbuffer, big_buffer);
933 store_free(big_buffer);
934 big_buffer = newbuffer;
935 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
937 newlen += Ustrlen(big_buffer + newlen);
940 ss = macros_expand(len, &newlen, ¯o_found);
942 /* Check for comment lines - these are physical lines. */
944 if (*ss == '#') continue;
946 /* Handle conditionals, which are also applied to physical lines. Conditions
947 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
948 expansion occured on the rest of the line. A preliminary test for the leading
949 '.' saves effort on most lines. */
955 /* Search the list of conditional directives */
957 for (i = 0; i < cond_list_size; i++)
960 cond_item *c = cond_list+i;
961 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
963 /* The following character must be white space or end of string */
965 n = ss[1 + c->namelen];
966 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
968 /* .ifdef and .ifndef push the current state onto the stack, then set
969 a new one from the table. Stack overflow is an error */
973 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
974 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
975 ".%s nested too deeply", c->name);
976 cstate_stack[++cstate_stack_ptr] = cstate;
977 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
980 /* For any of the others, stack underflow is an error. The next state
981 comes either from the stack (.endif) or from the table. */
985 if (cstate_stack_ptr < 0)
986 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
987 ".%s without matching .ifdef", c->name);
988 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
989 next_cstate[cstate][macro_found? c->action1 : c->action2];
992 /* Having dealt with a directive, break the loop */
997 /* If we have handled a conditional directive, continue with the next
998 physical line. Otherwise, fall through. */
1000 if (i < cond_list_size) continue;
1003 /* If the conditional state is not 0 (actively using these lines), ignore
1006 if (cstate != 0) continue; /* Conditional skip */
1008 /* Handle .include lines - these are also physical lines. */
1010 if (Ustrncmp(ss, ".include", 8) == 0 &&
1012 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1015 int include_if_exists = isspace(ss[8])? 0 : 10;
1016 config_file_item *save;
1017 struct stat statbuf;
1019 ss += 9 + include_if_exists;
1020 while (isspace(*ss)) ss++;
1021 t = ss + Ustrlen(ss);
1022 while (t > ss && isspace(t[-1])) t--;
1023 if (*ss == '\"' && t[-1] == '\"')
1030 /* We allow relative file names. For security reasons currently
1031 relative names not allowed with .include_if_exists. For .include_if_exists
1032 we need to check the permissions/ownership of the containing folder */
1034 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1035 "absolute path \"%s\"", ss);
1038 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1039 ss = string_from_gstring(g);
1042 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1045 save_config_position(config_filename, config_lineno);
1046 save = store_get(sizeof(config_file_item));
1047 save->next = config_file_stack;
1048 config_file_stack = save;
1049 save->file = config_file;
1050 save->filename = config_filename;
1051 save->directory = config_directory;
1052 save->lineno = config_lineno;
1054 if (!(config_file = Ufopen(ss, "rb")))
1055 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1056 "configuration file %s", ss);
1058 config_filename = string_copy(ss);
1059 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1064 /* If this is the start of the logical line, remember where the non-blank
1065 data starts. Otherwise shuffle down continuation lines to remove leading
1069 startoffset = ss - big_buffer;
1072 s = big_buffer + len;
1075 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1080 /* Accept the new addition to the line. Remove trailing white space. */
1083 while (len > 0 && isspace(big_buffer[len-1])) len--;
1084 big_buffer[len] = 0;
1086 /* We are done if the line does not end in backslash and contains some data.
1087 Empty logical lines are ignored. For continuations, remove the backslash and
1088 go round the loop to read the continuation line. */
1092 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1093 big_buffer[--len] = 0; /* Remove backslash */
1095 } /* Loop for reading multiple physical lines */
1097 /* We now have a logical line. Test for the end of a configuration section (or,
1098 more accurately, for the start of the next section). Place the name of the next
1099 section in next_section, and return NULL. If the name given is longer than
1100 next_section, truncate it. It will be unrecognized later, because all the known
1101 section names do fit. Leave space for pluralizing. */
1103 s = big_buffer + startoffset; /* First non-space character */
1106 save_config_line(s);
1108 if (strncmpic(s, US"begin ", 6) == 0)
1111 while (isspace(*s)) s++;
1112 if (big_buffer + len - s > sizeof(next_section) - 2)
1113 s[sizeof(next_section) - 2] = 0;
1114 Ustrcpy(next_section, s);
1118 /* Return the first non-blank character. */
1125 /*************************************************
1127 *************************************************/
1129 /* The yield is the pointer to the next uschar. Names longer than the
1130 output space are silently truncated. This function is also used from acl.c when
1134 name where to put the name
1138 Returns: new input pointer
1142 readconf_readname(uschar *name, int len, uschar *s)
1145 while (isspace(*s)) s++;
1148 while (isalnum(*s) || *s == '_')
1150 if (p < len-1) name[p++] = *s;
1155 while (isspace(*s)) s++;
1162 /*************************************************
1163 * Read a time value *
1164 *************************************************/
1166 /* This function is also called from outside, to read argument
1167 time values. The format of a time value is:
1169 [<n>w][<n>d][<n>h][<n>m][<n>s]
1171 as long as at least one is present. If a format error is encountered,
1172 return a negative value. The value must be terminated by the given
1177 terminator required terminating character
1178 return_msec if TRUE, allow fractional seconds and return milliseconds
1180 Returns: the time value, or -1 on syntax error
1181 value is seconds if return_msec is FALSE
1182 value is milliseconds if return_msec is TRUE
1186 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1194 if (!isdigit(*s)) return -1;
1195 (void)sscanf(CCS s, "%d%n", &value, &count);
1200 case 'w': value *= 7;
1201 case 'd': value *= 24;
1202 case 'h': value *= 60;
1203 case 'm': value *= 60;
1208 if (!return_msec) return -1;
1209 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1211 if (*s++ != 's') return -1;
1212 yield += (int)(fraction * 1000.0);
1218 if (return_msec) value *= 1000;
1220 if (*s == terminator) return yield;
1222 /* Control never reaches here. */
1227 /*************************************************
1228 * Read a fixed point value *
1229 *************************************************/
1231 /* The value is returned *1000
1235 terminator required terminator
1237 Returns: the value, or -1 on error
1241 readconf_readfixed(const uschar *s, int terminator)
1245 if (!isdigit(*s)) return -1;
1246 (void)sscanf(CS s, "%d%n", &value, &count);
1248 yield = value * 1000;
1252 while (isdigit((*(++s))))
1254 yield += (*s - '0') * m;
1259 return (*s == terminator)? yield : (-1);
1264 /*************************************************
1265 * Find option in list *
1266 *************************************************/
1268 /* The lists are always in order, so binary chop can be used.
1271 name the option name to search for
1272 ol the first entry in the option list
1273 last one more than the offset of the last entry in the option list
1275 Returns: pointer to an option entry, or NULL if not found
1279 find_option(uschar *name, optionlist *ol, int last)
1282 while (last > first)
1284 int middle = (first + last)/2;
1285 int c = Ustrcmp(name, ol[middle].name);
1287 if (c == 0) return ol + middle;
1288 else if (c > 0) first = middle + 1;
1296 /*************************************************
1297 * Find a set flag in option list *
1298 *************************************************/
1300 /* Because some versions of Unix make no restrictions on the values of uids and
1301 gids (even negative ones), we cannot represent "unset" by a special value.
1302 There is therefore a separate boolean variable for each one indicating whether
1303 a value is set or not. This function returns a pointer to the boolean, given
1304 the original option name. It is a major disaster if the flag cannot be found.
1307 name the name of the uid or gid option
1308 oltop points to the start of the relevant option list
1309 last one more than the offset of the last item in the option list
1310 data_block NULL when reading main options => data values in the option
1311 list are absolute addresses; otherwise they are byte offsets
1312 in data_block (used for driver options)
1314 Returns: a pointer to the boolean flag.
1318 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1322 sprintf(CS name2, "*set_%.50s", name);
1323 ol = find_option(name2, oltop, last);
1324 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1325 "Exim internal error: missing set flag for %s", name);
1326 return (data_block == NULL)? (BOOL *)(ol->value) :
1327 (BOOL *)(US data_block + (long int)(ol->value));
1333 /*************************************************
1334 * Output extra characters message and die *
1335 *************************************************/
1337 /* Called when an option line has junk on the end. Sometimes this is because
1338 the sysadmin thinks comments are permitted.
1341 s points to the extra characters
1342 t1..t3 strings to insert in the log message
1344 Returns: doesn't return; dies
1348 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1350 uschar *comment = US"";
1351 if (*s == '#') comment = US" (# is comment only at line start)";
1352 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1353 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1358 /*************************************************
1359 * Read rewrite information *
1360 *************************************************/
1362 /* Each line of rewrite information contains:
1364 . A complete address in the form user@domain, possibly with
1365 leading * for each part; or alternatively, a regex.
1367 . A replacement string (which will be expanded).
1369 . An optional sequence of one-letter flags, indicating which
1370 headers etc. to apply this rule to.
1372 All this is decoded and placed into a control block. The OR of the flags is
1373 maintained in a common word.
1376 p points to the string that makes up the rule
1377 existflags points to the overall flag word
1378 isglobal TRUE if reading global rewrite rules
1380 Returns: the control block for the parsed rule.
1383 static rewrite_rule *
1384 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1386 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1389 next->key = string_dequote(&p);
1391 while (isspace(*p)) p++;
1393 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1394 "missing rewrite replacement string");
1397 next->replacement = string_dequote(&p);
1399 while (*p != 0) switch (*p++)
1401 case ' ': case '\t': break;
1403 case 'q': next->flags |= rewrite_quit; break;
1404 case 'w': next->flags |= rewrite_whole; break;
1406 case 'h': next->flags |= rewrite_all_headers; break;
1407 case 's': next->flags |= rewrite_sender; break;
1408 case 'f': next->flags |= rewrite_from; break;
1409 case 't': next->flags |= rewrite_to; break;
1410 case 'c': next->flags |= rewrite_cc; break;
1411 case 'b': next->flags |= rewrite_bcc; break;
1412 case 'r': next->flags |= rewrite_replyto; break;
1414 case 'E': next->flags |= rewrite_all_envelope; break;
1415 case 'F': next->flags |= rewrite_envfrom; break;
1416 case 'T': next->flags |= rewrite_envto; break;
1418 case 'Q': next->flags |= rewrite_qualify; break;
1419 case 'R': next->flags |= rewrite_repeat; break;
1422 next->flags |= rewrite_smtp;
1423 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1424 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1425 "rewrite rule has the S flag but is not a regular expression");
1429 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1430 "unknown rewrite flag character '%c' "
1431 "(could be missing quotes round replacement item)", p[-1]);
1435 /* If no action flags are set, set all the "normal" rewrites. */
1437 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1438 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1440 /* Remember which exist, for optimization, and return the rule */
1442 *existflags |= next->flags;
1449 /*************************************************
1450 * Read global rewrite information *
1451 *************************************************/
1453 /* Each line is a single rewrite rule; it is parsed into a control block
1454 by readconf_one_rewrite(), and its flags are ORed into the global flag
1455 word rewrite_existflags. */
1458 readconf_rewrites(void)
1460 rewrite_rule **chain = &global_rewrite_rules;
1463 while ((p = get_config_line()) != NULL)
1465 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1467 chain = &(next->next);
1473 /*************************************************
1475 *************************************************/
1477 /* Strings are read into the normal store pool. As long we aren't too
1478 near the end of the current block, the string will just use what is necessary
1479 on the top of the stacking pool, because string_cat() uses the extension
1483 s the rest of the input line
1484 name the option name (for errors)
1486 Returns: pointer to the string
1490 read_string(const uschar *s, const uschar *name)
1495 if (*s != '\"') return string_copy(s);
1498 yield = string_dequote(&s);
1500 if (s == ss+1 || s[-1] != '\"')
1501 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1502 "missing quote at end of string value for %s", name);
1504 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1510 /*************************************************
1511 * Custom-handler options *
1512 *************************************************/
1514 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1517 smtp_receive_timeout_s = string_copy(str);
1520 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1521 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1522 if (smtp_receive_timeout < 0)
1523 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1528 /*************************************************
1529 * Handle option line *
1530 *************************************************/
1532 /* This function is called from several places to process a line containing the
1533 setting of an option. The first argument is the line to be decoded; it has been
1534 checked not to be empty and not to start with '#'. Trailing newlines and white
1535 space have been removed. The second argument is a pointer to the list of
1536 variable names that are to be recognized, together with their types and
1537 locations, and the third argument gives the number of entries in the list.
1539 The fourth argument is a pointer to a data block. If it is NULL, then the data
1540 values in the options list are absolute addresses. Otherwise, they are byte
1541 offsets in the data block.
1543 String option data may continue onto several lines; this function reads further
1544 data from config_file if necessary.
1546 The yield of this function is normally zero. If a string continues onto
1547 multiple lines, then the data value is permitted to be followed by a comma
1548 or a semicolon (for use in drivers) and the yield is that character.
1551 buffer contains the configuration line to be handled
1552 oltop points to the start of the relevant option list
1553 last one more than the offset of the last item in the option list
1554 data_block NULL when reading main options => data values in the option
1555 list are absolute addresses; otherwise they are byte offsets
1556 in data_block when they have opt_public set; otherwise
1557 they are byte offsets in data_block->options_block.
1558 unknown_txt format string to use in panic message for unknown option;
1559 must contain %s for option name
1560 if given as NULL, don't panic on unknown option
1562 Returns: TRUE if an option was read successfully,
1563 FALSE false for an unknown option if unknown_txt == NULL,
1564 otherwise panic and die on an unknown option
1568 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1569 void *data_block, uschar *unknown_txt)
1573 int n, count, type, value;
1577 BOOL boolvalue = TRUE;
1578 BOOL freesptr = TRUE;
1579 optionlist *ol, *ol2;
1583 uschar *inttype = US"";
1586 uschar **str_target;
1590 /* There may be leading spaces; thereafter, we expect an option name starting
1593 while (isspace(*s)) s++;
1595 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1597 /* Read the name of the option, and skip any subsequent white space. If
1598 it turns out that what we read was "hide", set the flag indicating that
1599 this is a secure option, and loop to read the next word. */
1601 for (n = 0; n < 2; n++)
1603 while (isalnum(*s) || *s == '_')
1605 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1609 while (isspace(*s)) s++;
1610 if (Ustrcmp(name, "hide") != 0) break;
1611 issecure = opt_secure;
1615 /* Deal with "no_" or "not_" here for booleans */
1617 if (Ustrncmp(name, "no_", 3) == 0)
1623 if (Ustrncmp(name, "not_", 4) == 0)
1629 /* Search the list for the given name. A non-existent name, or an option that
1630 is set twice, is a disaster. */
1632 if (!(ol = find_option(name + offset, oltop, last)))
1634 if (unknown_txt == NULL) return FALSE;
1635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1638 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1639 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1640 "\"%s\" option set for the second time", name);
1642 ol->type |= opt_set | issecure;
1643 type = ol->type & opt_mask;
1645 /* Types with data values must be followed by '='; the "no[t]_" prefix
1646 applies only to boolean values. */
1648 if (type < opt_bool || type > opt_bool_last)
1651 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1652 "negation prefix applied to a non-boolean option");
1654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1655 "unexpected end of line (data missing) after %s", name);
1657 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1660 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1661 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1662 ultimately expands to one of those values. */
1664 else if (*s != 0 && (offset != 0 || *s != '='))
1665 extra_chars_error(s, US"boolean option ", name, US"");
1667 /* Skip white space after = */
1669 if (*s == '=') while (isspace((*(++s))));
1671 /* If there is a data block and the opt_public flag is not set, change
1672 the data block pointer to the private options block. */
1674 if (data_block != NULL && (ol->type & opt_public) == 0)
1675 data_block = (void *)(((driver_instance *)data_block)->options_block);
1677 /* Now get the data according to the type. */
1681 /* If a string value is not enclosed in quotes, it consists of
1682 the rest of the current line, verbatim. Otherwise, string escapes
1685 A transport is specified as a string, which is then looked up in the
1686 list of transports. A search type is specified as one of a number of
1689 A set or rewrite rules for a driver is specified as a string, which is
1690 then parsed into a suitable chain of control blocks.
1692 Uids and gids are specified as strings which are then looked up in the
1693 passwd file. Lists of uids and gids are similarly specified as colon-
1694 separated strings. */
1699 case opt_expand_uid:
1700 case opt_expand_gid:
1705 reset_point = sptr = read_string(s, name);
1707 /* Having read a string, we now have several different ways of using it,
1708 depending on the data type, so do another switch. If keeping the actual
1709 string is not required (because it is interpreted), freesptr is set TRUE,
1710 and at the end we reset the pool. */
1714 /* If this was a string, set the variable to point to the new string,
1715 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1716 rules, we still keep the string (for printing), and parse the rules into a
1717 control block and flags word. */
1720 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1722 if (ol->type & opt_rep_con)
1724 uschar * saved_condition;
1725 /* We already have a condition, we're conducting a crude hack to let
1726 multiple condition rules be chained together, despite storing them in
1728 *str_target = string_copy_malloc( (saved_condition = *str_target)
1729 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1730 saved_condition, sptr)
1732 /* TODO(pdp): there is a memory leak here and just below
1733 when we set 3 or more conditions; I still don't
1734 understand the store mechanism enough to know
1735 what's the safe way to free content from an earlier store.
1736 AFAICT, stores stack, so freeing an early stored item also stores
1737 all data alloc'd after it. If we knew conditions were adjacent,
1738 we could survive that, but we don't. So I *think* we need to take
1739 another bit from opt_type to indicate "malloced"; this seems like
1740 quite a hack, especially for this one case. It also means that
1741 we can't ever reclaim the store from the *first* condition.
1743 Because we only do this once, near process start-up, I'm prepared to
1744 let this slide for the time being, even though it rankles. */
1746 else if (ol->type & opt_rep_str)
1748 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1749 int sep_i = -(int)sep_o;
1750 const uschar * list = sptr;
1752 gstring * list_o = NULL;
1756 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1757 list_o = string_cat(list_o, *str_target);
1760 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1761 list_o = string_append_listele(list_o, sep_o, s);
1764 *str_target = string_copy_malloc(string_from_gstring(list_o));
1775 *USS (US data_block + (long int)(ol->value)) = sptr;
1777 *USS (ol->value) = sptr;
1779 if (type == opt_rewrite)
1784 rewrite_rule **chain;
1787 sprintf(CS name2, "*%.50s_rules", name);
1788 ol2 = find_option(name2, oltop, last);
1789 sprintf(CS name2, "*%.50s_flags", name);
1790 ol3 = find_option(name2, oltop, last);
1792 if (ol2 == NULL || ol3 == NULL)
1793 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1794 "rewrite rules not available for driver");
1796 if (data_block == NULL)
1798 chain = (rewrite_rule **)(ol2->value);
1799 flagptr = (int *)(ol3->value);
1803 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1804 flagptr = (int *)(US data_block + (long int)(ol3->value));
1807 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1809 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1811 chain = &(next->next);
1814 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1815 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1816 "non-header rewrite - not allowed at transport time -");
1820 /* If it was an expanded uid, see if there is any expansion to be
1821 done by checking for the presence of a $ character. If there is, save it
1822 in the corresponding *expand_user option field. Otherwise, fall through
1823 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1826 case opt_expand_uid:
1827 sprintf(CS name2, "*expand_%.50s", name);
1828 ol2 = find_option(name2, oltop, last);
1831 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1833 if (data_block == NULL)
1834 *((uschar **)(ol2->value)) = ss;
1836 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1840 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1846 /* Look up a fixed uid, and also make use of the corresponding gid
1847 if a passwd entry is returned and the gid has not been set. */
1850 if (!route_finduser(sptr, &pw, &uid))
1851 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1852 if (data_block == NULL)
1853 *((uid_t *)(ol->value)) = uid;
1855 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1857 /* Set the flag indicating a fixed value is set */
1859 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1861 /* Handle matching gid if we have a passwd entry: done by finding the
1862 same name with terminating "user" changed to "group"; if not found,
1863 ignore. Also ignore if the value is already set. */
1865 if (pw == NULL) break;
1866 Ustrcpy(name+Ustrlen(name)-4, "group");
1867 ol2 = find_option(name, oltop, last);
1868 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1869 (ol2->type & opt_mask) == opt_expand_gid))
1871 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1874 if (data_block == NULL)
1875 *((gid_t *)(ol2->value)) = pw->pw_gid;
1877 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1883 /* If it was an expanded gid, see if there is any expansion to be
1884 done by checking for the presence of a $ character. If there is, save it
1885 in the corresponding *expand_user option field. Otherwise, fall through
1886 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1889 case opt_expand_gid:
1890 sprintf(CS name2, "*expand_%.50s", name);
1891 ol2 = find_option(name2, oltop, last);
1894 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1896 if (data_block == NULL)
1897 *((uschar **)(ol2->value)) = ss;
1899 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1903 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1909 /* Handle freestanding gid */
1912 if (!route_findgroup(sptr, &gid))
1913 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1914 if (data_block == NULL)
1915 *((gid_t *)(ol->value)) = gid;
1917 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1918 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1921 /* If it was a uid list, look up each individual entry, and build
1922 a vector of uids, with a count in the first element. Put the vector
1923 in malloc store so we can free the string. (We are reading into
1924 permanent store already.) */
1932 const uschar *op = expand_string (sptr);
1935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1936 name, expand_string_message);
1939 if (*p != 0) count++;
1940 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1941 list = store_malloc(count*sizeof(uid_t));
1942 list[ptr++] = (uid_t)(count - 1);
1944 if (data_block == NULL)
1945 *((uid_t **)(ol->value)) = list;
1947 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1953 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1954 if (!route_finduser(big_buffer, NULL, &uid))
1955 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1962 /* If it was a gid list, look up each individual entry, and build
1963 a vector of gids, with a count in the first element. Put the vector
1964 in malloc store so we can free the string. (We are reading into permanent
1973 const uschar *op = expand_string (sptr);
1976 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1977 name, expand_string_message);
1980 if (*p != 0) count++;
1981 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1982 list = store_malloc(count*sizeof(gid_t));
1983 list[ptr++] = (gid_t)(count - 1);
1985 if (data_block == NULL)
1986 *((gid_t **)(ol->value)) = list;
1988 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
1994 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1995 if (!route_findgroup(big_buffer, &gid))
1996 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2004 /* Release store if the value of the string doesn't need to be kept. */
2006 if (freesptr) store_reset(reset_point);
2009 /* Expanded boolean: if no characters follow, or if there are no dollar
2010 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2011 save the string for later expansion in the alternate place. */
2013 case opt_expand_bool:
2014 if (*s != 0 && Ustrchr(s, '$') != 0)
2016 sprintf(CS name2, "*expand_%.50s", name);
2017 ol2 = find_option(name2, oltop, last);
2020 reset_point = sptr = read_string(s, name);
2021 if (data_block == NULL)
2022 *((uschar **)(ol2->value)) = sptr;
2024 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2031 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2032 look for yes/not/true/false. Some booleans are stored in a single bit in
2033 a single int. There's a special fudge for verify settings; without a suffix
2034 they set both xx_sender and xx_recipient. The table points to the sender
2035 value; search subsequently for the recipient. There's another special case:
2036 opt_bool_set also notes when a boolean has been set. */
2040 case opt_bool_verify:
2044 s = readconf_readname(name2, 64, s);
2045 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2047 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2049 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2050 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2051 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2052 US"for boolean option ", name);
2055 /* Handle single-bit type. */
2057 if (type == opt_bit)
2059 int bit = 1 << ((ol->type >> 16) & 31);
2060 int *ptr = (data_block == NULL)?
2061 (int *)(ol->value) :
2062 (int *)(US data_block + (long int)ol->value);
2063 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2067 /* Handle full BOOL types */
2069 if (data_block == NULL)
2070 *((BOOL *)(ol->value)) = boolvalue;
2072 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2076 if (type == opt_bool_verify)
2078 sprintf(CS name2, "%.50s_recipient", name + offset);
2079 ol2 = find_option(name2, oltop, last);
2082 if (data_block == NULL)
2083 *((BOOL *)(ol2->value)) = boolvalue;
2085 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2089 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2091 else if (type == opt_bool_set)
2093 sprintf(CS name2, "*set_%.50s", name + offset);
2094 ol2 = find_option(name2, oltop, last);
2097 if (data_block == NULL)
2098 *((BOOL *)(ol2->value)) = TRUE;
2100 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2109 inttype = US"octal ";
2111 /* Integer: a simple(ish) case; allow octal and hex formats, and
2112 suffixes K, M and G. The different types affect output, not input. */
2121 lvalue = 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) == 'k')
2130 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2131 else lvalue *= 1024;
2134 else if (tolower(*endptr) == 'm')
2136 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2138 else lvalue *= 1024*1024;
2141 else if (tolower(*endptr) == 'g')
2143 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2145 else lvalue *= 1024*1024*1024;
2149 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2150 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2151 "absolute value of integer \"%s\" is too large (overflow)", s);
2153 while (isspace(*endptr)) endptr++;
2155 extra_chars_error(endptr, inttype, US"integer value for ", name);
2157 value = (int)lvalue;
2160 if (data_block == NULL)
2161 *((int *)(ol->value)) = value;
2163 *((int *)(US data_block + (long int)(ol->value))) = value;
2166 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2168 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2174 value = strtol(CS s, CSS &endptr, intbase);
2177 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2180 if (errno != ERANGE)
2181 if (tolower(*endptr) == 'g')
2183 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2189 else if (tolower(*endptr) == 'm')
2191 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2197 else if (tolower(*endptr) == 'k')
2200 value = (value + 512)/1024;
2202 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2203 "absolute value of integer \"%s\" is too large (overflow)", s);
2205 while (isspace(*endptr)) endptr++;
2207 extra_chars_error(endptr, inttype, US"integer value for ", name);
2210 if (data_block == NULL)
2211 *((int *)(ol->value)) = value;
2213 *((int *)(US data_block + (long int)(ol->value))) = value;
2216 /* Fixed-point number: held to 3 decimal places. */
2219 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2221 "fixed-point number expected for %s", name);
2223 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2224 "integer \"%s\" is too large (overflow)", s);
2228 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2229 "integer \"%s\" is too large (overflow)", s);
2231 /* We get a coverity error here for using count, as it derived
2232 from the tainted buffer pointed to by s, as parsed by sscanf().
2233 By the definition of sscanf we must be accessing between start
2234 and end of s (assuming it is nul-terminated...) so ignore the error. */
2235 /* coverity[tainted_data] */
2236 if (s[count] == '.')
2239 while (isdigit(s[++count]))
2241 value += (s[count] - '0') * d;
2246 while (isspace(s[count])) count++;
2249 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2251 if (data_block == NULL)
2252 *((int *)(ol->value)) = value;
2254 *((int *)(US data_block + (long int)(ol->value))) = value;
2257 /* There's a special routine to read time values. */
2260 value = readconf_readtime(s, 0, FALSE);
2262 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2264 if (data_block == NULL)
2265 *((int *)(ol->value)) = value;
2267 *((int *)(US data_block + (long int)(ol->value))) = value;
2270 /* A time list is a list of colon-separated times, with the first
2271 element holding the size of the list and the second the number of
2277 int *list = (data_block == NULL)?
2278 (int *)(ol->value) :
2279 (int *)(US data_block + (long int)(ol->value));
2281 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2284 uschar *snext = Ustrchr(s, ':');
2288 while (ss > s && isspace(ss[-1])) ss--;
2291 value = readconf_readtime(s, terminator, FALSE);
2293 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2295 if (count > 1 && value <= list[count])
2296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2297 "time value out of order for %s", name);
2298 list[count+1] = value;
2299 if (snext == NULL) break;
2301 while (isspace(*s)) s++;
2304 if (count > list[0] - 2)
2305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2307 if (count > 0 && list[2] == 0) count = 0;
2314 void (*fn)() = ol->value;
2325 /*************************************************
2326 * Print a time value *
2327 *************************************************/
2330 Argument: a time value in seconds
2331 Returns: pointer to a fixed buffer containing the time as a string,
2332 in readconf_readtime() format
2336 readconf_printtime(int t)
2339 uschar *p = time_buffer;
2356 if (w > 0) p += sprintf(CS p, "%dw", w);
2357 if (d > 0) p += sprintf(CS p, "%dd", d);
2358 if (h > 0) p += sprintf(CS p, "%dh", h);
2359 if (m > 0) p += sprintf(CS p, "%dm", m);
2360 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2367 /*************************************************
2368 * Print an individual option value *
2369 *************************************************/
2371 /* This is used by the -bP option, so prints to the standard output.
2372 The entire options list is passed in as an argument, because some options come
2373 in pairs - typically uid/gid settings, which can either be explicit numerical
2374 values, or strings to be expanded later. If the numerical value is unset,
2375 search for "*expand_<name>" to see if there is a string equivalent.
2378 ol option entry, or NULL for an unknown option
2380 options_block NULL for main configuration options; otherwise points to
2381 a driver block; if the option doesn't have opt_public
2382 set, then options_block->options_block is where the item
2384 oltop points to the option list in which ol exists
2385 last one more than the offset of the last entry in optop
2386 no_labels do not show "foo = " at the start.
2388 Returns: boolean success
2392 print_ol(optionlist *ol, uschar *name, void *options_block,
2393 optionlist *oltop, int last, BOOL no_labels)
2406 printf("%s is not a known option\n", name);
2410 /* Non-admin callers cannot see options that have been flagged secure by the
2413 if (!admin_user && ol->type & opt_secure)
2416 printf("%s\n", hidden);
2418 printf("%s = %s\n", name, hidden);
2422 /* Else show the value of the option */
2427 if (!(ol->type & opt_public))
2428 options_block = (void *)(((driver_instance *)options_block)->options_block);
2429 value = (void *)(US options_block + (long int)value);
2432 switch(ol->type & opt_mask)
2435 case opt_rewrite: /* Show the text value */
2437 if (!no_labels) printf("%s = ", name);
2438 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2442 if (!no_labels) printf("%s = ", name);
2443 printf("%d\n", *((int *)value));
2448 int x = *((int *)value);
2449 if (x != 0 && (x & 1023) == 0)
2453 if ((x & 1023) == 0)
2458 if (!no_labels) printf("%s = ", name);
2459 printf("%d%c\n", x, c);
2463 if (!no_labels) printf("%s = ", name);
2471 int x = *((int *)value);
2472 if (!no_labels) printf("%s = ", name);
2473 if (x == 0) printf("0\n");
2474 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2475 else printf("%dK\n", x);
2480 if (!no_labels) printf("%s = ", name);
2481 printf("%#o\n", *((int *)value));
2484 /* Can be negative only when "unset", in which case integer */
2488 int x = *((int *)value);
2491 if (x < 0) printf("%s =\n", name); else
2493 if (!no_labels) printf("%s = ", name);
2494 printf("%d.", x/1000);
2507 /* If the numerical value is unset, try for the string value */
2509 case opt_expand_uid:
2510 if (! *get_set_flag(name, oltop, last, options_block))
2512 sprintf(CS name2, "*expand_%.50s", name);
2513 if ((ol2 = find_option(name2, oltop, last)))
2515 void *value2 = ol2->value;
2517 value2 = (void *)(US options_block + (long int)value2);
2519 if (!no_labels) printf("%s = ", name);
2520 printf("%s\n", s ? string_printing(s) : US"");
2525 /* Else fall through */
2528 if (!no_labels) printf("%s = ", name);
2529 if (! *get_set_flag(name, oltop, last, options_block))
2532 if ((pw = getpwuid(*((uid_t *)value))))
2533 printf("%s\n", pw->pw_name);
2535 printf("%ld\n", (long int)(*((uid_t *)value)));
2538 /* If the numerical value is unset, try for the string value */
2540 case opt_expand_gid:
2541 if (! *get_set_flag(name, oltop, last, options_block))
2543 sprintf(CS name2, "*expand_%.50s", name);
2544 if ( (ol2 = find_option(name2, oltop, last))
2545 && (ol2->type & opt_mask) == opt_stringptr)
2547 void *value2 = ol2->value;
2549 value2 = (void *)(US options_block + (long int)value2);
2551 if (!no_labels) printf("%s = ", name);
2552 printf("%s\n", s ? string_printing(s) : US"");
2557 /* Else fall through */
2560 if (!no_labels) printf("%s = ", name);
2561 if (! *get_set_flag(name, oltop, last, options_block))
2564 if ((gr = getgrgid(*((int *)value))))
2565 printf("%s\n", gr->gr_name);
2567 printf("%ld\n", (long int)(*((int *)value)));
2571 uidlist = *((uid_t **)value);
2572 if (!no_labels) printf("%s =", name);
2576 uschar sep = no_labels ? '\0' : ' ';
2577 for (i = 1; i <= (int)(uidlist[0]); i++)
2579 uschar *name = NULL;
2580 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2581 if (sep != '\0') printf("%c", sep);
2582 if (name) printf("%s", name);
2583 else printf("%ld", (long int)(uidlist[i]));
2591 gidlist = *((gid_t **)value);
2592 if (!no_labels) printf("%s =", name);
2596 uschar sep = no_labels ? '\0' : ' ';
2597 for (i = 1; i <= (int)(gidlist[0]); i++)
2599 uschar *name = NULL;
2600 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2601 if (sep != '\0') printf("%c", sep);
2602 if (name) printf("%s", name);
2603 else printf("%ld", (long int)(gidlist[i]));
2611 if (!no_labels) printf("%s = ", name);
2612 printf("%s\n", readconf_printtime(*((int *)value)));
2618 int *list = (int *)value;
2619 if (!no_labels) printf("%s = ", name);
2620 for (i = 0; i < list[1]; i++)
2621 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2627 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2631 case opt_expand_bool:
2632 sprintf(CS name2, "*expand_%.50s", name);
2633 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2635 void *value2 = ol2->value;
2637 value2 = (void *)(US options_block + (long int)value2);
2641 if (!no_labels) printf("%s = ", name);
2642 printf("%s\n", string_printing(s));
2645 /* s == NULL => string not set; fall through */
2651 case opt_bool_verify:
2653 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2661 /*************************************************
2662 * Print value from main configuration *
2663 *************************************************/
2665 /* This function, called as a result of encountering the -bP option,
2666 causes the value of any main configuration variable to be output if the
2667 second argument is NULL. There are some special values:
2669 all print all main configuration options
2670 config_file print the name of the configuration file
2671 (configure_file will still work, for backward
2673 routers print the routers' configurations
2674 transports print the transports' configuration
2675 authenticators print the authenticators' configuration
2676 macros print the macros' configuration
2677 router_list print a list of router names
2678 transport_list print a list of transport names
2679 authenticator_list print a list of authentication mechanism names
2680 macro_list print a list of macro names
2681 +name print a named list item
2682 local_scan print the local_scan options
2683 config print the configuration as it is parsed
2684 environment print the used execution environment
2686 If the second argument is not NULL, it must be one of "router", "transport",
2687 "authenticator" or "macro" in which case the first argument identifies the
2688 driver whose options are to be printed.
2691 name option name if type == NULL; else driver name
2692 type NULL or driver type name, as described above
2693 no_labels avoid the "foo = " at the start of an item
2695 Returns: Boolean success
2699 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2701 BOOL names_only = FALSE;
2703 optionlist *ol2 = NULL;
2704 driver_instance *d = NULL;
2715 static uschar *types[] = { US"address", US"domain", US"host",
2717 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2718 &hostlist_anchor, &localpartlist_anchor };
2720 for (i = 0; i < 4; i++)
2721 if ((t = tree_search(*(anchors[i]), name+1)))
2725 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2727 printf("%slist %s = %s\n", types[i], name+1,
2728 ((namedlist_block *)(t->data.ptr))->string);
2732 printf("no address, domain, host, or local part list called \"%s\" "
2733 "exists\n", name+1);
2738 if ( Ustrcmp(name, "configure_file") == 0
2739 || Ustrcmp(name, "config_file") == 0)
2741 printf("%s\n", CS config_main_filename);
2745 if (Ustrcmp(name, "all") == 0)
2747 for (ol = optionlist_config;
2748 ol < optionlist_config + nelem(optionlist_config); ol++)
2749 if (!(ol->type & opt_hidden))
2750 (void) print_ol(ol, US ol->name, NULL,
2751 optionlist_config, nelem(optionlist_config),
2756 if (Ustrcmp(name, "local_scan") == 0)
2758 #ifndef LOCAL_SCAN_HAS_OPTIONS
2759 printf("local_scan() options are not supported\n");
2762 for (ol = local_scan_options;
2763 ol < local_scan_options + local_scan_options_count; ol++)
2764 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2765 local_scan_options_count, no_labels);
2770 if (Ustrcmp(name, "config") == 0)
2772 print_config(admin_user, no_labels);
2776 if (Ustrcmp(name, "routers") == 0)
2781 else if (Ustrcmp(name, "transports") == 0)
2783 type = US"transport";
2786 else if (Ustrcmp(name, "authenticators") == 0)
2788 type = US"authenticator";
2791 else if (Ustrcmp(name, "macros") == 0)
2796 else if (Ustrcmp(name, "router_list") == 0)
2802 else if (Ustrcmp(name, "transport_list") == 0)
2804 type = US"transport";
2808 else if (Ustrcmp(name, "authenticator_list") == 0)
2810 type = US"authenticator";
2814 else if (Ustrcmp(name, "macro_list") == 0)
2820 else if (Ustrcmp(name, "environment") == 0)
2825 for (p = USS environ; *p; p++) ;
2826 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2828 for (p = USS environ; *p; p++)
2831 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2839 return print_ol(find_option(name,
2840 optionlist_config, nelem(optionlist_config)),
2841 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2844 /* Handle the options for a router or transport. Skip options that are flagged
2845 as hidden. Some of these are options with names starting with '*', used for
2846 internal alternative representations of other options (which the printing
2847 function will sort out). Others are synonyms kept for backward compatibility.
2850 if (Ustrcmp(type, "router") == 0)
2852 d = (driver_instance *)routers;
2853 ol2 = optionlist_routers;
2854 size = optionlist_routers_size;
2856 else if (Ustrcmp(type, "transport") == 0)
2858 d = (driver_instance *)transports;
2859 ol2 = optionlist_transports;
2860 size = optionlist_transports_size;
2862 else if (Ustrcmp(type, "authenticator") == 0)
2864 d = (driver_instance *)auths;
2865 ol2 = optionlist_auths;
2866 size = optionlist_auths_size;
2869 else if (Ustrcmp(type, "macro") == 0)
2871 /* People store passwords in macros and they were previously not available
2872 for printing. So we have an admin_users restriction. */
2875 fprintf(stderr, "exim: permission denied\n");
2878 for (m = macros; m; m = m->next)
2879 if (!name || Ustrcmp(name, m->name) == 0)
2882 printf("%s\n", CS m->name);
2884 printf("%s\n", CS m->replacement);
2886 printf("%s=%s\n", CS m->name, CS m->replacement);
2890 if (!name) return TRUE;
2892 printf("%s %s not found\n", type, name);
2898 for (; d; d = d->next) printf("%s\n", CS d->name);
2902 /* Either search for a given driver, or print all of them */
2904 for (; d; d = d->next)
2908 printf("\n%s %s:\n", d->name, type);
2909 else if (Ustrcmp(d->name, name) != 0) continue;
2911 for (ol = ol2; ol < ol2 + size; ol++)
2912 if (!(ol->type & opt_hidden))
2913 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2915 for (ol = d->info->options;
2916 ol < d->info->options + *(d->info->options_count); ol++)
2917 if (!(ol->type & opt_hidden))
2918 rc |= print_ol(ol, US ol->name, d, d->info->options,
2919 *d->info->options_count, no_labels);
2921 if (name) return rc;
2923 if (!name) return TRUE;
2925 printf("%s %s not found\n", type, name);
2931 /*************************************************
2932 * Read a named list item *
2933 *************************************************/
2935 /* This function reads a name and a list (i.e. string). The name is used to
2936 save the list in a tree, sorted by its name. Each entry also has a number,
2937 which can be used for caching tests, but if the string contains any expansion
2938 items other than $key, the number is set negative to inhibit caching. This
2939 mechanism is used for domain, host, and address lists that are referenced by
2943 anchorp points to the tree anchor
2944 numberp points to the current number for this tree
2945 max the maximum number permitted
2946 s the text of the option line, starting immediately after the name
2948 tname the name of the list type, for messages
2954 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2957 BOOL forcecache = FALSE;
2960 namedlist_block *nb = store_get(sizeof(namedlist_block));
2962 if (Ustrncmp(s, "_cache", 6) == 0)
2969 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2971 if (*numberp >= max)
2972 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2975 while (isspace(*s)) s++;
2977 while (isalnum(*s) || *s == '_') s++;
2978 t = store_get(sizeof(tree_node) + s-ss);
2979 Ustrncpy(t->name, ss, s-ss);
2981 while (isspace(*s)) s++;
2983 if (!tree_insertnode(anchorp, t))
2984 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2985 "duplicate name \"%s\" for a named %s", t->name, tname);
2988 nb->number = *numberp;
2991 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2992 "missing '=' after \"%s\"", t->name);
2993 while (isspace(*s)) s++;
2994 nb->string = read_string(s, t->name);
2995 nb->cache_data = NULL;
2997 /* Check the string for any expansions; if any are found, mark this list
2998 uncacheable unless the user has explicited forced caching. */
3000 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3006 /*************************************************
3007 * Unpick data for a rate limit *
3008 *************************************************/
3010 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3014 s string, in the form t,b,f,l
3015 where t is the threshold (integer)
3016 b is the initial delay (time)
3017 f is the multiplicative factor (fixed point)
3018 k is the maximum time (time)
3019 threshold where to store threshold
3020 base where to store base in milliseconds
3021 factor where to store factor in milliseconds
3022 limit where to store limit
3024 Returns: nothing (panics on error)
3028 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3031 uschar bstring[16], lstring[16];
3033 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3034 factor, lstring) == 4)
3036 *base = readconf_readtime(bstring, 0, TRUE);
3037 *limit = readconf_readtime(lstring, 0, TRUE);
3038 if (*base >= 0 && *limit >= 0) return;
3040 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3046 /*************************************************
3047 * Drop privs for checking TLS config *
3048 *************************************************/
3050 /* We want to validate TLS options during readconf, but do not want to be
3051 root when we call into the TLS library, in case of library linkage errors
3052 which cause segfaults; before this check, those were always done as the Exim
3053 runtime user and it makes sense to continue with that.
3055 Assumes: tls_require_ciphers has been set, if it will be
3056 exim_user has been set, if it will be
3057 exim_group has been set, if it will be
3059 Returns: bool for "okay"; false will cause caller to immediately exit.
3064 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3066 const uschar *errmsg;
3069 void (*oldsignal)(int);
3071 /* If TLS will never be used, no point checking ciphers */
3073 if ( !tls_advertise_hosts
3074 || !*tls_advertise_hosts
3075 || Ustrcmp(tls_advertise_hosts, ":") == 0
3078 else if (!nowarn && !tls_certificate)
3079 log_write(0, LOG_MAIN,
3080 "Warning: No server certificate defined; will use a selfsigned one.\n"
3081 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3083 oldsignal = signal(SIGCHLD, SIG_DFL);
3086 if ((pid = fork()) < 0)
3087 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3091 /* in some modes, will have dropped privilege already */
3093 exim_setugid(exim_uid, exim_gid, FALSE,
3094 US"calling tls_validate_require_cipher");
3096 if ((errmsg = tls_validate_require_cipher()))
3097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3098 "tls_require_ciphers invalid: %s", errmsg);
3104 rc = waitpid(pid, &status, 0);
3105 } while (rc < 0 && errno == EINTR);
3108 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3111 signal(SIGCHLD, oldsignal);
3115 #endif /* SUPPORT_TLS */
3120 /*************************************************
3121 * Read main configuration options *
3122 *************************************************/
3124 /* This function is the first to be called for configuration reading. It
3125 opens the configuration file and reads general configuration settings until
3126 it reaches the end of the configuration section. The file is then left open so
3127 that the remaining configuration data can subsequently be read if needed for
3130 The configuration file must be owned either by root or exim, and be writeable
3131 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3132 in the config file, so the test is done on the compiled in values. A slight
3133 anomaly, to be carefully documented.
3135 The name of the configuration file is taken from a list that is included in the
3136 binary of Exim. It can be altered from the command line, but if that is done,
3137 root privilege is immediately withdrawn unless the caller is root or exim.
3138 The first file on the list that exists is used.
3140 For use on multiple systems that share file systems, first look for a
3141 configuration file whose name has the current node name on the end. If that is
3142 not found, try the generic name. For really contorted configurations, that run
3143 multiple Exims with different uid settings, first try adding the effective uid
3144 before the node name. These complications are going to waste resources on most
3145 systems. Therefore they are available only when requested by compile-time
3149 readconf_main(BOOL nowarn)
3152 struct stat statbuf;
3153 uschar *s, *filename;
3154 const uschar *list = config_main_filelist;
3156 /* Loop through the possible file names */
3158 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3161 /* Cut out all the fancy processing unless specifically wanted */
3163 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3164 uschar *suffix = filename + Ustrlen(filename);
3166 /* Try for the node-specific file if a node name exists */
3168 #ifdef CONFIGURE_FILE_USE_NODE
3170 if (uname(&uts) >= 0)
3172 #ifdef CONFIGURE_FILE_USE_EUID
3173 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3174 config_file = Ufopen(filename, "rb");
3175 if (config_file == NULL)
3176 #endif /* CONFIGURE_FILE_USE_EUID */
3178 sprintf(CS suffix, ".%.256s", uts.nodename);
3179 config_file = Ufopen(filename, "rb");
3182 #endif /* CONFIGURE_FILE_USE_NODE */
3184 /* Otherwise, try the generic name, possibly with the euid added */
3186 #ifdef CONFIGURE_FILE_USE_EUID
3187 if (config_file == NULL)
3189 sprintf(CS suffix, ".%ld", (long int)original_euid);
3190 config_file = Ufopen(filename, "rb");
3192 #endif /* CONFIGURE_FILE_USE_EUID */
3194 /* Finally, try the unadorned name */
3196 if (config_file == NULL)
3199 config_file = Ufopen(filename, "rb");
3201 #else /* if neither defined */
3203 /* This is the common case when the fancy processing is not included. */
3205 config_file = Ufopen(filename, "rb");
3208 /* If the file does not exist, continue to try any others. For any other
3209 error, break out (and die). */
3211 if (config_file != NULL || errno != ENOENT) break;
3214 /* On success, save the name for verification; config_filename is used when
3215 logging configuration errors (it changes for .included files) whereas
3216 config_main_filename is the name shown by -bP. Failure to open a configuration
3217 file is a serious disaster. */
3221 uschar *last_slash = Ustrrchr(filename, '/');
3222 config_filename = config_main_filename = string_copy(filename);
3224 /* The config_main_directory we need for the $config_dir expansion.
3225 config_main_filename we need for $config_file expansion.
3226 And config_dir is the directory of the current configuration, used for
3227 relative .includes. We do need to know it's name, as we change our working
3230 if (filename[0] == '/')
3231 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3234 /* relative configuration file name: working dir + / + basename(filename) */
3236 uschar buf[PATH_MAX];
3239 if (os_getcwd(buf, PATH_MAX) == NULL)
3241 perror("exim: getcwd");
3244 g = string_cat(NULL, buf);
3246 /* If the dir does not end with a "/", append one */
3247 if (g->s[g->ptr-1] != '/')
3248 g = string_catn(g, US"/", 1);
3250 /* If the config file contains a "/", extract the directory part */
3252 g = string_catn(g, filename, last_slash - filename);
3254 config_main_directory = string_from_gstring(g);
3256 config_directory = config_main_directory;
3260 if (filename == NULL)
3261 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3262 "%s", config_main_filelist);
3264 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3265 "configuration file %s", filename));
3268 /* Now, once we found and opened our configuration file, we change the directory
3269 to a safe place. Later we change to $spool_directory. */
3271 if (Uchdir("/") < 0)
3273 perror("exim: chdir `/': ");
3277 /* Check the status of the file we have opened, if we have retained root
3278 privileges and the file isn't /dev/null (which *should* be 0666). */
3280 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3282 if (fstat(fileno(config_file), &statbuf) != 0)
3283 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3286 if ((statbuf.st_uid != root_uid /* owner not root */
3287 #ifdef CONFIGURE_OWNER
3288 && statbuf.st_uid != config_uid /* owner not the special one */
3291 (statbuf.st_gid != root_gid /* group not root & */
3292 #ifdef CONFIGURE_GROUP
3293 && statbuf.st_gid != config_gid /* group not the special one */
3295 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3297 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3299 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3300 "wrong owner, group, or mode", big_buffer);
3303 /* Process the main configuration settings. They all begin with a lower case
3304 letter. If we see something starting with an upper case letter, it is taken as
3305 a macro definition. */
3307 while ((s = get_config_line()))
3309 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3311 "found unexpected BOM (Byte Order Mark)");
3314 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3316 else if (Ustrncmp(s, "domainlist", 10) == 0)
3317 read_named_list(&domainlist_anchor, &domainlist_count,
3318 MAX_NAMED_LIST, s+10, US"domain list");
3320 else if (Ustrncmp(s, "hostlist", 8) == 0)
3321 read_named_list(&hostlist_anchor, &hostlist_count,
3322 MAX_NAMED_LIST, s+8, US"host list");
3324 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3325 read_named_list(&addresslist_anchor, &addresslist_count,
3326 MAX_NAMED_LIST, s+11, US"address list");
3328 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3329 read_named_list(&localpartlist_anchor, &localpartlist_count,
3330 MAX_NAMED_LIST, s+13, US"local part list");
3333 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3334 NULL, US"main option \"%s\" unknown");
3338 /* If local_sender_retain is set, local_from_check must be unset. */
3340 if (local_sender_retain && local_from_check)
3341 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3342 "local_sender_retain are set; this combination is not allowed");
3344 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3347 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3349 /* The max retry interval must not be greater than 24 hours. */
3351 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3353 /* remote_max_parallel must be > 0 */
3355 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3357 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3358 start of a new SMTP message. */
3360 freeze_tell_config = freeze_tell;
3362 /* The primary host name may be required for expansion of spool_directory
3363 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3364 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3365 canonize it. Some people like upper case letters in their host names, so we
3366 don't force the case. */
3368 if (primary_hostname == NULL)
3370 const uschar *hostname;
3372 if (uname(&uts) < 0)
3373 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3374 hostname = US uts.nodename;
3376 if (Ustrchr(hostname, '.') == NULL)
3379 struct hostent *hostdata;
3382 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3383 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3384 MCL_DOMAIN, TRUE, NULL) != OK))
3393 #if HAVE_GETIPNODEBYNAME
3395 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3397 hostdata = gethostbyname2(CS hostname, af);
3400 hostdata = gethostbyname(CS hostname);
3403 if (hostdata != NULL)
3405 hostname = US hostdata->h_name;
3409 if (af == AF_INET) break;
3414 primary_hostname = string_copy(hostname);
3417 /* Set up default value for smtp_active_hostname */
3419 smtp_active_hostname = primary_hostname;
3421 /* If spool_directory wasn't set in the build-time configuration, it must have
3422 got set above. Of course, writing to the log may not work if log_file_path is
3423 not set, but it will at least get to syslog or somewhere, with any luck. */
3425 if (*spool_directory == 0)
3426 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3429 /* Expand the spool directory name; it may, for example, contain the primary
3430 host name. Same comment about failure. */
3432 s = expand_string(spool_directory);
3434 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3435 "\"%s\": %s", spool_directory, expand_string_message);
3436 spool_directory = s;
3438 /* Expand log_file_path, which must contain "%s" in any component that isn't
3439 the null string or "syslog". It is also allowed to contain one instance of %D
3440 or %M. However, it must NOT contain % followed by anything else. */
3442 if (*log_file_path != 0)
3444 const uschar *ss, *sss;
3445 int sep = ':'; /* Fixed for log file path */
3446 s = expand_string(log_file_path);
3448 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3449 "\"%s\": %s", log_file_path, expand_string_message);
3452 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3455 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3456 t = Ustrstr(sss, "%s");
3458 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3459 "contain \"%%s\"", sss);
3461 t = Ustrchr(sss, '%');
3464 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3465 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3466 "unexpected \"%%\" character", s);
3473 /* Interpret syslog_facility into an integer argument for 'ident' param to
3474 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3477 if (syslog_facility_str)
3480 uschar *s = syslog_facility_str;
3482 if ((Ustrlen(syslog_facility_str) >= 4) &&
3483 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3486 for (i = 0; i < syslog_list_size; i++)
3487 if (strcmpic(s, syslog_list[i].name) == 0)
3489 syslog_facility = syslog_list[i].value;
3493 if (i >= syslog_list_size)
3494 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3495 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3498 /* Expand pid_file_path */
3500 if (*pid_file_path != 0)
3502 if (!(s = expand_string(pid_file_path)))
3503 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3504 "\"%s\": %s", pid_file_path, expand_string_message);
3508 /* Set default value of process_log_path */
3510 if (!process_log_path || *process_log_path =='\0')
3511 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3513 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3516 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3518 /* Unpick the SMTP rate limiting options, if set */
3520 if (smtp_ratelimit_mail)
3521 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3522 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3524 if (smtp_ratelimit_rcpt)
3525 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3526 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3528 /* The qualify domains default to the primary host name */
3530 if (!qualify_domain_sender)
3531 qualify_domain_sender = primary_hostname;
3532 if (!qualify_domain_recipient)
3533 qualify_domain_recipient = qualify_domain_sender;
3535 /* Setting system_filter_user in the configuration sets the gid as well if a
3536 name is given, but a numerical value does not. */
3538 if (system_filter_uid_set && !system_filter_gid_set)
3540 struct passwd *pw = getpwuid(system_filter_uid);
3542 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3543 (long int)system_filter_uid);
3544 system_filter_gid = pw->pw_gid;
3545 system_filter_gid_set = TRUE;
3548 /* If the errors_reply_to field is set, check that it is syntactically valid
3549 and ensure it contains a domain. */
3551 if (errors_reply_to)
3554 int start, end, domain;
3555 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3556 &start, &end, &domain, FALSE);
3559 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3560 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3563 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3564 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3567 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3568 smtp_accept_max must also be set. */
3570 if (smtp_accept_max == 0 &&
3571 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3572 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3573 "smtp_accept_max must be set if smtp_accept_queue or "
3574 "smtp_accept_max_per_host is set");
3576 /* Set up the host number if anything is specified. It is an expanded string
3577 so that it can be computed from the host name, for example. We do this last
3578 so as to ensure that everything else is set up before the expansion. */
3580 if (host_number_string)
3584 uschar *s = expand_string(host_number_string);
3587 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3588 "failed to expand localhost_number \"%s\": %s",
3589 host_number_string, expand_string_message);
3590 n = Ustrtol(s, &end, 0);
3591 while (isspace(*end)) end++;
3593 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3594 "localhost_number value is not a number: %s", s);
3595 if (n > LOCALHOST_MAX)
3596 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3597 "localhost_number is greater than the maximum allowed value (%d)",
3603 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3605 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3606 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3607 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3608 tls_verify_hosts ? "" : "try_");
3610 /* This also checks that the library linkage is working and we can call
3611 routines in it, so call even if tls_require_ciphers is unset */
3612 if (!tls_dropprivs_validate_require_cipher(nowarn))
3615 /* Magic number: at time of writing, 1024 has been the long-standing value
3616 used by so many clients, and what Exim used to use always, that it makes
3617 sense to just min-clamp this max-clamp at that. */
3618 if (tls_dh_max_bits < 1024)
3619 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3620 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3622 /* If openssl_options is set, validate it */
3623 if (openssl_options)
3626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3627 "openssl_options is set but we're using GnuTLS");
3630 if (!tls_openssl_options_parse(openssl_options, &dummy))
3631 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3632 "openssl_options parse error: %s", openssl_options);
3635 #endif /*SUPPORT_TLS*/
3637 if (!nowarn && !keep_environment && environ && *environ)
3638 log_write(0, LOG_MAIN,
3639 "Warning: purging the environment.\n"
3640 " Suggested action: use keep_environment.");
3645 /*************************************************
3646 * Initialize one driver *
3647 *************************************************/
3649 /* This is called once the driver's generic options, if any, have been read.
3650 We can now find the driver, set up defaults for the private options, and
3651 unset any "set" bits in the private options table (which might have been
3652 set by another incarnation of the same driver).
3655 d pointer to driver instance block, with generic
3657 drivers_available vector of available drivers
3658 size_of_info size of each block in drivers_available
3659 class class of driver, for error message
3661 Returns: pointer to the driver info block
3664 static driver_info *
3665 init_driver(driver_instance *d, driver_info *drivers_available,
3666 int size_of_info, uschar *class)
3670 for (dd = drivers_available; dd->driver_name[0] != 0;
3671 dd = (driver_info *)((US dd) + size_of_info))
3673 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3676 int len = dd->options_len;
3678 d->options_block = store_get(len);
3679 memcpy(d->options_block, dd->options_block, len);
3680 for (i = 0; i < *(dd->options_count); i++)
3681 dd->options[i].type &= ~opt_set;
3686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3687 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3689 return NULL; /* never obeyed */
3695 /*************************************************
3696 * Initialize driver list *
3697 *************************************************/
3699 /* This function is called for routers, transports, and authentication
3700 mechanisms. It reads the data from the current point in the configuration file
3701 up to the end of the section, and sets up a chain of instance blocks according
3702 to the file's contents. The file will already have been opened by a call to
3703 readconf_main, and must be left open for subsequent reading of further data.
3705 Any errors cause a panic crash. Note that the blocks with names driver_info and
3706 driver_instance must map the first portions of all the _info and _instance
3707 blocks for this shared code to work.
3710 class "router", "transport", or "authenticator"
3711 anchor &routers, &transports, &auths
3712 drivers_available available drivers
3713 size_of_info size of each info block
3714 instance_default points to default data for an instance
3715 instance_size size of instance block
3716 driver_optionlist generic option list
3717 driver_optionlist_count count of generic option list
3723 readconf_driver_init(
3725 driver_instance **anchor,
3726 driver_info *drivers_available,
3728 void *instance_default,
3730 optionlist *driver_optionlist,
3731 int driver_optionlist_count)
3733 driver_instance **p = anchor;
3734 driver_instance *d = NULL;
3737 while ((buffer = get_config_line()) != NULL)
3742 /* Read the first name on the line and test for the start of a new driver. A
3743 macro definition indicates the end of the previous driver. If this isn't the
3744 start of a new driver, the line will be re-read. */
3746 s = readconf_readname(name, sizeof(name), buffer);
3748 /* Handle macro definition, first finishing off the initialization of the
3749 previous driver, if any. */
3751 if (isupper(*name) && *s == '=')
3755 if (!d->driver_name)
3756 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3757 "no driver defined for %s \"%s\"", class, d->name);
3761 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3765 /* If the line starts with a name terminated by a colon, we are at the
3766 start of the definition of a new driver. The rest of the line must be
3773 /* Finish off initializing the previous driver. */
3777 if (!d->driver_name)
3778 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3779 "no driver defined for %s \"%s\"", class, d->name);
3783 /* Check that we haven't already got a driver of this name */
3785 for (d = *anchor; d; d = d->next)
3786 if (Ustrcmp(name, d->name) == 0)
3787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3788 "there are two %ss called \"%s\"", class, name);
3790 /* Set up a new driver instance data block on the chain, with
3791 its default values installed. */
3793 d = store_get(instance_size);
3794 memcpy(d, instance_default, instance_size);
3797 d->name = string_copy(name);
3799 /* Clear out the "set" bits in the generic options */
3801 for (i = 0; i < driver_optionlist_count; i++)
3802 driver_optionlist[i].type &= ~opt_set;
3804 /* Check nothing more on this line, then do the next loop iteration. */
3806 while (isspace(*s)) s++;
3807 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3811 /* Not the start of a new driver. Give an error if we have not set up a
3812 current driver yet. */
3815 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3817 /* First look to see if this is a generic option; if it is "driver",
3818 initialize the driver. If is it not a generic option, we can look for a
3819 private option provided that the driver has been previously set up. */
3821 if (readconf_handle_option(buffer, driver_optionlist,
3822 driver_optionlist_count, d, NULL))
3824 if (!d->info && d->driver_name)
3825 init_driver(d, drivers_available, size_of_info, class);
3828 /* Handle private options - pass the generic block because some may
3829 live therein. A flag with each option indicates if it is in the public
3833 readconf_handle_option(buffer, d->info->options,
3834 *(d->info->options_count), d, US"option \"%s\" unknown");
3836 /* The option is not generic and the driver name has not yet been given. */
3838 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3839 "(\"driver\" must be specified before any private options)", name);
3842 /* Run the initialization function for the final driver. */
3846 if (!d->driver_name)
3847 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3848 "no driver defined for %s \"%s\"", class, d->name);
3855 /*************************************************
3856 * Check driver dependency *
3857 *************************************************/
3859 /* This function is passed a driver instance and a string. It checks whether
3860 any of the string options for the driver contains the given string as an
3864 d points to a driver instance block
3865 s the string to search for
3867 Returns: TRUE if a dependency is found
3871 readconf_depends(driver_instance *d, uschar *s)
3873 int count = *(d->info->options_count);
3877 for (ol = d->info->options; ol < d->info->options + count; ol++)
3879 void *options_block;
3881 int type = ol->type & opt_mask;
3882 if (type != opt_stringptr) continue;
3883 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3884 value = *(uschar **)(US options_block + (long int)(ol->value));
3885 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3887 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3888 isalnum(ss[Ustrlen(s)])) continue;
3889 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3890 d->name, ol->name, s);
3895 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3902 /*************************************************
3903 * Decode an error type for retries *
3904 *************************************************/
3906 /* This function is global because it is also called from the main
3907 program when testing retry information. It decodes strings such as "quota_7d"
3908 into numerical error codes.
3911 pp points to start of text
3912 p points past end of text
3913 basic_errno points to an int to receive the main error number
3914 more_errno points to an int to receive the secondary error data
3916 Returns: NULL if decoded correctly; else points to error text
3920 readconf_retry_error(const uschar *pp, const uschar *p,
3921 int *basic_errno, int *more_errno)
3924 const uschar *q = pp;
3925 while (q < p && *q != '_') q++;
3928 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3930 *basic_errno = ERRNO_EXIMQUOTA;
3931 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3932 return US"bad time value";
3935 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3937 *basic_errno = ECONNREFUSED;
3940 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3941 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3942 else return US"A or MX expected after \"refused\"";
3946 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3948 *basic_errno = ETIMEDOUT;
3952 int xlen = p - q - 1;
3953 const uschar *x = q + 1;
3955 static uschar *extras[] =
3956 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3957 static int values[] =
3958 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3960 for (i = 0; i < nelem(extras); i++)
3961 if (strncmpic(x, extras[i], xlen) == 0)
3963 *more_errno = values[i];
3967 if (i >= nelem(extras))
3968 if (strncmpic(x, US"DNS", xlen) == 0)
3969 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3970 "available in retry rules (it has never worked) - treated as "
3973 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3977 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3978 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3979 strncmpic(pp, US"data_4", 6) == 0)
3982 int x = 255; /* means "any 4xx code" */
3983 if (p != pp + 8) bad = TRUE; else
3985 int a = pp[6], b = pp[7];
3989 if (isdigit(b)) x += b - '0';
3990 else if (b == 'x') x += 100;
3993 else if (a != 'x' || b != 'x') bad = TRUE;
3997 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3998 "x is literal and d is any digit", pp);
4000 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4001 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4002 *more_errno = x << 8;
4005 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4006 strncmpic(q+1, US"failed", p-q-1) == 0)
4007 *basic_errno = ERRNO_AUTHFAIL;
4009 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4010 *basic_errno = ERRNO_SMTPCLOSED;
4012 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4013 *basic_errno = ERRNO_TLSREQUIRED;
4015 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4016 *basic_errno = ERRNO_UNKNOWNHOST;
4018 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4019 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4027 /*************************************************
4028 * Read retry information *
4029 *************************************************/
4031 /* Each line of retry information contains:
4033 . A domain name pattern or an address pattern;
4035 . An error name, possibly with additional data, or *;
4037 . An optional sequence of retry items, each consisting of an identifying
4038 letter, a cutoff time, and optional parameters.
4040 All this is decoded and placed into a control block. */
4043 /* Subroutine to read an argument, preceded by a comma and terminated
4044 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4045 1 = fixed point number (returned *1000).
4048 paddr pointer to pointer to current character; updated
4049 type 0 => read a time; 1 => read a fixed point number
4051 Returns: time in seconds or fixed point number * 1000
4055 retry_arg(const uschar **paddr, int type)
4057 const uschar *p = *paddr;
4060 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4062 while (isspace(*p)) p++;
4064 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4066 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4067 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4072 case 0: return readconf_readtime(pp, *p, FALSE);
4073 case 1: return readconf_readfixed(pp, *p);
4075 return 0; /* Keep picky compilers happy */
4078 /* The function proper */
4081 readconf_retries(void)
4083 retry_config **chain = &retries;
4087 while ((p = get_config_line()))
4089 retry_rule **rchain;
4093 next = store_get(sizeof(retry_config));
4096 chain = &(next->next);
4097 next->basic_errno = next->more_errno = 0;
4098 next->senders = NULL;
4100 rchain = &(next->rules);
4102 next->pattern = string_dequote(&p);
4103 while (isspace(*p)) p++;
4105 while (mac_isgraph(*p)) p++;
4106 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4107 "missing error type in retry rule");
4109 /* Test error names for things we understand. */
4111 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4112 &next->more_errno)))
4113 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4115 /* There may be an optional address list of senders to be used as another
4116 constraint on the rule. This was added later, so the syntax is a bit of a
4117 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4120 while (isspace(*p)) p++;
4121 if (Ustrncmp(p, "senders", 7) == 0)
4124 while (isspace(*p)) p++;
4125 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4126 "\"=\" expected after \"senders\" in retry rule");
4127 while (isspace(*p)) p++;
4128 next->senders = string_dequote(&p);
4131 /* Now the retry rules. Keep the maximum timeout encountered. */
4133 while (isspace(*p)) p++;
4137 retry_rule *rule = store_get(sizeof(retry_rule));
4139 rchain = &(rule->next);
4141 rule->rule = toupper(*p++);
4142 rule->timeout = retry_arg(&p, 0);
4143 if (rule->timeout > retry_maximum_timeout)
4144 retry_maximum_timeout = rule->timeout;
4148 case 'F': /* Fixed interval */
4149 rule->p1 = retry_arg(&p, 0);
4152 case 'G': /* Geometrically increasing intervals */
4153 case 'H': /* Ditto, but with randomness */
4154 rule->p1 = retry_arg(&p, 0);
4155 rule->p2 = retry_arg(&p, 1);
4159 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4163 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4164 (rule->rule != 'F' && rule->p2 < 1000))
4165 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4166 "bad parameters for retry rule");
4168 while (isspace(*p)) p++;
4172 while (isspace(*p)) p++;
4175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4182 /*************************************************
4183 * Initialize authenticators *
4184 *************************************************/
4186 /* Read the authenticators section of the configuration file.
4195 auth_instance *au, *bu;
4197 readconf_driver_init(US"authenticator",
4198 (driver_instance **)(&auths), /* chain anchor */
4199 (driver_info *)auths_available, /* available drivers */
4200 sizeof(auth_info), /* size of info block */
4201 &auth_defaults, /* default values for generic options */
4202 sizeof(auth_instance), /* size of instance block */
4203 optionlist_auths, /* generic options */
4204 optionlist_auths_size);
4206 for (au = auths; au; au = au->next)
4208 if (!au->public_name)
4209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4210 "the %s authenticator", au->name);
4212 for (bu = au->next; bu; bu = bu->next)
4213 if (strcmpic(au->public_name, bu->public_name) == 0)
4214 if ((au->client && bu->client) || (au->server && bu->server))
4215 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4216 "(%s and %s) have the same public name (%s)",
4217 au->client ? US"client" : US"server", au->name, bu->name,
4225 /*************************************************
4226 * Read ACL information *
4227 *************************************************/
4229 /* If this run of Exim is not doing something that involves receiving a
4230 message, we can just skip over the ACL information. No need to parse it.
4232 First, we have a function for acl_read() to call back to get the next line. We
4233 need to remember the line we passed, because at the end it will contain the
4234 name of the next ACL. */
4236 static uschar *acl_line;
4241 acl_line = get_config_line();
4246 /* Now the main function:
4257 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4260 acl_line = get_config_line();
4268 p = readconf_readname(name, sizeof(name), acl_line);
4269 if (isupper(*name) && *p == '=')
4271 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4272 acl_line = get_config_line();
4276 if (*p != ':' || name[0] == 0)
4277 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4279 node = store_get(sizeof(tree_node) + Ustrlen(name));
4280 Ustrcpy(node->name, name);
4281 if (!tree_insertnode(&acl_anchor, node))
4282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4283 "there are two ACLs called \"%s\"", name);
4285 node->data.ptr = acl_read(acl_callback, &error);
4287 if (node->data.ptr == NULL && error != NULL)
4288 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4294 /*************************************************
4295 * Read configuration for local_scan() *
4296 *************************************************/
4298 /* This function is called after "begin local_scan" is encountered in the
4299 configuration file. If the local_scan() function allows for configuration
4300 options, we can process them. Otherwise, we expire in a panic.
4307 local_scan_init(void)
4309 #ifndef LOCAL_SCAN_HAS_OPTIONS
4310 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4311 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4315 while ((p = get_config_line()))
4317 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4318 NULL, US"local_scan option \"%s\" unknown");
4325 /*************************************************
4326 * Read rest of configuration (after main) *
4327 *************************************************/
4329 /* This function reads the rest of the runtime configuration, after the main
4330 configuration. It is called only when actually needed. Each subsequent section
4331 of the configuration starts with a line of the form
4335 where the name is "routers", "transports", etc. A section is terminated by
4336 hitting the next "begin" line, and the next name is left in next_section.
4337 Because it may confuse people as to whether the names are singular or plural,
4338 we add "s" if it's missing. There is always enough room in next_section for
4339 this. This function is basically just a switch.
4345 static uschar *section_list[] = {
4359 while(next_section[0] != 0)
4363 int last = nelem(section_list);
4365 int n = Ustrlen(next_section);
4367 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4371 int c = strcmpic(next_section, section_list[mid]);
4373 if (c > 0) first = mid + 1; else last = mid;
4375 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4376 "\"%.*s\" is not a known configuration section name", n, next_section);
4377 mid = (last + first)/2;
4381 if (((had ^= bit) & bit) == 0)
4382 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4383 "\"%.*s\" section is repeated in the configuration file", n,
4388 case 0: readconf_acl(); break;
4389 case 1: auths_init(); break;
4390 case 2: local_scan_init(); break;
4391 case 3: readconf_retries(); break;
4392 case 4: readconf_rewrites(); break;
4393 case 5: route_init(); break;
4394 case 6: transport_init(); break;
4398 (void)fclose(config_file);
4401 /* Init the storage for the pre-parsed config lines */
4403 readconf_save_config(const uschar *s)
4405 save_config_line(string_sprintf("# Exim Configuration (%s)",
4406 running_in_test_harness ? US"X" : s));
4410 save_config_position(const uschar *file, int line)
4412 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4415 /* Append a pre-parsed logical line to the config lines store,
4416 this operates on a global (static) list that holds all the pre-parsed
4417 config lines, we do no further processing here, output formatting and
4418 honouring of <hide> or macros will be done during output */
4421 save_config_line(const uschar* line)
4423 static config_line_item *current;
4424 config_line_item *next;
4426 next = (config_line_item*) store_get(sizeof(config_line_item));
4427 next->line = string_copy(line);
4430 if (!config_lines) config_lines = next;
4431 else current->next = next;
4436 /* List the parsed config lines, care about nice formatting and
4437 hide the <hide> values unless we're the admin user */
4439 print_config(BOOL admin, BOOL terse)
4441 config_line_item *i;
4442 const int TS = terse ? 0 : 2;
4445 for (i = config_lines; i; i = i->next)
4450 /* skip over to the first non-space */
4451 for (current = i->line; *current && isspace(*current); ++current)
4454 if (*current == '\0')
4457 /* Collapse runs of spaces. We stop this if we encounter one of the
4458 * following characters: "'$, as this may indicate careful formatting */
4459 for (p = current; *p; ++p)
4462 if (!isspace(*p)) continue;
4463 if (*p != ' ') *p = ' ';
4465 for (next = p; isspace(*next); ++next)
4469 memmove(p+1, next, Ustrlen(next)+1);
4471 if (*next == '"' || *next == '\'' || *next == '$')
4476 if (current[0] == '#')
4479 /* begin lines are left aligned */
4480 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4482 if (!terse) puts("");
4487 /* router/acl/transport block names */
4488 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4490 if (!terse) puts("");
4491 printf("%*s%s\n", TS, "", current);
4495 /* hidden lines (all MACROS or lines prefixed with "hide") */
4497 && ( isupper(*current)
4498 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4502 if ((p = Ustrchr(current, '=')))
4505 printf("%*s%s= %s\n", indent, "", current, hidden);
4507 /* e.g.: hide split_spool_directory */
4509 printf("%*s\n", indent, hidden);
4513 /* rest is public */
4514 printf("%*s%s\n", indent, "", current);
4518 #endif /*!MACRO_PREDEF*/
4521 /* End of readconf.c */