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 { "tls_certificate", opt_stringptr, &tls_certificate },
352 { "tls_crl", opt_stringptr, &tls_crl },
353 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
354 { "tls_dhparam", opt_stringptr, &tls_dhparam },
355 { "tls_eccurve", opt_stringptr, &tls_eccurve },
356 # ifndef DISABLE_OCSP
357 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
359 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
360 { "tls_privatekey", opt_stringptr, &tls_privatekey },
361 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
362 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
363 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
364 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
365 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
367 { "trusted_groups", opt_gidlist, &trusted_groups },
368 { "trusted_users", opt_uidlist, &trusted_users },
369 { "unknown_login", opt_stringptr, &unknown_login },
370 { "unknown_username", opt_stringptr, &unknown_username },
371 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
372 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
373 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
374 { "warn_message_file", opt_stringptr, &warn_message_file },
375 { "write_rejectlog", opt_bool, &write_rejectlog }
379 static int optionlist_config_size = nelem(optionlist_config);
385 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str) {/*Dummy*/}
390 options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
396 struct auth_info * ai;
399 options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
401 for (ai = auths_available; ai->driver_name[0]; ai++)
403 spf(buf, sizeof(buf), US"_DRIVER_AUTHENTICATOR_%T", ai->driver_name);
404 builtin_macro_create(buf);
405 options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
410 #else /*!MACRO_PREDEF*/
412 extern char **environ;
414 static void save_config_line(const uschar* line);
415 static void save_config_position(const uschar *file, int line);
416 static void print_config(BOOL admin, BOOL terse);
419 #define CSTATE_STACK_SIZE 10
421 const uschar *config_directory = NULL;
424 /* Structure for chain (stack) of .included files */
426 typedef struct config_file_item {
427 struct config_file_item *next;
428 const uschar *filename;
429 const uschar *directory;
434 /* Structure for chain of configuration lines (-bP config) */
436 typedef struct config_line_item {
437 struct config_line_item *next;
441 static config_line_item* config_lines;
443 /* Structure of table of conditional words and their state transitions */
445 typedef struct cond_item {
453 /* Structure of table of syslog facility names and values */
455 typedef struct syslog_fac_item {
461 static const char * const hidden = "<value not displayable>";
463 /* Static variables */
465 static config_file_item *config_file_stack = NULL; /* For includes */
467 static uschar *syslog_facility_str = NULL;
468 static uschar next_section[24];
469 static uschar time_buffer[24];
471 /* State variables for conditional loading (.ifdef / .else / .endif) */
473 static int cstate = 0;
474 static int cstate_stack_ptr = -1;
475 static int cstate_stack[CSTATE_STACK_SIZE];
477 /* Table of state transitions for handling conditional inclusions. There are
478 four possible state transitions:
482 .elifdef true (or .else)
485 .endif just causes the previous cstate to be popped off the stack */
487 static int next_cstate[3][4] =
489 /* State 0: reading from file, or reading until next .else or .endif */
491 /* State 1: condition failed, skipping until next .else or .endif */
493 /* State 2: skipping until .endif */
497 /* Table of conditionals and the states to set. For each name, there are four
498 values: the length of the name (to save computing it each time), the state to
499 set if a macro was found in the line, the state to set if a macro was not found
500 in the line, and a stack manipulation setting which is:
502 -1 pull state value off the stack
503 0 don't alter the stack
504 +1 push value onto stack, before setting new state
507 static cond_item cond_list[] = {
508 { US"ifdef", 5, 0, 1, 1 },
509 { US"ifndef", 6, 1, 0, 1 },
510 { US"elifdef", 7, 2, 3, 0 },
511 { US"elifndef", 8, 3, 2, 0 },
512 { US"else", 4, 2, 2, 0 },
513 { US"endif", 5, 0, 0, -1 }
516 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
518 /* Table of syslog facility names and their values */
520 static syslog_fac_item syslog_list[] = {
521 { US"mail", LOG_MAIL },
522 { US"user", LOG_USER },
523 { US"news", LOG_NEWS },
524 { US"uucp", LOG_UUCP },
525 { US"local0", LOG_LOCAL0 },
526 { US"local1", LOG_LOCAL1 },
527 { US"local2", LOG_LOCAL2 },
528 { US"local3", LOG_LOCAL3 },
529 { US"local4", LOG_LOCAL4 },
530 { US"local5", LOG_LOCAL5 },
531 { US"local6", LOG_LOCAL6 },
532 { US"local7", LOG_LOCAL7 },
533 { US"daemon", LOG_DAEMON }
536 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
541 /*************************************************
542 * Find the name of an option *
543 *************************************************/
545 /* This function is to aid debugging. Various functions take arguments that are
546 pointer variables in the options table or in option tables for various drivers.
547 For debugging output, it is useful to be able to find the name of the option
548 which is currently being processed. This function finds it, if it exists, by
549 searching the table(s).
551 Arguments: a value that is presumed to be in the table above
552 Returns: the option name, or an empty string
556 readconf_find_option(void *p)
560 transport_instance *t;
562 for (i = 0; i < nelem(optionlist_config); i++)
563 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
565 for (r = routers; r; r = r->next)
567 router_info *ri = r->info;
568 for (i = 0; i < *ri->options_count; i++)
570 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
571 if (p == CS (r->options_block) + (long int)(ri->options[i].value))
572 return US ri->options[i].name;
576 for (t = transports; t; t = t->next)
578 transport_info *ti = t->info;
579 for (i = 0; i < *ti->options_count; i++)
581 optionlist * op = &ti->options[i];
582 if ((op->type & opt_mask) != opt_stringptr) continue;
583 if (p == ( op->type & opt_public
585 : CS t->options_block
587 + (long int)op->value)
598 /*************************************************
599 * Deal with an assignment to a macro *
600 *************************************************/
602 /* We have a new definition; append to the list.
605 name Name of the macro; will be copied
606 val Expansion result for the macro; will be copied
610 macro_create(const uschar * name, const uschar * val, BOOL command_line)
612 macro_item * m = store_get(sizeof(macro_item));
614 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val); */
616 m->command_line = command_line;
617 m->namelen = Ustrlen(name);
618 m->replen = Ustrlen(val);
619 m->name = string_copy(name);
620 m->replacement = string_copy(val);
632 /* This function is called when a line that starts with an upper case letter is
633 encountered. The argument "line" should contain a complete logical line, and
634 start with the first letter of the macro name. The macro name and the
635 replacement text are extracted and stored. Redefinition of existing,
636 non-command line, macros is permitted using '==' instead of '='.
639 s points to the start of the logical line
641 Returns: FALSE iff fatal error
645 macro_read_assignment(uschar *s)
652 while (isalnum(*s) || *s == '_')
654 if (namelen >= sizeof(name) - 1)
656 log_write(0, LOG_PANIC|LOG_CONFIG_IN,
657 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
660 name[namelen++] = *s++;
664 while (isspace(*s)) s++;
667 log_write(0, LOG_PANIC|LOG_CONFIG_IN, "malformed macro definition");
676 while (isspace(*s)) s++;
678 /* If an existing macro of the same name was defined on the command line, we
679 just skip this definition. It's an error to attempt to redefine a macro without
680 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
681 It is also an error to define a macro whose name begins with the name of a
682 previously defined macro. This is the requirement that make using a tree
683 for macros hard; we must check all macros for the substring. Perhaps a
684 sorted list, and a bsearch, would work?
685 Note: it is documented that the other way round works. */
687 for (m = macros; m; m = m->next)
689 if (Ustrcmp(m->name, name) == 0)
691 if (!m->command_line && !redef)
693 log_write(0, LOG_CONFIG|LOG_PANIC, "macro \"%s\" is already "
694 "defined (use \"==\" if you want to redefine it)", name);
700 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
702 log_write(0, LOG_CONFIG|LOG_PANIC, "\"%s\" cannot be defined as "
703 "a macro because previously defined macro \"%s\" is a substring",
708 /* We cannot have this test, because it is documented that a substring
709 macro is permitted (there is even an example).
711 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
712 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
713 * "a macro because it is a substring of previously defined macro \"%s\"",
718 /* Check for an overriding command-line definition. */
720 if (m && m->command_line) return TRUE;
722 /* Redefinition must refer to an existing macro. */
727 m->replen = Ustrlen(s);
728 m->replacement = string_copy(s);
732 log_write(0, LOG_CONFIG|LOG_PANIC, "can't redefine an undefined macro "
737 /* We have a new definition. */
739 (void) macro_create(name, s, FALSE);
747 /* Process line for macros. The line is in big_buffer starting at offset len.
748 Expand big_buffer if needed. Handle definitions of new macros, and
749 macro expansions, rewriting the line in the buffer.
752 len Offset in buffer of start of line
753 newlen Pointer to offset of end of line, updated on return
754 macro_found Pointer to return that a macro was expanded
756 Return: pointer to first nonblank char in line
760 macros_expand(int len, int * newlen, BOOL * macro_found)
762 uschar * ss = big_buffer + len;
766 /* Find the true start of the physical line - leading spaces are always
769 while (isspace(*ss)) ss++;
771 /* Process the physical line for macros. If this is the start of the logical
772 line, skip over initial text at the start of the line if it starts with an
773 upper case character followed by a sequence of name characters and an equals
774 sign, because that is the definition of a new macro, and we don't do
775 replacement therein. */
778 if (len == 0 && isupper(*s))
780 while (isalnum(*s) || *s == '_') s++;
781 while (isspace(*s)) s++;
782 if (*s != '=') s = ss; /* Not a macro definition */
785 /* Skip leading chars which cannot start a macro name, to avoid multiple
786 pointless rescans in Ustrstr calls. */
788 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
790 /* For each defined macro, scan the line (from after XXX= if present),
791 replacing all occurrences of the macro. */
793 *macro_found = FALSE;
794 if (*s) for (m = *s == '_' ? macros : macros_user; m; m = m->next)
799 while (*s && !isupper(*s) && !(*s == '_' && isupper(s[1]))) s++;
803 while ((p = Ustrstr(t, m->name)) != NULL)
807 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, ss); */
808 /* Expand the buffer if necessary */
810 while (*newlen - m->namelen + m->replen + 1 > big_buffer_size)
812 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
813 uschar *newbuffer = store_malloc(newsize);
814 memcpy(newbuffer, big_buffer, *newlen + 1);
815 p = newbuffer + (p - big_buffer);
816 s = newbuffer + (s - big_buffer);
817 ss = newbuffer + (ss - big_buffer);
818 t = newbuffer + (t - big_buffer);
819 big_buffer_size = newsize;
820 store_free(big_buffer);
821 big_buffer = newbuffer;
824 /* Shuffle the remaining characters up or down in the buffer before
825 copying in the replacement text. Don't rescan the replacement for this
829 if ((moveby = m->replen - m->namelen) != 0)
831 memmove(p + m->replen, pp, (big_buffer + *newlen) - pp + 1);
834 Ustrncpy(p, m->replacement, m->replen);
836 while (*t && !isupper(*t) && !(*t == '_' && isupper(t[1]))) t++;
841 /* An empty macro replacement at the start of a line could mean that ss no
842 longer points to the first non-blank character. */
844 while (isspace(*ss)) ss++;
848 /*************************************************
849 * Read configuration line *
850 *************************************************/
852 /* A logical line of text is read from the configuration file into the big
853 buffer, taking account of macros, .includes, and continuations. The size of
854 big_buffer is increased if necessary. The count of configuration lines is
855 maintained. Physical input lines starting with # (ignoring leading white space,
856 and after macro replacement) and empty logical lines are always ignored.
857 Leading and trailing spaces are removed.
859 If we hit a line of the form "begin xxxx", the xxxx is placed in the
860 next_section vector, and the function returns NULL, indicating the end of a
861 configuration section. On end-of-file, NULL is returned with next_section
866 Returns: a pointer to the first non-blank in the line,
867 or NULL if eof or end of section is reached
871 get_config_line(void)
873 int startoffset = 0; /* To first non-blank char in logical line */
874 int len = 0; /* Of logical line so far */
879 /* Loop for handling continuation lines, skipping comments, and dealing with
884 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
886 if (config_file_stack != NULL) /* EOF inside .include */
888 (void)fclose(config_file);
889 config_file = config_file_stack->file;
890 config_filename = config_file_stack->filename;
891 config_directory = config_file_stack->directory;
892 config_lineno = config_file_stack->lineno;
893 config_file_stack = config_file_stack->next;
895 save_config_position(config_filename, config_lineno);
899 /* EOF at top level */
901 if (cstate_stack_ptr >= 0)
902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
903 "Unexpected end of configuration file: .endif missing");
905 if (len != 0) break; /* EOF after continuation */
906 next_section[0] = 0; /* EOF at start of logical line */
911 newlen = len + Ustrlen(big_buffer + len);
913 if (config_lines && config_lineno == 1)
914 save_config_position(config_filename, config_lineno);
916 /* Handle pathologically long physical lines - yes, it did happen - by
917 extending big_buffer at this point. The code also copes with very long
920 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
923 big_buffer_size += BIG_BUFFER_SIZE;
924 newbuffer = store_malloc(big_buffer_size);
926 /* This use of strcpy is OK because we know that the string in the old
927 buffer is shorter than the new buffer. */
929 Ustrcpy(newbuffer, big_buffer);
930 store_free(big_buffer);
931 big_buffer = newbuffer;
932 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
934 newlen += Ustrlen(big_buffer + newlen);
937 ss = macros_expand(len, &newlen, ¯o_found);
939 /* Check for comment lines - these are physical lines. */
941 if (*ss == '#') continue;
943 /* Handle conditionals, which are also applied to physical lines. Conditions
944 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
945 expansion occured on the rest of the line. A preliminary test for the leading
946 '.' saves effort on most lines. */
952 /* Search the list of conditional directives */
954 for (i = 0; i < cond_list_size; i++)
957 cond_item *c = cond_list+i;
958 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
960 /* The following character must be white space or end of string */
962 n = ss[1 + c->namelen];
963 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
965 /* .ifdef and .ifndef push the current state onto the stack, then set
966 a new one from the table. Stack overflow is an error */
970 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
971 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
972 ".%s nested too deeply", c->name);
973 cstate_stack[++cstate_stack_ptr] = cstate;
974 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
977 /* For any of the others, stack underflow is an error. The next state
978 comes either from the stack (.endif) or from the table. */
982 if (cstate_stack_ptr < 0)
983 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
984 ".%s without matching .ifdef", c->name);
985 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
986 next_cstate[cstate][macro_found? c->action1 : c->action2];
989 /* Having dealt with a directive, break the loop */
994 /* If we have handled a conditional directive, continue with the next
995 physical line. Otherwise, fall through. */
997 if (i < cond_list_size) continue;
1000 /* If the conditional state is not 0 (actively using these lines), ignore
1003 if (cstate != 0) continue; /* Conditional skip */
1005 /* Handle .include lines - these are also physical lines. */
1007 if (Ustrncmp(ss, ".include", 8) == 0 &&
1009 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1012 int include_if_exists = isspace(ss[8])? 0 : 10;
1013 config_file_item *save;
1014 struct stat statbuf;
1016 ss += 9 + include_if_exists;
1017 while (isspace(*ss)) ss++;
1018 t = ss + Ustrlen(ss);
1019 while (t > ss && isspace(t[-1])) t--;
1020 if (*ss == '\"' && t[-1] == '\"')
1027 /* We allow relative file names. For security reasons currently
1028 relative names not allowed with .include_if_exists. For .include_if_exists
1029 we need to check the permissions/ownership of the containing folder */
1031 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1032 "absolute path \"%s\"", ss);
1035 gstring * g = string_append(NULL, 3, config_directory, "/", ss);
1036 ss = string_from_gstring(g);
1039 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1042 save_config_position(config_filename, config_lineno);
1043 save = store_get(sizeof(config_file_item));
1044 save->next = config_file_stack;
1045 config_file_stack = save;
1046 save->file = config_file;
1047 save->filename = config_filename;
1048 save->directory = config_directory;
1049 save->lineno = config_lineno;
1051 if (!(config_file = Ufopen(ss, "rb")))
1052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1053 "configuration file %s", ss);
1055 config_filename = string_copy(ss);
1056 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1061 /* If this is the start of the logical line, remember where the non-blank
1062 data starts. Otherwise shuffle down continuation lines to remove leading
1066 startoffset = ss - big_buffer;
1069 s = big_buffer + len;
1072 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1077 /* Accept the new addition to the line. Remove trailing white space. */
1080 while (len > 0 && isspace(big_buffer[len-1])) len--;
1081 big_buffer[len] = 0;
1083 /* We are done if the line does not end in backslash and contains some data.
1084 Empty logical lines are ignored. For continuations, remove the backslash and
1085 go round the loop to read the continuation line. */
1089 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1090 big_buffer[--len] = 0; /* Remove backslash */
1092 } /* Loop for reading multiple physical lines */
1094 /* We now have a logical line. Test for the end of a configuration section (or,
1095 more accurately, for the start of the next section). Place the name of the next
1096 section in next_section, and return NULL. If the name given is longer than
1097 next_section, truncate it. It will be unrecognized later, because all the known
1098 section names do fit. Leave space for pluralizing. */
1100 s = big_buffer + startoffset; /* First non-space character */
1103 save_config_line(s);
1105 if (strncmpic(s, US"begin ", 6) == 0)
1108 while (isspace(*s)) s++;
1109 if (big_buffer + len - s > sizeof(next_section) - 2)
1110 s[sizeof(next_section) - 2] = 0;
1111 Ustrcpy(next_section, s);
1115 /* Return the first non-blank character. */
1122 /*************************************************
1124 *************************************************/
1126 /* The yield is the pointer to the next uschar. Names longer than the
1127 output space are silently truncated. This function is also used from acl.c when
1131 name where to put the name
1135 Returns: new input pointer
1139 readconf_readname(uschar *name, int len, uschar *s)
1142 while (isspace(*s)) s++;
1145 while (isalnum(*s) || *s == '_')
1147 if (p < len-1) name[p++] = *s;
1152 while (isspace(*s)) s++;
1159 /*************************************************
1160 * Read a time value *
1161 *************************************************/
1163 /* This function is also called from outside, to read argument
1164 time values. The format of a time value is:
1166 [<n>w][<n>d][<n>h][<n>m][<n>s]
1168 as long as at least one is present. If a format error is encountered,
1169 return a negative value. The value must be terminated by the given
1174 terminator required terminating character
1175 return_msec if TRUE, allow fractional seconds and return milliseconds
1177 Returns: the time value, or -1 on syntax error
1178 value is seconds if return_msec is FALSE
1179 value is milliseconds if return_msec is TRUE
1183 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1191 if (!isdigit(*s)) return -1;
1192 (void)sscanf(CCS s, "%d%n", &value, &count);
1197 case 'w': value *= 7;
1198 case 'd': value *= 24;
1199 case 'h': value *= 60;
1200 case 'm': value *= 60;
1205 if (!return_msec) return -1;
1206 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1208 if (*s++ != 's') return -1;
1209 yield += (int)(fraction * 1000.0);
1215 if (return_msec) value *= 1000;
1217 if (*s == terminator) return yield;
1219 /* Control never reaches here. */
1224 /*************************************************
1225 * Read a fixed point value *
1226 *************************************************/
1228 /* The value is returned *1000
1232 terminator required terminator
1234 Returns: the value, or -1 on error
1238 readconf_readfixed(const uschar *s, int terminator)
1242 if (!isdigit(*s)) return -1;
1243 (void)sscanf(CS s, "%d%n", &value, &count);
1245 yield = value * 1000;
1249 while (isdigit((*(++s))))
1251 yield += (*s - '0') * m;
1256 return (*s == terminator)? yield : (-1);
1261 /*************************************************
1262 * Find option in list *
1263 *************************************************/
1265 /* The lists are always in order, so binary chop can be used.
1268 name the option name to search for
1269 ol the first entry in the option list
1270 last one more than the offset of the last entry in the option list
1272 Returns: pointer to an option entry, or NULL if not found
1276 find_option(uschar *name, optionlist *ol, int last)
1279 while (last > first)
1281 int middle = (first + last)/2;
1282 int c = Ustrcmp(name, ol[middle].name);
1284 if (c == 0) return ol + middle;
1285 else if (c > 0) first = middle + 1;
1293 /*************************************************
1294 * Find a set flag in option list *
1295 *************************************************/
1297 /* Because some versions of Unix make no restrictions on the values of uids and
1298 gids (even negative ones), we cannot represent "unset" by a special value.
1299 There is therefore a separate boolean variable for each one indicating whether
1300 a value is set or not. This function returns a pointer to the boolean, given
1301 the original option name. It is a major disaster if the flag cannot be found.
1304 name the name of the uid or gid option
1305 oltop points to the start of the relevant option list
1306 last one more than the offset of the last item in the option list
1307 data_block NULL when reading main options => data values in the option
1308 list are absolute addresses; otherwise they are byte offsets
1309 in data_block (used for driver options)
1311 Returns: a pointer to the boolean flag.
1315 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1319 sprintf(CS name2, "*set_%.50s", name);
1320 ol = find_option(name2, oltop, last);
1321 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1322 "Exim internal error: missing set flag for %s", name);
1323 return (data_block == NULL)? (BOOL *)(ol->value) :
1324 (BOOL *)(US data_block + (long int)(ol->value));
1330 /*************************************************
1331 * Output extra characters message and die *
1332 *************************************************/
1334 /* Called when an option line has junk on the end. Sometimes this is because
1335 the sysadmin thinks comments are permitted.
1338 s points to the extra characters
1339 t1..t3 strings to insert in the log message
1341 Returns: doesn't return; dies
1345 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1347 uschar *comment = US"";
1348 if (*s == '#') comment = US" (# is comment only at line start)";
1349 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1350 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1355 /*************************************************
1356 * Read rewrite information *
1357 *************************************************/
1359 /* Each line of rewrite information contains:
1361 . A complete address in the form user@domain, possibly with
1362 leading * for each part; or alternatively, a regex.
1364 . A replacement string (which will be expanded).
1366 . An optional sequence of one-letter flags, indicating which
1367 headers etc. to apply this rule to.
1369 All this is decoded and placed into a control block. The OR of the flags is
1370 maintained in a common word.
1373 p points to the string that makes up the rule
1374 existflags points to the overall flag word
1375 isglobal TRUE if reading global rewrite rules
1377 Returns: the control block for the parsed rule.
1380 static rewrite_rule *
1381 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1383 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1386 next->key = string_dequote(&p);
1388 while (isspace(*p)) p++;
1390 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1391 "missing rewrite replacement string");
1394 next->replacement = string_dequote(&p);
1396 while (*p != 0) switch (*p++)
1398 case ' ': case '\t': break;
1400 case 'q': next->flags |= rewrite_quit; break;
1401 case 'w': next->flags |= rewrite_whole; break;
1403 case 'h': next->flags |= rewrite_all_headers; break;
1404 case 's': next->flags |= rewrite_sender; break;
1405 case 'f': next->flags |= rewrite_from; break;
1406 case 't': next->flags |= rewrite_to; break;
1407 case 'c': next->flags |= rewrite_cc; break;
1408 case 'b': next->flags |= rewrite_bcc; break;
1409 case 'r': next->flags |= rewrite_replyto; break;
1411 case 'E': next->flags |= rewrite_all_envelope; break;
1412 case 'F': next->flags |= rewrite_envfrom; break;
1413 case 'T': next->flags |= rewrite_envto; break;
1415 case 'Q': next->flags |= rewrite_qualify; break;
1416 case 'R': next->flags |= rewrite_repeat; break;
1419 next->flags |= rewrite_smtp;
1420 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1421 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1422 "rewrite rule has the S flag but is not a regular expression");
1426 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1427 "unknown rewrite flag character '%c' "
1428 "(could be missing quotes round replacement item)", p[-1]);
1432 /* If no action flags are set, set all the "normal" rewrites. */
1434 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1435 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1437 /* Remember which exist, for optimization, and return the rule */
1439 *existflags |= next->flags;
1446 /*************************************************
1447 * Read global rewrite information *
1448 *************************************************/
1450 /* Each line is a single rewrite rule; it is parsed into a control block
1451 by readconf_one_rewrite(), and its flags are ORed into the global flag
1452 word rewrite_existflags. */
1455 readconf_rewrites(void)
1457 rewrite_rule **chain = &global_rewrite_rules;
1460 while ((p = get_config_line()) != NULL)
1462 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1464 chain = &(next->next);
1470 /*************************************************
1472 *************************************************/
1474 /* Strings are read into the normal store pool. As long we aren't too
1475 near the end of the current block, the string will just use what is necessary
1476 on the top of the stacking pool, because string_cat() uses the extension
1480 s the rest of the input line
1481 name the option name (for errors)
1483 Returns: pointer to the string
1487 read_string(const uschar *s, const uschar *name)
1492 if (*s != '\"') return string_copy(s);
1495 yield = string_dequote(&s);
1497 if (s == ss+1 || s[-1] != '\"')
1498 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1499 "missing quote at end of string value for %s", name);
1501 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1507 /*************************************************
1508 * Custom-handler options *
1509 *************************************************/
1511 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1514 smtp_receive_timeout_s = string_copy(str);
1517 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1518 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1519 if (smtp_receive_timeout < 0)
1520 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1525 /*************************************************
1526 * Handle option line *
1527 *************************************************/
1529 /* This function is called from several places to process a line containing the
1530 setting of an option. The first argument is the line to be decoded; it has been
1531 checked not to be empty and not to start with '#'. Trailing newlines and white
1532 space have been removed. The second argument is a pointer to the list of
1533 variable names that are to be recognized, together with their types and
1534 locations, and the third argument gives the number of entries in the list.
1536 The fourth argument is a pointer to a data block. If it is NULL, then the data
1537 values in the options list are absolute addresses. Otherwise, they are byte
1538 offsets in the data block.
1540 String option data may continue onto several lines; this function reads further
1541 data from config_file if necessary.
1543 The yield of this function is normally zero. If a string continues onto
1544 multiple lines, then the data value is permitted to be followed by a comma
1545 or a semicolon (for use in drivers) and the yield is that character.
1548 buffer contains the configuration line to be handled
1549 oltop points to the start of the relevant option list
1550 last one more than the offset of the last item in the option list
1551 data_block NULL when reading main options => data values in the option
1552 list are absolute addresses; otherwise they are byte offsets
1553 in data_block when they have opt_public set; otherwise
1554 they are byte offsets in data_block->options_block.
1555 unknown_txt format string to use in panic message for unknown option;
1556 must contain %s for option name
1557 if given as NULL, don't panic on unknown option
1559 Returns: TRUE if an option was read successfully,
1560 FALSE false for an unknown option if unknown_txt == NULL,
1561 otherwise panic and die on an unknown option
1565 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1566 void *data_block, uschar *unknown_txt)
1570 int n, count, type, value;
1574 BOOL boolvalue = TRUE;
1575 BOOL freesptr = TRUE;
1576 optionlist *ol, *ol2;
1580 uschar *inttype = US"";
1583 uschar **str_target;
1587 /* There may be leading spaces; thereafter, we expect an option name starting
1590 while (isspace(*s)) s++;
1592 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1594 /* Read the name of the option, and skip any subsequent white space. If
1595 it turns out that what we read was "hide", set the flag indicating that
1596 this is a secure option, and loop to read the next word. */
1598 for (n = 0; n < 2; n++)
1600 while (isalnum(*s) || *s == '_')
1602 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1606 while (isspace(*s)) s++;
1607 if (Ustrcmp(name, "hide") != 0) break;
1608 issecure = opt_secure;
1612 /* Deal with "no_" or "not_" here for booleans */
1614 if (Ustrncmp(name, "no_", 3) == 0)
1620 if (Ustrncmp(name, "not_", 4) == 0)
1626 /* Search the list for the given name. A non-existent name, or an option that
1627 is set twice, is a disaster. */
1629 if (!(ol = find_option(name + offset, oltop, last)))
1631 if (unknown_txt == NULL) return FALSE;
1632 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1635 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1636 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1637 "\"%s\" option set for the second time", name);
1639 ol->type |= opt_set | issecure;
1640 type = ol->type & opt_mask;
1642 /* Types with data values must be followed by '='; the "no[t]_" prefix
1643 applies only to boolean values. */
1645 if (type < opt_bool || type > opt_bool_last)
1648 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1649 "negation prefix applied to a non-boolean option");
1651 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1652 "unexpected end of line (data missing) after %s", name);
1654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1657 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1658 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1659 ultimately expands to one of those values. */
1661 else if (*s != 0 && (offset != 0 || *s != '='))
1662 extra_chars_error(s, US"boolean option ", name, US"");
1664 /* Skip white space after = */
1666 if (*s == '=') while (isspace((*(++s))));
1668 /* If there is a data block and the opt_public flag is not set, change
1669 the data block pointer to the private options block. */
1671 if (data_block != NULL && (ol->type & opt_public) == 0)
1672 data_block = (void *)(((driver_instance *)data_block)->options_block);
1674 /* Now get the data according to the type. */
1678 /* If a string value is not enclosed in quotes, it consists of
1679 the rest of the current line, verbatim. Otherwise, string escapes
1682 A transport is specified as a string, which is then looked up in the
1683 list of transports. A search type is specified as one of a number of
1686 A set or rewrite rules for a driver is specified as a string, which is
1687 then parsed into a suitable chain of control blocks.
1689 Uids and gids are specified as strings which are then looked up in the
1690 passwd file. Lists of uids and gids are similarly specified as colon-
1691 separated strings. */
1696 case opt_expand_uid:
1697 case opt_expand_gid:
1702 reset_point = sptr = read_string(s, name);
1704 /* Having read a string, we now have several different ways of using it,
1705 depending on the data type, so do another switch. If keeping the actual
1706 string is not required (because it is interpreted), freesptr is set TRUE,
1707 and at the end we reset the pool. */
1711 /* If this was a string, set the variable to point to the new string,
1712 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1713 rules, we still keep the string (for printing), and parse the rules into a
1714 control block and flags word. */
1717 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1719 if (ol->type & opt_rep_con)
1721 uschar * saved_condition;
1722 /* We already have a condition, we're conducting a crude hack to let
1723 multiple condition rules be chained together, despite storing them in
1725 *str_target = string_copy_malloc( (saved_condition = *str_target)
1726 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1727 saved_condition, sptr)
1729 /* TODO(pdp): there is a memory leak here and just below
1730 when we set 3 or more conditions; I still don't
1731 understand the store mechanism enough to know
1732 what's the safe way to free content from an earlier store.
1733 AFAICT, stores stack, so freeing an early stored item also stores
1734 all data alloc'd after it. If we knew conditions were adjacent,
1735 we could survive that, but we don't. So I *think* we need to take
1736 another bit from opt_type to indicate "malloced"; this seems like
1737 quite a hack, especially for this one case. It also means that
1738 we can't ever reclaim the store from the *first* condition.
1740 Because we only do this once, near process start-up, I'm prepared to
1741 let this slide for the time being, even though it rankles. */
1743 else if (ol->type & opt_rep_str)
1745 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1746 int sep_i = -(int)sep_o;
1747 const uschar * list = sptr;
1749 gstring * list_o = NULL;
1753 list_o = string_get(Ustrlen(*str_target) + Ustrlen(sptr));
1754 list_o = string_cat(list_o, *str_target);
1757 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1758 list_o = string_append_listele(list_o, sep_o, s);
1761 *str_target = string_copy_malloc(string_from_gstring(list_o));
1772 *USS (US data_block + (long int)(ol->value)) = sptr;
1774 *USS (ol->value) = sptr;
1776 if (type == opt_rewrite)
1781 rewrite_rule **chain;
1784 sprintf(CS name2, "*%.50s_rules", name);
1785 ol2 = find_option(name2, oltop, last);
1786 sprintf(CS name2, "*%.50s_flags", name);
1787 ol3 = find_option(name2, oltop, last);
1789 if (ol2 == NULL || ol3 == NULL)
1790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1791 "rewrite rules not available for driver");
1793 if (data_block == NULL)
1795 chain = (rewrite_rule **)(ol2->value);
1796 flagptr = (int *)(ol3->value);
1800 chain = (rewrite_rule **)(US data_block + (long int)(ol2->value));
1801 flagptr = (int *)(US data_block + (long int)(ol3->value));
1804 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1806 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1808 chain = &(next->next);
1811 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1812 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1813 "non-header rewrite - not allowed at transport time -");
1817 /* If it was an expanded uid, see if there is any expansion to be
1818 done by checking for the presence of a $ character. If there is, save it
1819 in the corresponding *expand_user option field. Otherwise, fall through
1820 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1823 case opt_expand_uid:
1824 sprintf(CS name2, "*expand_%.50s", name);
1825 ol2 = find_option(name2, oltop, last);
1828 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1830 if (data_block == NULL)
1831 *((uschar **)(ol2->value)) = ss;
1833 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1837 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1843 /* Look up a fixed uid, and also make use of the corresponding gid
1844 if a passwd entry is returned and the gid has not been set. */
1847 if (!route_finduser(sptr, &pw, &uid))
1848 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1849 if (data_block == NULL)
1850 *((uid_t *)(ol->value)) = uid;
1852 *((uid_t *)(US data_block + (long int)(ol->value))) = uid;
1854 /* Set the flag indicating a fixed value is set */
1856 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1858 /* Handle matching gid if we have a passwd entry: done by finding the
1859 same name with terminating "user" changed to "group"; if not found,
1860 ignore. Also ignore if the value is already set. */
1862 if (pw == NULL) break;
1863 Ustrcpy(name+Ustrlen(name)-4, "group");
1864 ol2 = find_option(name, oltop, last);
1865 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1866 (ol2->type & opt_mask) == opt_expand_gid))
1868 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1871 if (data_block == NULL)
1872 *((gid_t *)(ol2->value)) = pw->pw_gid;
1874 *((gid_t *)(US data_block + (long int)(ol2->value))) = pw->pw_gid;
1880 /* If it was an expanded gid, see if there is any expansion to be
1881 done by checking for the presence of a $ character. If there is, save it
1882 in the corresponding *expand_user option field. Otherwise, fall through
1883 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1886 case opt_expand_gid:
1887 sprintf(CS name2, "*expand_%.50s", name);
1888 ol2 = find_option(name2, oltop, last);
1891 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1893 if (data_block == NULL)
1894 *((uschar **)(ol2->value)) = ss;
1896 *((uschar **)(US data_block + (long int)(ol2->value))) = ss;
1900 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1906 /* Handle freestanding gid */
1909 if (!route_findgroup(sptr, &gid))
1910 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1911 if (data_block == NULL)
1912 *((gid_t *)(ol->value)) = gid;
1914 *((gid_t *)(US data_block + (long int)(ol->value))) = gid;
1915 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1918 /* If it was a uid list, look up each individual entry, and build
1919 a vector of uids, with a count in the first element. Put the vector
1920 in malloc store so we can free the string. (We are reading into
1921 permanent store already.) */
1929 const uschar *op = expand_string (sptr);
1932 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1933 name, expand_string_message);
1936 if (*p != 0) count++;
1937 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1938 list = store_malloc(count*sizeof(uid_t));
1939 list[ptr++] = (uid_t)(count - 1);
1941 if (data_block == NULL)
1942 *((uid_t **)(ol->value)) = list;
1944 *((uid_t **)(US data_block + (long int)(ol->value))) = list;
1950 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1951 if (!route_finduser(big_buffer, NULL, &uid))
1952 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1959 /* If it was a gid list, look up each individual entry, and build
1960 a vector of gids, with a count in the first element. Put the vector
1961 in malloc store so we can free the string. (We are reading into permanent
1970 const uschar *op = expand_string (sptr);
1973 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1974 name, expand_string_message);
1977 if (*p != 0) count++;
1978 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1979 list = store_malloc(count*sizeof(gid_t));
1980 list[ptr++] = (gid_t)(count - 1);
1982 if (data_block == NULL)
1983 *((gid_t **)(ol->value)) = list;
1985 *((gid_t **)(US data_block + (long int)(ol->value))) = list;
1991 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1992 if (!route_findgroup(big_buffer, &gid))
1993 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2001 /* Release store if the value of the string doesn't need to be kept. */
2003 if (freesptr) store_reset(reset_point);
2006 /* Expanded boolean: if no characters follow, or if there are no dollar
2007 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2008 save the string for later expansion in the alternate place. */
2010 case opt_expand_bool:
2011 if (*s != 0 && Ustrchr(s, '$') != 0)
2013 sprintf(CS name2, "*expand_%.50s", name);
2014 ol2 = find_option(name2, oltop, last);
2017 reset_point = sptr = read_string(s, name);
2018 if (data_block == NULL)
2019 *((uschar **)(ol2->value)) = sptr;
2021 *((uschar **)(US data_block + (long int)(ol2->value))) = sptr;
2028 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2029 look for yes/not/true/false. Some booleans are stored in a single bit in
2030 a single int. There's a special fudge for verify settings; without a suffix
2031 they set both xx_sender and xx_recipient. The table points to the sender
2032 value; search subsequently for the recipient. There's another special case:
2033 opt_bool_set also notes when a boolean has been set. */
2037 case opt_bool_verify:
2041 s = readconf_readname(name2, 64, s);
2042 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2044 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2046 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2047 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2048 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2049 US"for boolean option ", name);
2052 /* Handle single-bit type. */
2054 if (type == opt_bit)
2056 int bit = 1 << ((ol->type >> 16) & 31);
2057 int *ptr = (data_block == NULL)?
2058 (int *)(ol->value) :
2059 (int *)(US data_block + (long int)ol->value);
2060 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2064 /* Handle full BOOL types */
2066 if (data_block == NULL)
2067 *((BOOL *)(ol->value)) = boolvalue;
2069 *((BOOL *)(US data_block + (long int)(ol->value))) = boolvalue;
2073 if (type == opt_bool_verify)
2075 sprintf(CS name2, "%.50s_recipient", name + offset);
2076 ol2 = find_option(name2, oltop, last);
2079 if (data_block == NULL)
2080 *((BOOL *)(ol2->value)) = boolvalue;
2082 *((BOOL *)(US data_block + (long int)(ol2->value))) = boolvalue;
2086 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2088 else if (type == opt_bool_set)
2090 sprintf(CS name2, "*set_%.50s", name + offset);
2091 ol2 = find_option(name2, oltop, last);
2094 if (data_block == NULL)
2095 *((BOOL *)(ol2->value)) = TRUE;
2097 *((BOOL *)(US data_block + (long int)(ol2->value))) = TRUE;
2106 inttype = US"octal ";
2108 /* Integer: a simple(ish) case; allow octal and hex formats, and
2109 suffixes K, M and G. The different types affect output, not input. */
2118 lvalue = strtol(CS s, CSS &endptr, intbase);
2121 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2124 if (errno != ERANGE)
2125 if (tolower(*endptr) == 'k')
2127 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2128 else lvalue *= 1024;
2131 else if (tolower(*endptr) == 'm')
2133 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2135 else lvalue *= 1024*1024;
2138 else if (tolower(*endptr) == 'g')
2140 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2142 else lvalue *= 1024*1024*1024;
2146 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2148 "absolute value of integer \"%s\" is too large (overflow)", s);
2150 while (isspace(*endptr)) endptr++;
2152 extra_chars_error(endptr, inttype, US"integer value for ", name);
2154 value = (int)lvalue;
2157 if (data_block == NULL)
2158 *((int *)(ol->value)) = value;
2160 *((int *)(US data_block + (long int)(ol->value))) = value;
2163 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2165 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2171 value = strtol(CS s, CSS &endptr, intbase);
2174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2177 if (errno != ERANGE)
2178 if (tolower(*endptr) == 'g')
2180 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2186 else if (tolower(*endptr) == 'm')
2188 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2194 else if (tolower(*endptr) == 'k')
2197 value = (value + 512)/1024;
2199 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2200 "absolute value of integer \"%s\" is too large (overflow)", s);
2202 while (isspace(*endptr)) endptr++;
2204 extra_chars_error(endptr, inttype, US"integer value for ", name);
2207 if (data_block == NULL)
2208 *((int *)(ol->value)) = value;
2210 *((int *)(US data_block + (long int)(ol->value))) = value;
2213 /* Fixed-point number: held to 3 decimal places. */
2216 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2217 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2218 "fixed-point number expected for %s", name);
2220 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2221 "integer \"%s\" is too large (overflow)", s);
2225 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2226 "integer \"%s\" is too large (overflow)", s);
2228 /* We get a coverity error here for using count, as it derived
2229 from the tainted buffer pointed to by s, as parsed by sscanf().
2230 By the definition of sscanf we must be accessing between start
2231 and end of s (assuming it is nul-terminated...) so ignore the error. */
2232 /* coverity[tainted_data] */
2233 if (s[count] == '.')
2236 while (isdigit(s[++count]))
2238 value += (s[count] - '0') * d;
2243 while (isspace(s[count])) count++;
2246 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2248 if (data_block == NULL)
2249 *((int *)(ol->value)) = value;
2251 *((int *)(US data_block + (long int)(ol->value))) = value;
2254 /* There's a special routine to read time values. */
2257 value = readconf_readtime(s, 0, FALSE);
2259 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2261 if (data_block == NULL)
2262 *((int *)(ol->value)) = value;
2264 *((int *)(US data_block + (long int)(ol->value))) = value;
2267 /* A time list is a list of colon-separated times, with the first
2268 element holding the size of the list and the second the number of
2274 int *list = (data_block == NULL)?
2275 (int *)(ol->value) :
2276 (int *)(US data_block + (long int)(ol->value));
2278 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2281 uschar *snext = Ustrchr(s, ':');
2285 while (ss > s && isspace(ss[-1])) ss--;
2288 value = readconf_readtime(s, terminator, FALSE);
2290 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2292 if (count > 1 && value <= list[count])
2293 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2294 "time value out of order for %s", name);
2295 list[count+1] = value;
2296 if (snext == NULL) break;
2298 while (isspace(*s)) s++;
2301 if (count > list[0] - 2)
2302 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2304 if (count > 0 && list[2] == 0) count = 0;
2311 void (*fn)() = ol->value;
2322 /*************************************************
2323 * Print a time value *
2324 *************************************************/
2327 Argument: a time value in seconds
2328 Returns: pointer to a fixed buffer containing the time as a string,
2329 in readconf_readtime() format
2333 readconf_printtime(int t)
2336 uschar *p = time_buffer;
2353 if (w > 0) p += sprintf(CS p, "%dw", w);
2354 if (d > 0) p += sprintf(CS p, "%dd", d);
2355 if (h > 0) p += sprintf(CS p, "%dh", h);
2356 if (m > 0) p += sprintf(CS p, "%dm", m);
2357 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2364 /*************************************************
2365 * Print an individual option value *
2366 *************************************************/
2368 /* This is used by the -bP option, so prints to the standard output.
2369 The entire options list is passed in as an argument, because some options come
2370 in pairs - typically uid/gid settings, which can either be explicit numerical
2371 values, or strings to be expanded later. If the numerical value is unset,
2372 search for "*expand_<name>" to see if there is a string equivalent.
2375 ol option entry, or NULL for an unknown option
2377 options_block NULL for main configuration options; otherwise points to
2378 a driver block; if the option doesn't have opt_public
2379 set, then options_block->options_block is where the item
2381 oltop points to the option list in which ol exists
2382 last one more than the offset of the last entry in optop
2383 no_labels do not show "foo = " at the start.
2385 Returns: boolean success
2389 print_ol(optionlist *ol, uschar *name, void *options_block,
2390 optionlist *oltop, int last, BOOL no_labels)
2403 printf("%s is not a known option\n", name);
2407 /* Non-admin callers cannot see options that have been flagged secure by the
2410 if (!admin_user && ol->type & opt_secure)
2413 printf("%s\n", hidden);
2415 printf("%s = %s\n", name, hidden);
2419 /* Else show the value of the option */
2424 if (!(ol->type & opt_public))
2425 options_block = (void *)(((driver_instance *)options_block)->options_block);
2426 value = (void *)(US options_block + (long int)value);
2429 switch(ol->type & opt_mask)
2432 case opt_rewrite: /* Show the text value */
2434 if (!no_labels) printf("%s = ", name);
2435 printf("%s\n", s ? string_printing2(s, FALSE) : US"");
2439 if (!no_labels) printf("%s = ", name);
2440 printf("%d\n", *((int *)value));
2445 int x = *((int *)value);
2446 if (x != 0 && (x & 1023) == 0)
2450 if ((x & 1023) == 0)
2455 if (!no_labels) printf("%s = ", name);
2456 printf("%d%c\n", x, c);
2460 if (!no_labels) printf("%s = ", name);
2468 int x = *((int *)value);
2469 if (!no_labels) printf("%s = ", name);
2470 if (x == 0) printf("0\n");
2471 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2472 else printf("%dK\n", x);
2477 if (!no_labels) printf("%s = ", name);
2478 printf("%#o\n", *((int *)value));
2481 /* Can be negative only when "unset", in which case integer */
2485 int x = *((int *)value);
2488 if (x < 0) printf("%s =\n", name); else
2490 if (!no_labels) printf("%s = ", name);
2491 printf("%d.", x/1000);
2504 /* If the numerical value is unset, try for the string value */
2506 case opt_expand_uid:
2507 if (! *get_set_flag(name, oltop, last, options_block))
2509 sprintf(CS name2, "*expand_%.50s", name);
2510 if ((ol2 = find_option(name2, oltop, last)))
2512 void *value2 = ol2->value;
2514 value2 = (void *)(US options_block + (long int)value2);
2516 if (!no_labels) printf("%s = ", name);
2517 printf("%s\n", s ? string_printing(s) : US"");
2522 /* Else fall through */
2525 if (!no_labels) printf("%s = ", name);
2526 if (! *get_set_flag(name, oltop, last, options_block))
2529 if ((pw = getpwuid(*((uid_t *)value))))
2530 printf("%s\n", pw->pw_name);
2532 printf("%ld\n", (long int)(*((uid_t *)value)));
2535 /* If the numerical value is unset, try for the string value */
2537 case opt_expand_gid:
2538 if (! *get_set_flag(name, oltop, last, options_block))
2540 sprintf(CS name2, "*expand_%.50s", name);
2541 if ( (ol2 = find_option(name2, oltop, last))
2542 && (ol2->type & opt_mask) == opt_stringptr)
2544 void *value2 = ol2->value;
2546 value2 = (void *)(US options_block + (long int)value2);
2548 if (!no_labels) printf("%s = ", name);
2549 printf("%s\n", s ? string_printing(s) : US"");
2554 /* Else fall through */
2557 if (!no_labels) printf("%s = ", name);
2558 if (! *get_set_flag(name, oltop, last, options_block))
2561 if ((gr = getgrgid(*((int *)value))))
2562 printf("%s\n", gr->gr_name);
2564 printf("%ld\n", (long int)(*((int *)value)));
2568 uidlist = *((uid_t **)value);
2569 if (!no_labels) printf("%s =", name);
2573 uschar sep = no_labels ? '\0' : ' ';
2574 for (i = 1; i <= (int)(uidlist[0]); i++)
2576 uschar *name = NULL;
2577 if ((pw = getpwuid(uidlist[i]))) name = US pw->pw_name;
2578 if (sep != '\0') printf("%c", sep);
2579 if (name) printf("%s", name);
2580 else printf("%ld", (long int)(uidlist[i]));
2588 gidlist = *((gid_t **)value);
2589 if (!no_labels) printf("%s =", name);
2593 uschar sep = no_labels ? '\0' : ' ';
2594 for (i = 1; i <= (int)(gidlist[0]); i++)
2596 uschar *name = NULL;
2597 if ((gr = getgrgid(gidlist[i]))) name = US gr->gr_name;
2598 if (sep != '\0') printf("%c", sep);
2599 if (name) printf("%s", name);
2600 else printf("%ld", (long int)(gidlist[i]));
2608 if (!no_labels) printf("%s = ", name);
2609 printf("%s\n", readconf_printtime(*((int *)value)));
2615 int *list = (int *)value;
2616 if (!no_labels) printf("%s = ", name);
2617 for (i = 0; i < list[1]; i++)
2618 printf("%s%s", i == 0 ? "" : ":", readconf_printtime(list[i+2]));
2624 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2628 case opt_expand_bool:
2629 sprintf(CS name2, "*expand_%.50s", name);
2630 if ((ol2 = find_option(name2, oltop, last)) && ol2->value)
2632 void *value2 = ol2->value;
2634 value2 = (void *)(US options_block + (long int)value2);
2638 if (!no_labels) printf("%s = ", name);
2639 printf("%s\n", string_printing(s));
2642 /* s == NULL => string not set; fall through */
2648 case opt_bool_verify:
2650 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2658 /*************************************************
2659 * Print value from main configuration *
2660 *************************************************/
2662 /* This function, called as a result of encountering the -bP option,
2663 causes the value of any main configuration variable to be output if the
2664 second argument is NULL. There are some special values:
2666 all print all main configuration options
2667 config_file print the name of the configuration file
2668 (configure_file will still work, for backward
2670 routers print the routers' configurations
2671 transports print the transports' configuration
2672 authenticators print the authenticators' configuration
2673 macros print the macros' configuration
2674 router_list print a list of router names
2675 transport_list print a list of transport names
2676 authenticator_list print a list of authentication mechanism names
2677 macro_list print a list of macro names
2678 +name print a named list item
2679 local_scan print the local_scan options
2680 config print the configuration as it is parsed
2681 environment print the used execution environment
2683 If the second argument is not NULL, it must be one of "router", "transport",
2684 "authenticator" or "macro" in which case the first argument identifies the
2685 driver whose options are to be printed.
2688 name option name if type == NULL; else driver name
2689 type NULL or driver type name, as described above
2690 no_labels avoid the "foo = " at the start of an item
2692 Returns: Boolean success
2696 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2698 BOOL names_only = FALSE;
2700 optionlist *ol2 = NULL;
2701 driver_instance *d = NULL;
2712 static uschar *types[] = { US"address", US"domain", US"host",
2714 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2715 &hostlist_anchor, &localpartlist_anchor };
2717 for (i = 0; i < 4; i++)
2718 if ((t = tree_search(*(anchors[i]), name+1)))
2722 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2724 printf("%slist %s = %s\n", types[i], name+1,
2725 ((namedlist_block *)(t->data.ptr))->string);
2729 printf("no address, domain, host, or local part list called \"%s\" "
2730 "exists\n", name+1);
2735 if ( Ustrcmp(name, "configure_file") == 0
2736 || Ustrcmp(name, "config_file") == 0)
2738 printf("%s\n", CS config_main_filename);
2742 if (Ustrcmp(name, "all") == 0)
2744 for (ol = optionlist_config;
2745 ol < optionlist_config + nelem(optionlist_config); ol++)
2746 if (!(ol->type & opt_hidden))
2747 (void) print_ol(ol, US ol->name, NULL,
2748 optionlist_config, nelem(optionlist_config),
2753 if (Ustrcmp(name, "local_scan") == 0)
2755 #ifndef LOCAL_SCAN_HAS_OPTIONS
2756 printf("local_scan() options are not supported\n");
2759 for (ol = local_scan_options;
2760 ol < local_scan_options + local_scan_options_count; ol++)
2761 (void) print_ol(ol, US ol->name, NULL, local_scan_options,
2762 local_scan_options_count, no_labels);
2767 if (Ustrcmp(name, "config") == 0)
2769 print_config(admin_user, no_labels);
2773 if (Ustrcmp(name, "routers") == 0)
2778 else if (Ustrcmp(name, "transports") == 0)
2780 type = US"transport";
2783 else if (Ustrcmp(name, "authenticators") == 0)
2785 type = US"authenticator";
2788 else if (Ustrcmp(name, "macros") == 0)
2793 else if (Ustrcmp(name, "router_list") == 0)
2799 else if (Ustrcmp(name, "transport_list") == 0)
2801 type = US"transport";
2805 else if (Ustrcmp(name, "authenticator_list") == 0)
2807 type = US"authenticator";
2811 else if (Ustrcmp(name, "macro_list") == 0)
2817 else if (Ustrcmp(name, "environment") == 0)
2822 for (p = USS environ; *p; p++) ;
2823 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2825 for (p = USS environ; *p; p++)
2828 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2836 return print_ol(find_option(name,
2837 optionlist_config, nelem(optionlist_config)),
2838 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2841 /* Handle the options for a router or transport. Skip options that are flagged
2842 as hidden. Some of these are options with names starting with '*', used for
2843 internal alternative representations of other options (which the printing
2844 function will sort out). Others are synonyms kept for backward compatibility.
2847 if (Ustrcmp(type, "router") == 0)
2849 d = (driver_instance *)routers;
2850 ol2 = optionlist_routers;
2851 size = optionlist_routers_size;
2853 else if (Ustrcmp(type, "transport") == 0)
2855 d = (driver_instance *)transports;
2856 ol2 = optionlist_transports;
2857 size = optionlist_transports_size;
2859 else if (Ustrcmp(type, "authenticator") == 0)
2861 d = (driver_instance *)auths;
2862 ol2 = optionlist_auths;
2863 size = optionlist_auths_size;
2866 else if (Ustrcmp(type, "macro") == 0)
2868 /* People store passwords in macros and they were previously not available
2869 for printing. So we have an admin_users restriction. */
2872 fprintf(stderr, "exim: permission denied\n");
2875 for (m = macros; m; m = m->next)
2876 if (!name || Ustrcmp(name, m->name) == 0)
2879 printf("%s\n", CS m->name);
2881 printf("%s=%s\n", CS m->name, CS m->replacement);
2885 if (!name) return TRUE;
2887 printf("%s %s not found\n", type, name);
2893 for (; d; d = d->next) printf("%s\n", CS d->name);
2897 /* Either search for a given driver, or print all of them */
2899 for (; d; d = d->next)
2903 printf("\n%s %s:\n", d->name, type);
2904 else if (Ustrcmp(d->name, name) != 0) continue;
2906 for (ol = ol2; ol < ol2 + size; ol++)
2907 if (!(ol->type & opt_hidden))
2908 rc |= print_ol(ol, US ol->name, d, ol2, size, no_labels);
2910 for (ol = d->info->options;
2911 ol < d->info->options + *(d->info->options_count); ol++)
2912 if (!(ol->type & opt_hidden))
2913 rc |= print_ol(ol, US ol->name, d, d->info->options,
2914 *d->info->options_count, no_labels);
2916 if (name) return rc;
2918 if (!name) return TRUE;
2920 printf("%s %s not found\n", type, name);
2926 /*************************************************
2927 * Read a named list item *
2928 *************************************************/
2930 /* This function reads a name and a list (i.e. string). The name is used to
2931 save the list in a tree, sorted by its name. Each entry also has a number,
2932 which can be used for caching tests, but if the string contains any expansion
2933 items other than $key, the number is set negative to inhibit caching. This
2934 mechanism is used for domain, host, and address lists that are referenced by
2938 anchorp points to the tree anchor
2939 numberp points to the current number for this tree
2940 max the maximum number permitted
2941 s the text of the option line, starting immediately after the name
2943 tname the name of the list type, for messages
2949 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2952 BOOL forcecache = FALSE;
2955 namedlist_block *nb = store_get(sizeof(namedlist_block));
2957 if (Ustrncmp(s, "_cache", 6) == 0)
2964 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2966 if (*numberp >= max)
2967 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2970 while (isspace(*s)) s++;
2972 while (isalnum(*s) || *s == '_') s++;
2973 t = store_get(sizeof(tree_node) + s-ss);
2974 Ustrncpy(t->name, ss, s-ss);
2976 while (isspace(*s)) s++;
2978 if (!tree_insertnode(anchorp, t))
2979 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2980 "duplicate name \"%s\" for a named %s", t->name, tname);
2983 nb->number = *numberp;
2986 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2987 "missing '=' after \"%s\"", t->name);
2988 while (isspace(*s)) s++;
2989 nb->string = read_string(s, t->name);
2990 nb->cache_data = NULL;
2992 /* Check the string for any expansions; if any are found, mark this list
2993 uncacheable unless the user has explicited forced caching. */
2995 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3001 /*************************************************
3002 * Unpick data for a rate limit *
3003 *************************************************/
3005 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3009 s string, in the form t,b,f,l
3010 where t is the threshold (integer)
3011 b is the initial delay (time)
3012 f is the multiplicative factor (fixed point)
3013 k is the maximum time (time)
3014 threshold where to store threshold
3015 base where to store base in milliseconds
3016 factor where to store factor in milliseconds
3017 limit where to store limit
3019 Returns: nothing (panics on error)
3023 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3026 uschar bstring[16], lstring[16];
3028 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3029 factor, lstring) == 4)
3031 *base = readconf_readtime(bstring, 0, TRUE);
3032 *limit = readconf_readtime(lstring, 0, TRUE);
3033 if (*base >= 0 && *limit >= 0) return;
3035 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3041 /*************************************************
3042 * Drop privs for checking TLS config *
3043 *************************************************/
3045 /* We want to validate TLS options during readconf, but do not want to be
3046 root when we call into the TLS library, in case of library linkage errors
3047 which cause segfaults; before this check, those were always done as the Exim
3048 runtime user and it makes sense to continue with that.
3050 Assumes: tls_require_ciphers has been set, if it will be
3051 exim_user has been set, if it will be
3052 exim_group has been set, if it will be
3054 Returns: bool for "okay"; false will cause caller to immediately exit.
3059 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3061 const uschar *errmsg;
3064 void (*oldsignal)(int);
3066 /* If TLS will never be used, no point checking ciphers */
3068 if ( !tls_advertise_hosts
3069 || !*tls_advertise_hosts
3070 || Ustrcmp(tls_advertise_hosts, ":") == 0
3073 else if (!nowarn && !tls_certificate)
3074 log_write(0, LOG_MAIN,
3075 "Warning: No server certificate defined; will use a selfsigned one.\n"
3076 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3078 oldsignal = signal(SIGCHLD, SIG_DFL);
3081 if ((pid = fork()) < 0)
3082 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3086 /* in some modes, will have dropped privilege already */
3088 exim_setugid(exim_uid, exim_gid, FALSE,
3089 US"calling tls_validate_require_cipher");
3091 if ((errmsg = tls_validate_require_cipher()))
3092 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3093 "tls_require_ciphers invalid: %s", errmsg);
3099 rc = waitpid(pid, &status, 0);
3100 } while (rc < 0 && errno == EINTR);
3103 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3106 signal(SIGCHLD, oldsignal);
3110 #endif /* SUPPORT_TLS */
3115 /*************************************************
3116 * Read main configuration options *
3117 *************************************************/
3119 /* This function is the first to be called for configuration reading. It
3120 opens the configuration file and reads general configuration settings until
3121 it reaches the end of the configuration section. The file is then left open so
3122 that the remaining configuration data can subsequently be read if needed for
3125 The configuration file must be owned either by root or exim, and be writeable
3126 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3127 in the config file, so the test is done on the compiled in values. A slight
3128 anomaly, to be carefully documented.
3130 The name of the configuration file is taken from a list that is included in the
3131 binary of Exim. It can be altered from the command line, but if that is done,
3132 root privilege is immediately withdrawn unless the caller is root or exim.
3133 The first file on the list that exists is used.
3135 For use on multiple systems that share file systems, first look for a
3136 configuration file whose name has the current node name on the end. If that is
3137 not found, try the generic name. For really contorted configurations, that run
3138 multiple Exims with different uid settings, first try adding the effective uid
3139 before the node name. These complications are going to waste resources on most
3140 systems. Therefore they are available only when requested by compile-time
3144 readconf_main(BOOL nowarn)
3147 struct stat statbuf;
3148 uschar *s, *filename;
3149 const uschar *list = config_main_filelist;
3151 /* Loop through the possible file names */
3153 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3156 /* Cut out all the fancy processing unless specifically wanted */
3158 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3159 uschar *suffix = filename + Ustrlen(filename);
3161 /* Try for the node-specific file if a node name exists */
3163 #ifdef CONFIGURE_FILE_USE_NODE
3165 if (uname(&uts) >= 0)
3167 #ifdef CONFIGURE_FILE_USE_EUID
3168 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3169 config_file = Ufopen(filename, "rb");
3170 if (config_file == NULL)
3171 #endif /* CONFIGURE_FILE_USE_EUID */
3173 sprintf(CS suffix, ".%.256s", uts.nodename);
3174 config_file = Ufopen(filename, "rb");
3177 #endif /* CONFIGURE_FILE_USE_NODE */
3179 /* Otherwise, try the generic name, possibly with the euid added */
3181 #ifdef CONFIGURE_FILE_USE_EUID
3182 if (config_file == NULL)
3184 sprintf(CS suffix, ".%ld", (long int)original_euid);
3185 config_file = Ufopen(filename, "rb");
3187 #endif /* CONFIGURE_FILE_USE_EUID */
3189 /* Finally, try the unadorned name */
3191 if (config_file == NULL)
3194 config_file = Ufopen(filename, "rb");
3196 #else /* if neither defined */
3198 /* This is the common case when the fancy processing is not included. */
3200 config_file = Ufopen(filename, "rb");
3203 /* If the file does not exist, continue to try any others. For any other
3204 error, break out (and die). */
3206 if (config_file != NULL || errno != ENOENT) break;
3209 /* On success, save the name for verification; config_filename is used when
3210 logging configuration errors (it changes for .included files) whereas
3211 config_main_filename is the name shown by -bP. Failure to open a configuration
3212 file is a serious disaster. */
3216 uschar *last_slash = Ustrrchr(filename, '/');
3217 config_filename = config_main_filename = string_copy(filename);
3219 /* The config_main_directory we need for the $config_dir expansion.
3220 config_main_filename we need for $config_file expansion.
3221 And config_dir is the directory of the current configuration, used for
3222 relative .includes. We do need to know it's name, as we change our working
3225 if (filename[0] == '/')
3226 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3229 /* relative configuration file name: working dir + / + basename(filename) */
3231 uschar buf[PATH_MAX];
3234 if (os_getcwd(buf, PATH_MAX) == NULL)
3236 perror("exim: getcwd");
3239 g = string_cat(NULL, buf);
3241 /* If the dir does not end with a "/", append one */
3242 if (g->s[g->ptr-1] != '/')
3243 g = string_catn(g, US"/", 1);
3245 /* If the config file contains a "/", extract the directory part */
3247 g = string_catn(g, filename, last_slash - filename);
3249 config_main_directory = string_from_gstring(g);
3251 config_directory = config_main_directory;
3255 if (filename == NULL)
3256 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3257 "%s", config_main_filelist);
3259 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3260 "configuration file %s", filename));
3263 /* Now, once we found and opened our configuration file, we change the directory
3264 to a safe place. Later we change to $spool_directory. */
3266 if (Uchdir("/") < 0)
3268 perror("exim: chdir `/': ");
3272 /* Check the status of the file we have opened, if we have retained root
3273 privileges and the file isn't /dev/null (which *should* be 0666). */
3275 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3277 if (fstat(fileno(config_file), &statbuf) != 0)
3278 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3281 if ((statbuf.st_uid != root_uid /* owner not root */
3282 #ifdef CONFIGURE_OWNER
3283 && statbuf.st_uid != config_uid /* owner not the special one */
3286 (statbuf.st_gid != root_gid /* group not root & */
3287 #ifdef CONFIGURE_GROUP
3288 && statbuf.st_gid != config_gid /* group not the special one */
3290 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3292 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3294 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3295 "wrong owner, group, or mode", big_buffer);
3298 /* Process the main configuration settings. They all begin with a lower case
3299 letter. If we see something starting with an upper case letter, it is taken as
3300 a macro definition. */
3302 while ((s = get_config_line()))
3304 if (config_lineno == 1 && Ustrstr(s, "\xef\xbb\xbf") == s)
3305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3306 "found unexpected BOM (Byte Order Mark)");
3309 { if (!macro_read_assignment(s)) exim_exit(EXIT_FAILURE, US""); }
3311 else if (Ustrncmp(s, "domainlist", 10) == 0)
3312 read_named_list(&domainlist_anchor, &domainlist_count,
3313 MAX_NAMED_LIST, s+10, US"domain list");
3315 else if (Ustrncmp(s, "hostlist", 8) == 0)
3316 read_named_list(&hostlist_anchor, &hostlist_count,
3317 MAX_NAMED_LIST, s+8, US"host list");
3319 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3320 read_named_list(&addresslist_anchor, &addresslist_count,
3321 MAX_NAMED_LIST, s+11, US"address list");
3323 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3324 read_named_list(&localpartlist_anchor, &localpartlist_count,
3325 MAX_NAMED_LIST, s+13, US"local part list");
3328 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3329 NULL, US"main option \"%s\" unknown");
3333 /* If local_sender_retain is set, local_from_check must be unset. */
3335 if (local_sender_retain && local_from_check)
3336 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3337 "local_sender_retain are set; this combination is not allowed");
3339 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3342 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3344 /* The max retry interval must not be greater than 24 hours. */
3346 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3348 /* remote_max_parallel must be > 0 */
3350 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3352 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3353 start of a new SMTP message. */
3355 freeze_tell_config = freeze_tell;
3357 /* The primary host name may be required for expansion of spool_directory
3358 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3359 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3360 canonize it. Some people like upper case letters in their host names, so we
3361 don't force the case. */
3363 if (primary_hostname == NULL)
3365 const uschar *hostname;
3367 if (uname(&uts) < 0)
3368 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3369 hostname = US uts.nodename;
3371 if (Ustrchr(hostname, '.') == NULL)
3374 struct hostent *hostdata;
3377 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3378 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3379 MCL_DOMAIN, TRUE, NULL) != OK))
3388 #if HAVE_GETIPNODEBYNAME
3390 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3392 hostdata = gethostbyname2(CS hostname, af);
3395 hostdata = gethostbyname(CS hostname);
3398 if (hostdata != NULL)
3400 hostname = US hostdata->h_name;
3404 if (af == AF_INET) break;
3409 primary_hostname = string_copy(hostname);
3412 /* Set up default value for smtp_active_hostname */
3414 smtp_active_hostname = primary_hostname;
3416 /* If spool_directory wasn't set in the build-time configuration, it must have
3417 got set above. Of course, writing to the log may not work if log_file_path is
3418 not set, but it will at least get to syslog or somewhere, with any luck. */
3420 if (*spool_directory == 0)
3421 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3424 /* Expand the spool directory name; it may, for example, contain the primary
3425 host name. Same comment about failure. */
3427 s = expand_string(spool_directory);
3429 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3430 "\"%s\": %s", spool_directory, expand_string_message);
3431 spool_directory = s;
3433 /* Expand log_file_path, which must contain "%s" in any component that isn't
3434 the null string or "syslog". It is also allowed to contain one instance of %D
3435 or %M. However, it must NOT contain % followed by anything else. */
3437 if (*log_file_path != 0)
3439 const uschar *ss, *sss;
3440 int sep = ':'; /* Fixed for log file path */
3441 s = expand_string(log_file_path);
3443 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3444 "\"%s\": %s", log_file_path, expand_string_message);
3447 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3450 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3451 t = Ustrstr(sss, "%s");
3453 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3454 "contain \"%%s\"", sss);
3456 t = Ustrchr(sss, '%');
3459 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3460 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3461 "unexpected \"%%\" character", s);
3468 /* Interpret syslog_facility into an integer argument for 'ident' param to
3469 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3472 if (syslog_facility_str)
3475 uschar *s = syslog_facility_str;
3477 if ((Ustrlen(syslog_facility_str) >= 4) &&
3478 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3481 for (i = 0; i < syslog_list_size; i++)
3482 if (strcmpic(s, syslog_list[i].name) == 0)
3484 syslog_facility = syslog_list[i].value;
3488 if (i >= syslog_list_size)
3489 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3490 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3493 /* Expand pid_file_path */
3495 if (*pid_file_path != 0)
3497 if (!(s = expand_string(pid_file_path)))
3498 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3499 "\"%s\": %s", pid_file_path, expand_string_message);
3503 /* Set default value of process_log_path */
3505 if (!process_log_path || *process_log_path =='\0')
3506 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3508 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3511 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3513 /* Unpick the SMTP rate limiting options, if set */
3515 if (smtp_ratelimit_mail)
3516 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3517 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3519 if (smtp_ratelimit_rcpt)
3520 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3521 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3523 /* The qualify domains default to the primary host name */
3525 if (!qualify_domain_sender)
3526 qualify_domain_sender = primary_hostname;
3527 if (!qualify_domain_recipient)
3528 qualify_domain_recipient = qualify_domain_sender;
3530 /* Setting system_filter_user in the configuration sets the gid as well if a
3531 name is given, but a numerical value does not. */
3533 if (system_filter_uid_set && !system_filter_gid_set)
3535 struct passwd *pw = getpwuid(system_filter_uid);
3537 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3538 (long int)system_filter_uid);
3539 system_filter_gid = pw->pw_gid;
3540 system_filter_gid_set = TRUE;
3543 /* If the errors_reply_to field is set, check that it is syntactically valid
3544 and ensure it contains a domain. */
3546 if (errors_reply_to)
3549 int start, end, domain;
3550 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3551 &start, &end, &domain, FALSE);
3554 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3555 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3558 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3559 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3562 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3563 smtp_accept_max must also be set. */
3565 if (smtp_accept_max == 0 &&
3566 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3567 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3568 "smtp_accept_max must be set if smtp_accept_queue or "
3569 "smtp_accept_max_per_host is set");
3571 /* Set up the host number if anything is specified. It is an expanded string
3572 so that it can be computed from the host name, for example. We do this last
3573 so as to ensure that everything else is set up before the expansion. */
3575 if (host_number_string)
3579 uschar *s = expand_string(host_number_string);
3582 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3583 "failed to expand localhost_number \"%s\": %s",
3584 host_number_string, expand_string_message);
3585 n = Ustrtol(s, &end, 0);
3586 while (isspace(*end)) end++;
3588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3589 "localhost_number value is not a number: %s", s);
3590 if (n > LOCALHOST_MAX)
3591 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3592 "localhost_number is greater than the maximum allowed value (%d)",
3598 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3600 if ((tls_verify_hosts || tls_try_verify_hosts) && !tls_verify_certificates)
3601 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3602 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3603 tls_verify_hosts ? "" : "try_");
3605 /* This also checks that the library linkage is working and we can call
3606 routines in it, so call even if tls_require_ciphers is unset */
3607 if (!tls_dropprivs_validate_require_cipher(nowarn))
3610 /* Magic number: at time of writing, 1024 has been the long-standing value
3611 used by so many clients, and what Exim used to use always, that it makes
3612 sense to just min-clamp this max-clamp at that. */
3613 if (tls_dh_max_bits < 1024)
3614 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3615 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3617 /* If openssl_options is set, validate it */
3618 if (openssl_options)
3621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3622 "openssl_options is set but we're using GnuTLS");
3625 if (!tls_openssl_options_parse(openssl_options, &dummy))
3626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3627 "openssl_options parse error: %s", openssl_options);
3630 #endif /*SUPPORT_TLS*/
3632 if (!nowarn && !keep_environment && environ && *environ)
3633 log_write(0, LOG_MAIN,
3634 "Warning: purging the environment.\n"
3635 " Suggested action: use keep_environment.");
3640 /*************************************************
3641 * Initialize one driver *
3642 *************************************************/
3644 /* This is called once the driver's generic options, if any, have been read.
3645 We can now find the driver, set up defaults for the private options, and
3646 unset any "set" bits in the private options table (which might have been
3647 set by another incarnation of the same driver).
3650 d pointer to driver instance block, with generic
3652 drivers_available vector of available drivers
3653 size_of_info size of each block in drivers_available
3654 class class of driver, for error message
3656 Returns: pointer to the driver info block
3659 static driver_info *
3660 init_driver(driver_instance *d, driver_info *drivers_available,
3661 int size_of_info, uschar *class)
3665 for (dd = drivers_available; dd->driver_name[0] != 0;
3666 dd = (driver_info *)((US dd) + size_of_info))
3668 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3671 int len = dd->options_len;
3673 d->options_block = store_get(len);
3674 memcpy(d->options_block, dd->options_block, len);
3675 for (i = 0; i < *(dd->options_count); i++)
3676 dd->options[i].type &= ~opt_set;
3681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3682 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3684 return NULL; /* never obeyed */
3690 /*************************************************
3691 * Initialize driver list *
3692 *************************************************/
3694 /* This function is called for routers, transports, and authentication
3695 mechanisms. It reads the data from the current point in the configuration file
3696 up to the end of the section, and sets up a chain of instance blocks according
3697 to the file's contents. The file will already have been opened by a call to
3698 readconf_main, and must be left open for subsequent reading of further data.
3700 Any errors cause a panic crash. Note that the blocks with names driver_info and
3701 driver_instance must map the first portions of all the _info and _instance
3702 blocks for this shared code to work.
3705 class "router", "transport", or "authenticator"
3706 anchor &routers, &transports, &auths
3707 drivers_available available drivers
3708 size_of_info size of each info block
3709 instance_default points to default data for an instance
3710 instance_size size of instance block
3711 driver_optionlist generic option list
3712 driver_optionlist_count count of generic option list
3718 readconf_driver_init(
3720 driver_instance **anchor,
3721 driver_info *drivers_available,
3723 void *instance_default,
3725 optionlist *driver_optionlist,
3726 int driver_optionlist_count)
3728 driver_instance **p = anchor;
3729 driver_instance *d = NULL;
3732 while ((buffer = get_config_line()) != NULL)
3737 /* Read the first name on the line and test for the start of a new driver. A
3738 macro definition indicates the end of the previous driver. If this isn't the
3739 start of a new driver, the line will be re-read. */
3741 s = readconf_readname(name, sizeof(name), buffer);
3743 /* Handle macro definition, first finishing off the initialization of the
3744 previous driver, if any. */
3746 if (isupper(*name) && *s == '=')
3750 if (!d->driver_name)
3751 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3752 "no driver defined for %s \"%s\"", class, d->name);
3756 if (!macro_read_assignment(buffer)) exim_exit(EXIT_FAILURE, US"");
3760 /* If the line starts with a name terminated by a colon, we are at the
3761 start of the definition of a new driver. The rest of the line must be
3768 /* Finish off initializing the previous driver. */
3772 if (!d->driver_name)
3773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3774 "no driver defined for %s \"%s\"", class, d->name);
3778 /* Check that we haven't already got a driver of this name */
3780 for (d = *anchor; d; d = d->next)
3781 if (Ustrcmp(name, d->name) == 0)
3782 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3783 "there are two %ss called \"%s\"", class, name);
3785 /* Set up a new driver instance data block on the chain, with
3786 its default values installed. */
3788 d = store_get(instance_size);
3789 memcpy(d, instance_default, instance_size);
3792 d->name = string_copy(name);
3794 /* Clear out the "set" bits in the generic options */
3796 for (i = 0; i < driver_optionlist_count; i++)
3797 driver_optionlist[i].type &= ~opt_set;
3799 /* Check nothing more on this line, then do the next loop iteration. */
3801 while (isspace(*s)) s++;
3802 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3806 /* Not the start of a new driver. Give an error if we have not set up a
3807 current driver yet. */
3810 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3812 /* First look to see if this is a generic option; if it is "driver",
3813 initialize the driver. If is it not a generic option, we can look for a
3814 private option provided that the driver has been previously set up. */
3816 if (readconf_handle_option(buffer, driver_optionlist,
3817 driver_optionlist_count, d, NULL))
3819 if (!d->info && d->driver_name)
3820 init_driver(d, drivers_available, size_of_info, class);
3823 /* Handle private options - pass the generic block because some may
3824 live therein. A flag with each option indicates if it is in the public
3828 readconf_handle_option(buffer, d->info->options,
3829 *(d->info->options_count), d, US"option \"%s\" unknown");
3831 /* The option is not generic and the driver name has not yet been given. */
3833 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3834 "(\"driver\" must be specified before any private options)", name);
3837 /* Run the initialization function for the final driver. */
3841 if (!d->driver_name)
3842 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3843 "no driver defined for %s \"%s\"", class, d->name);
3850 /*************************************************
3851 * Check driver dependency *
3852 *************************************************/
3854 /* This function is passed a driver instance and a string. It checks whether
3855 any of the string options for the driver contains the given string as an
3859 d points to a driver instance block
3860 s the string to search for
3862 Returns: TRUE if a dependency is found
3866 readconf_depends(driver_instance *d, uschar *s)
3868 int count = *(d->info->options_count);
3872 for (ol = d->info->options; ol < d->info->options + count; ol++)
3874 void *options_block;
3876 int type = ol->type & opt_mask;
3877 if (type != opt_stringptr) continue;
3878 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3879 value = *(uschar **)(US options_block + (long int)(ol->value));
3880 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3882 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3883 isalnum(ss[Ustrlen(s)])) continue;
3884 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3885 d->name, ol->name, s);
3890 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3897 /*************************************************
3898 * Decode an error type for retries *
3899 *************************************************/
3901 /* This function is global because it is also called from the main
3902 program when testing retry information. It decodes strings such as "quota_7d"
3903 into numerical error codes.
3906 pp points to start of text
3907 p points past end of text
3908 basic_errno points to an int to receive the main error number
3909 more_errno points to an int to receive the secondary error data
3911 Returns: NULL if decoded correctly; else points to error text
3915 readconf_retry_error(const uschar *pp, const uschar *p,
3916 int *basic_errno, int *more_errno)
3919 const uschar *q = pp;
3920 while (q < p && *q != '_') q++;
3923 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3925 *basic_errno = ERRNO_EXIMQUOTA;
3926 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3927 return US"bad time value";
3930 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3932 *basic_errno = ECONNREFUSED;
3935 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3936 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3937 else return US"A or MX expected after \"refused\"";
3941 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3943 *basic_errno = ETIMEDOUT;
3947 int xlen = p - q - 1;
3948 const uschar *x = q + 1;
3950 static uschar *extras[] =
3951 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3952 static int values[] =
3953 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3955 for (i = 0; i < nelem(extras); i++)
3956 if (strncmpic(x, extras[i], xlen) == 0)
3958 *more_errno = values[i];
3962 if (i >= nelem(extras))
3963 if (strncmpic(x, US"DNS", xlen) == 0)
3964 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3965 "available in retry rules (it has never worked) - treated as "
3968 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3972 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3973 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3974 strncmpic(pp, US"data_4", 6) == 0)
3977 int x = 255; /* means "any 4xx code" */
3978 if (p != pp + 8) bad = TRUE; else
3980 int a = pp[6], b = pp[7];
3984 if (isdigit(b)) x += b - '0';
3985 else if (b == 'x') x += 100;
3988 else if (a != 'x' || b != 'x') bad = TRUE;
3992 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3993 "x is literal and d is any digit", pp);
3995 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3996 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3997 *more_errno = x << 8;
4000 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4001 strncmpic(q+1, US"failed", p-q-1) == 0)
4002 *basic_errno = ERRNO_AUTHFAIL;
4004 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4005 *basic_errno = ERRNO_SMTPCLOSED;
4007 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4008 *basic_errno = ERRNO_TLSREQUIRED;
4010 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4011 *basic_errno = ERRNO_UNKNOWNHOST;
4013 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4014 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4022 /*************************************************
4023 * Read retry information *
4024 *************************************************/
4026 /* Each line of retry information contains:
4028 . A domain name pattern or an address pattern;
4030 . An error name, possibly with additional data, or *;
4032 . An optional sequence of retry items, each consisting of an identifying
4033 letter, a cutoff time, and optional parameters.
4035 All this is decoded and placed into a control block. */
4038 /* Subroutine to read an argument, preceded by a comma and terminated
4039 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4040 1 = fixed point number (returned *1000).
4043 paddr pointer to pointer to current character; updated
4044 type 0 => read a time; 1 => read a fixed point number
4046 Returns: time in seconds or fixed point number * 1000
4050 retry_arg(const uschar **paddr, int type)
4052 const uschar *p = *paddr;
4055 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4057 while (isspace(*p)) p++;
4059 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4061 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4062 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4067 case 0: return readconf_readtime(pp, *p, FALSE);
4068 case 1: return readconf_readfixed(pp, *p);
4070 return 0; /* Keep picky compilers happy */
4073 /* The function proper */
4076 readconf_retries(void)
4078 retry_config **chain = &retries;
4082 while ((p = get_config_line()))
4084 retry_rule **rchain;
4088 next = store_get(sizeof(retry_config));
4091 chain = &(next->next);
4092 next->basic_errno = next->more_errno = 0;
4093 next->senders = NULL;
4095 rchain = &(next->rules);
4097 next->pattern = string_dequote(&p);
4098 while (isspace(*p)) p++;
4100 while (mac_isgraph(*p)) p++;
4101 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4102 "missing error type in retry rule");
4104 /* Test error names for things we understand. */
4106 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4107 &next->more_errno)))
4108 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4110 /* There may be an optional address list of senders to be used as another
4111 constraint on the rule. This was added later, so the syntax is a bit of a
4112 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4115 while (isspace(*p)) p++;
4116 if (Ustrncmp(p, "senders", 7) == 0)
4119 while (isspace(*p)) p++;
4120 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4121 "\"=\" expected after \"senders\" in retry rule");
4122 while (isspace(*p)) p++;
4123 next->senders = string_dequote(&p);
4126 /* Now the retry rules. Keep the maximum timeout encountered. */
4128 while (isspace(*p)) p++;
4132 retry_rule *rule = store_get(sizeof(retry_rule));
4134 rchain = &(rule->next);
4136 rule->rule = toupper(*p++);
4137 rule->timeout = retry_arg(&p, 0);
4138 if (rule->timeout > retry_maximum_timeout)
4139 retry_maximum_timeout = rule->timeout;
4143 case 'F': /* Fixed interval */
4144 rule->p1 = retry_arg(&p, 0);
4147 case 'G': /* Geometrically increasing intervals */
4148 case 'H': /* Ditto, but with randomness */
4149 rule->p1 = retry_arg(&p, 0);
4150 rule->p2 = retry_arg(&p, 1);
4154 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4158 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4159 (rule->rule != 'F' && rule->p2 < 1000))
4160 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4161 "bad parameters for retry rule");
4163 while (isspace(*p)) p++;
4167 while (isspace(*p)) p++;
4170 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4177 /*************************************************
4178 * Initialize authenticators *
4179 *************************************************/
4181 /* Read the authenticators section of the configuration file.
4190 auth_instance *au, *bu;
4192 readconf_driver_init(US"authenticator",
4193 (driver_instance **)(&auths), /* chain anchor */
4194 (driver_info *)auths_available, /* available drivers */
4195 sizeof(auth_info), /* size of info block */
4196 &auth_defaults, /* default values for generic options */
4197 sizeof(auth_instance), /* size of instance block */
4198 optionlist_auths, /* generic options */
4199 optionlist_auths_size);
4201 for (au = auths; au; au = au->next)
4203 if (!au->public_name)
4204 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4205 "the %s authenticator", au->name);
4207 for (bu = au->next; bu; bu = bu->next)
4208 if (strcmpic(au->public_name, bu->public_name) == 0)
4209 if ((au->client && bu->client) || (au->server && bu->server))
4210 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4211 "(%s and %s) have the same public name (%s)",
4212 au->client ? US"client" : US"server", au->name, bu->name,
4220 /*************************************************
4221 * Read ACL information *
4222 *************************************************/
4224 /* If this run of Exim is not doing something that involves receiving a
4225 message, we can just skip over the ACL information. No need to parse it.
4227 First, we have a function for acl_read() to call back to get the next line. We
4228 need to remember the line we passed, because at the end it will contain the
4229 name of the next ACL. */
4231 static uschar *acl_line;
4236 acl_line = get_config_line();
4241 /* Now the main function:
4252 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4255 acl_line = get_config_line();
4263 p = readconf_readname(name, sizeof(name), acl_line);
4264 if (isupper(*name) && *p == '=')
4266 if (!macro_read_assignment(acl_line)) exim_exit(EXIT_FAILURE, US"");
4267 acl_line = get_config_line();
4271 if (*p != ':' || name[0] == 0)
4272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4274 node = store_get(sizeof(tree_node) + Ustrlen(name));
4275 Ustrcpy(node->name, name);
4276 if (!tree_insertnode(&acl_anchor, node))
4277 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4278 "there are two ACLs called \"%s\"", name);
4280 node->data.ptr = acl_read(acl_callback, &error);
4282 if (node->data.ptr == NULL && error != NULL)
4283 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4289 /*************************************************
4290 * Read configuration for local_scan() *
4291 *************************************************/
4293 /* This function is called after "begin local_scan" is encountered in the
4294 configuration file. If the local_scan() function allows for configuration
4295 options, we can process them. Otherwise, we expire in a panic.
4302 local_scan_init(void)
4304 #ifndef LOCAL_SCAN_HAS_OPTIONS
4305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4306 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4310 while ((p = get_config_line()))
4312 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4313 NULL, US"local_scan option \"%s\" unknown");
4320 /*************************************************
4321 * Read rest of configuration (after main) *
4322 *************************************************/
4324 /* This function reads the rest of the runtime configuration, after the main
4325 configuration. It is called only when actually needed. Each subsequent section
4326 of the configuration starts with a line of the form
4330 where the name is "routers", "transports", etc. A section is terminated by
4331 hitting the next "begin" line, and the next name is left in next_section.
4332 Because it may confuse people as to whether the names are singular or plural,
4333 we add "s" if it's missing. There is always enough room in next_section for
4334 this. This function is basically just a switch.
4340 static uschar *section_list[] = {
4354 while(next_section[0] != 0)
4358 int last = nelem(section_list);
4360 int n = Ustrlen(next_section);
4362 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4366 int c = strcmpic(next_section, section_list[mid]);
4368 if (c > 0) first = mid + 1; else last = mid;
4370 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4371 "\"%.*s\" is not a known configuration section name", n, next_section);
4372 mid = (last + first)/2;
4376 if (((had ^= bit) & bit) == 0)
4377 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4378 "\"%.*s\" section is repeated in the configuration file", n,
4383 case 0: readconf_acl(); break;
4384 case 1: auths_init(); break;
4385 case 2: local_scan_init(); break;
4386 case 3: readconf_retries(); break;
4387 case 4: readconf_rewrites(); break;
4388 case 5: route_init(); break;
4389 case 6: transport_init(); break;
4393 (void)fclose(config_file);
4396 /* Init the storage for the pre-parsed config lines */
4398 readconf_save_config(const uschar *s)
4400 save_config_line(string_sprintf("# Exim Configuration (%s)",
4401 running_in_test_harness ? US"X" : s));
4405 save_config_position(const uschar *file, int line)
4407 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4410 /* Append a pre-parsed logical line to the config lines store,
4411 this operates on a global (static) list that holds all the pre-parsed
4412 config lines, we do no further processing here, output formatting and
4413 honouring of <hide> or macros will be done during output */
4416 save_config_line(const uschar* line)
4418 static config_line_item *current;
4419 config_line_item *next;
4421 next = (config_line_item*) store_get(sizeof(config_line_item));
4422 next->line = string_copy(line);
4425 if (!config_lines) config_lines = next;
4426 else current->next = next;
4431 /* List the parsed config lines, care about nice formatting and
4432 hide the <hide> values unless we're the admin user */
4434 print_config(BOOL admin, BOOL terse)
4436 config_line_item *i;
4437 const int TS = terse ? 0 : 2;
4440 for (i = config_lines; i; i = i->next)
4445 /* skip over to the first non-space */
4446 for (current = i->line; *current && isspace(*current); ++current)
4449 if (*current == '\0')
4452 /* Collapse runs of spaces. We stop this if we encounter one of the
4453 * following characters: "'$, as this may indicate careful formatting */
4454 for (p = current; *p; ++p)
4457 if (!isspace(*p)) continue;
4458 if (*p != ' ') *p = ' ';
4460 for (next = p; isspace(*next); ++next)
4464 memmove(p+1, next, Ustrlen(next)+1);
4466 if (*next == '"' || *next == '\'' || *next == '$')
4471 if (current[0] == '#')
4474 /* begin lines are left aligned */
4475 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4477 if (!terse) puts("");
4482 /* router/acl/transport block names */
4483 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4485 if (!terse) puts("");
4486 printf("%*s%s\n", TS, "", current);
4490 /* hidden lines (all MACROS or lines prefixed with "hide") */
4492 && ( isupper(*current)
4493 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4497 if ((p = Ustrchr(current, '=')))
4500 printf("%*s%s= %s\n", indent, "", current, hidden);
4502 /* e.g.: hide split_spool_directory */
4504 printf("%*s\n", indent, hidden);
4508 /* rest is public */
4509 printf("%*s%s\n", indent, "", current);
4513 #endif /*!MACRO_PREDEF*/
4516 /* End of readconf.c */