1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
14 extern char **environ;
16 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str);
17 static void save_config_line(const uschar* line);
18 static void save_config_position(const uschar *file, int line);
19 static void print_config(BOOL admin, BOOL terse);
22 #define CSTATE_STACK_SIZE 10
25 /* Structure for chain (stack) of .included files */
27 typedef struct config_file_item {
28 struct config_file_item *next;
34 /* Structure for chain of configuration lines (-bP config) */
36 typedef struct config_line_item {
37 struct config_line_item *next;
41 static config_line_item* config_lines;
43 /* Structure of table of conditional words and their state transitions */
45 typedef struct cond_item {
53 /* Structure of table of syslog facility names and values */
55 typedef struct syslog_fac_item {
61 static const char * const hidden = "<value not displayable>";
63 /* Static variables */
65 static config_file_item *config_file_stack = NULL; /* For includes */
67 static uschar *syslog_facility_str = NULL;
68 static uschar next_section[24];
69 static uschar time_buffer[24];
71 /* State variables for conditional loading (.ifdef / .else / .endif) */
73 static int cstate = 0;
74 static int cstate_stack_ptr = -1;
75 static int cstate_stack[CSTATE_STACK_SIZE];
77 /* Table of state transitions for handling conditional inclusions. There are
78 four possible state transitions:
82 .elifdef true (or .else)
85 .endif just causes the previous cstate to be popped off the stack */
87 static int next_cstate[3][4] =
89 /* State 0: reading from file, or reading until next .else or .endif */
91 /* State 1: condition failed, skipping until next .else or .endif */
93 /* State 2: skipping until .endif */
97 /* Table of conditionals and the states to set. For each name, there are four
98 values: the length of the name (to save computing it each time), the state to
99 set if a macro was found in the line, the state to set if a macro was not found
100 in the line, and a stack manipulation setting which is:
102 -1 pull state value off the stack
103 0 don't alter the stack
104 +1 push value onto stack, before setting new state
107 static cond_item cond_list[] = {
108 { US"ifdef", 5, 0, 1, 1 },
109 { US"ifndef", 6, 1, 0, 1 },
110 { US"elifdef", 7, 2, 3, 0 },
111 { US"elifndef", 8, 3, 2, 0 },
112 { US"else", 4, 2, 2, 0 },
113 { US"endif", 5, 0, 0, -1 }
116 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
118 /* Table of syslog facility names and their values */
120 static syslog_fac_item syslog_list[] = {
121 { US"mail", LOG_MAIL },
122 { US"user", LOG_USER },
123 { US"news", LOG_NEWS },
124 { US"uucp", LOG_UUCP },
125 { US"local0", LOG_LOCAL0 },
126 { US"local1", LOG_LOCAL1 },
127 { US"local2", LOG_LOCAL2 },
128 { US"local3", LOG_LOCAL3 },
129 { US"local4", LOG_LOCAL4 },
130 { US"local5", LOG_LOCAL5 },
131 { US"local6", LOG_LOCAL6 },
132 { US"local7", LOG_LOCAL7 },
133 { US"daemon", LOG_DAEMON }
136 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
141 /*************************************************
142 * Main configuration options *
143 *************************************************/
145 /* The list of options that can be set in the main configuration file. This
146 must be in alphabetic order because it is searched by binary chop. */
148 static optionlist optionlist_config[] = {
149 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
150 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
151 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
152 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
153 { "accept_8bitmime", opt_bool, &accept_8bitmime },
154 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
155 #ifdef WITH_CONTENT_SCAN
156 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
158 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
159 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
160 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
161 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
163 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
166 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
168 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
169 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
170 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
171 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
172 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
173 #ifdef WITH_CONTENT_SCAN
174 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
176 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
177 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
178 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
179 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
181 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
183 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
184 { "add_environment", opt_stringptr, &add_environment },
185 { "admin_groups", opt_gidlist, &admin_groups },
186 { "allow_domain_literals", opt_bool, &allow_domain_literals },
187 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
188 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
189 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
190 { "auto_thaw", opt_time, &auto_thaw },
191 #ifdef WITH_CONTENT_SCAN
192 { "av_scanner", opt_stringptr, &av_scanner },
194 { "bi_command", opt_stringptr, &bi_command },
195 #ifdef EXPERIMENTAL_BRIGHTMAIL
196 { "bmi_config_file", opt_stringptr, &bmi_config_file },
198 { "bounce_message_file", opt_stringptr, &bounce_message_file },
199 { "bounce_message_text", opt_stringptr, &bounce_message_text },
200 { "bounce_return_body", opt_bool, &bounce_return_body },
201 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
202 { "bounce_return_message", opt_bool, &bounce_return_message },
203 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
204 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
205 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
206 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
207 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
208 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
209 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
210 { "check_log_inodes", opt_int, &check_log_inodes },
211 { "check_log_space", opt_Kint, &check_log_space },
212 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
213 { "check_spool_inodes", opt_int, &check_spool_inodes },
214 { "check_spool_space", opt_Kint, &check_spool_space },
215 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
216 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
217 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
218 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
219 #ifdef EXPERIMENTAL_DCC
220 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
221 { "dccifd_address", opt_stringptr, &dccifd_address },
222 { "dccifd_options", opt_stringptr, &dccifd_options },
224 { "delay_warning", opt_timelist, &delay_warning },
225 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
226 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
227 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
228 { "delivery_date_remove", opt_bool, &delivery_date_remove },
229 #ifdef ENABLE_DISABLE_FSYNC
230 { "disable_fsync", opt_bool, &disable_fsync },
232 { "disable_ipv6", opt_bool, &disable_ipv6 },
234 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
236 #ifdef EXPERIMENTAL_DMARC
237 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
238 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
239 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
241 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
242 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
243 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
244 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
245 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
246 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
247 { "dns_retrans", opt_time, &dns_retrans },
248 { "dns_retry", opt_int, &dns_retry },
249 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
250 { "dns_use_edns0", opt_int, &dns_use_edns0 },
251 /* This option is now a no-op, retained for compability */
252 { "drop_cr", opt_bool, &drop_cr },
253 /*********************************************************/
254 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
255 { "dsn_from", opt_stringptr, &dsn_from },
256 { "envelope_to_remove", opt_bool, &envelope_to_remove },
257 { "errors_copy", opt_stringptr, &errors_copy },
258 { "errors_reply_to", opt_stringptr, &errors_reply_to },
259 #ifndef DISABLE_EVENT
260 { "event_action", opt_stringptr, &event_action },
262 { "exim_group", opt_gid, &exim_gid },
263 { "exim_path", opt_stringptr, &exim_path },
264 { "exim_user", opt_uid, &exim_uid },
265 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
266 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
267 { "finduser_retries", opt_int, &finduser_retries },
268 { "freeze_tell", opt_stringptr, &freeze_tell },
269 { "gecos_name", opt_stringptr, &gecos_name },
270 { "gecos_pattern", opt_stringptr, &gecos_pattern },
272 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
273 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
275 { "header_line_maxsize", opt_int, &header_line_maxsize },
276 { "header_maxsize", opt_int, &header_maxsize },
277 { "headers_charset", opt_stringptr, &headers_charset },
278 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
279 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
280 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
281 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
282 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
283 { "hold_domains", opt_stringptr, &hold_domains },
284 { "host_lookup", opt_stringptr, &host_lookup },
285 { "host_lookup_order", opt_stringptr, &host_lookup_order },
286 { "host_reject_connection", opt_stringptr, &host_reject_connection },
287 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
289 { "hosts_proxy", opt_stringptr, &hosts_proxy },
291 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
293 { "ibase_servers", opt_stringptr, &ibase_servers },
295 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
296 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
297 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
298 { "keep_environment", opt_stringptr, &keep_environment },
299 { "keep_malformed", opt_time, &keep_malformed },
301 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
302 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
303 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
304 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
305 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
306 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
307 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
308 { "ldap_start_tls", opt_bool, &eldap_start_tls },
309 { "ldap_version", opt_int, &eldap_version },
311 { "local_from_check", opt_bool, &local_from_check },
312 { "local_from_prefix", opt_stringptr, &local_from_prefix },
313 { "local_from_suffix", opt_stringptr, &local_from_suffix },
314 { "local_interfaces", opt_stringptr, &local_interfaces },
315 { "local_scan_timeout", opt_time, &local_scan_timeout },
316 { "local_sender_retain", opt_bool, &local_sender_retain },
317 { "localhost_number", opt_stringptr, &host_number_string },
318 { "log_file_path", opt_stringptr, &log_file_path },
319 { "log_selector", opt_stringptr, &log_selector_string },
320 { "log_timezone", opt_bool, &log_timezone },
321 { "lookup_open_max", opt_int, &lookup_open_max },
322 { "max_username_length", opt_int, &max_username_length },
323 { "message_body_newlines", opt_bool, &message_body_newlines },
324 { "message_body_visible", opt_mkint, &message_body_visible },
325 { "message_id_header_domain", opt_stringptr, &message_id_domain },
326 { "message_id_header_text", opt_stringptr, &message_id_text },
327 { "message_logs", opt_bool, &message_logs },
328 { "message_size_limit", opt_stringptr, &message_size_limit },
329 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
330 { "move_frozen_messages", opt_bool, &move_frozen_messages },
332 { "mua_wrapper", opt_bool, &mua_wrapper },
334 { "mysql_servers", opt_stringptr, &mysql_servers },
336 { "never_users", opt_uidlist, &never_users },
338 { "openssl_options", opt_stringptr, &openssl_options },
341 { "oracle_servers", opt_stringptr, &oracle_servers },
343 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
345 { "perl_at_start", opt_bool, &opt_perl_at_start },
346 { "perl_startup", opt_stringptr, &opt_perl_startup },
347 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
350 { "pgsql_servers", opt_stringptr, &pgsql_servers },
352 { "pid_file_path", opt_stringptr, &pid_file_path },
353 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
355 { "prdr_enable", opt_bool, &prdr_enable },
357 { "preserve_message_logs", opt_bool, &preserve_message_logs },
358 { "primary_hostname", opt_stringptr, &primary_hostname },
359 { "print_topbitchars", opt_bool, &print_topbitchars },
360 { "process_log_path", opt_stringptr, &process_log_path },
361 { "prod_requires_admin", opt_bool, &prod_requires_admin },
362 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
363 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
364 { "queue_domains", opt_stringptr, &queue_domains },
365 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
366 { "queue_only", opt_bool, &queue_only },
367 { "queue_only_file", opt_stringptr, &queue_only_file },
368 { "queue_only_load", opt_fixed, &queue_only_load },
369 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
370 { "queue_only_override", opt_bool, &queue_only_override },
371 { "queue_run_in_order", opt_bool, &queue_run_in_order },
372 { "queue_run_max", opt_int, &queue_run_max },
373 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
374 { "receive_timeout", opt_time, &receive_timeout },
375 { "received_header_text", opt_stringptr, &received_header_text },
376 { "received_headers_max", opt_int, &received_headers_max },
377 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
378 { "recipients_max", opt_int, &recipients_max },
379 { "recipients_max_reject", opt_bool, &recipients_max_reject },
381 { "redis_servers", opt_stringptr, &redis_servers },
383 { "remote_max_parallel", opt_int, &remote_max_parallel },
384 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
385 { "retry_data_expire", opt_time, &retry_data_expire },
386 { "retry_interval_max", opt_time, &retry_interval_max },
387 { "return_path_remove", opt_bool, &return_path_remove },
388 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
389 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
390 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
391 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
392 { "slow_lookup_log", opt_int, &slow_lookup_log },
393 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
394 { "smtp_accept_max", opt_int, &smtp_accept_max },
395 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
396 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
397 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
398 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
399 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
400 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
401 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
402 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
403 { "smtp_banner", opt_stringptr, &smtp_banner },
404 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
405 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
406 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
407 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
408 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
409 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
410 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
411 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
412 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
413 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
414 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
415 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
416 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
417 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
419 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
421 #ifdef WITH_CONTENT_SCAN
422 { "spamd_address", opt_stringptr, &spamd_address },
424 #ifdef EXPERIMENTAL_SPF
425 { "spf_guess", opt_stringptr, &spf_guess },
427 { "split_spool_directory", opt_bool, &split_spool_directory },
428 { "spool_directory", opt_stringptr, &spool_directory },
430 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
432 #ifdef EXPERIMENTAL_SRS
433 { "srs_config", opt_stringptr, &srs_config },
434 { "srs_hashlength", opt_int, &srs_hashlength },
435 { "srs_hashmin", opt_int, &srs_hashmin },
436 { "srs_maxage", opt_int, &srs_maxage },
437 { "srs_secrets", opt_stringptr, &srs_secrets },
438 { "srs_usehash", opt_bool, &srs_usehash },
439 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
441 { "strict_acl_vars", opt_bool, &strict_acl_vars },
442 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
443 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
444 { "syslog_duplication", opt_bool, &syslog_duplication },
445 { "syslog_facility", opt_stringptr, &syslog_facility_str },
446 { "syslog_processname", opt_stringptr, &syslog_processname },
447 { "syslog_timestamp", opt_bool, &syslog_timestamp },
448 { "system_filter", opt_stringptr, &system_filter },
449 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
450 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
451 { "system_filter_group", opt_gid, &system_filter_gid },
452 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
453 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
454 { "system_filter_user", opt_uid, &system_filter_uid },
455 { "tcp_nodelay", opt_bool, &tcp_nodelay },
456 #ifdef USE_TCP_WRAPPERS
457 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
459 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
460 { "timezone", opt_stringptr, &timezone_string },
461 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
463 { "tls_certificate", opt_stringptr, &tls_certificate },
464 { "tls_crl", opt_stringptr, &tls_crl },
465 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
466 { "tls_dhparam", opt_stringptr, &tls_dhparam },
467 { "tls_eccurve", opt_stringptr, &tls_eccurve },
468 # ifndef DISABLE_OCSP
469 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
471 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
472 { "tls_privatekey", opt_stringptr, &tls_privatekey },
473 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
474 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
475 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
476 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
477 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
479 { "trusted_groups", opt_gidlist, &trusted_groups },
480 { "trusted_users", opt_uidlist, &trusted_users },
481 { "unknown_login", opt_stringptr, &unknown_login },
482 { "unknown_username", opt_stringptr, &unknown_username },
483 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
484 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
485 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
486 { "warn_message_file", opt_stringptr, &warn_message_file },
487 { "write_rejectlog", opt_bool, &write_rejectlog }
490 static int optionlist_config_size =
491 sizeof(optionlist_config)/sizeof(optionlist);
495 /*************************************************
496 * Find the name of an option *
497 *************************************************/
499 /* This function is to aid debugging. Various functions take arguments that are
500 pointer variables in the options table or in option tables for various drivers.
501 For debugging output, it is useful to be able to find the name of the option
502 which is currently being processed. This function finds it, if it exists, by
503 searching the table(s).
505 Arguments: a value that is presumed to be in the table above
506 Returns: the option name, or an empty string
510 readconf_find_option(void *p)
514 transport_instance *t;
516 for (i = 0; i < optionlist_config_size; i++)
517 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
519 for (r = routers; r != NULL; r = r->next)
521 router_info *ri = r->info;
522 for (i = 0; i < *ri->options_count; i++)
524 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
525 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
526 return US ri->options[i].name;
530 for (t = transports; t != NULL; t = t->next)
532 transport_info *ti = t->info;
533 for (i = 0; i < *ti->options_count; i++)
535 optionlist * op = &ti->options[i];
536 if ((op->type & opt_mask) != opt_stringptr) continue;
537 if (p == ( op->type & opt_public
539 : (char *)t->options_block
541 + (long int)op->value)
552 /*************************************************
553 * Deal with an assignment to a macro *
554 *************************************************/
556 /* This function is called when a line that starts with an upper case letter is
557 encountered. The argument "line" should contain a complete logical line, and
558 start with the first letter of the macro name. The macro name and the
559 replacement text are extracted and stored. Redefinition of existing,
560 non-command line, macros is permitted using '==' instead of '='.
563 s points to the start of the logical line
569 read_macro_assignment(uschar *s)
575 macro_item *mlast = NULL;
577 while (isalnum(*s) || *s == '_')
579 if (namelen >= sizeof(name) - 1)
580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
581 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
582 name[namelen++] = *s++;
586 while (isspace(*s)) s++;
588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
595 while (isspace(*s)) s++;
597 /* If an existing macro of the same name was defined on the command line, we
598 just skip this definition. It's an error to attempt to redefine a macro without
599 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
600 It is also an error to define a macro whose name begins with the name of a
601 previously defined macro. Note: it is documented that the other way round
604 for (m = macros; m != NULL; m = m->next)
606 int len = Ustrlen(m->name);
608 if (Ustrcmp(m->name, name) == 0)
610 if (!m->command_line && !redef)
611 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
612 "defined (use \"==\" if you want to redefine it", name);
616 if (len < namelen && Ustrstr(name, m->name) != NULL)
617 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
618 "a macro because previously defined macro \"%s\" is a substring",
621 /* We cannot have this test, because it is documented that a substring
622 macro is permitted (there is even an example).
624 * if (len > namelen && Ustrstr(m->name, name) != NULL)
625 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
626 * "a macro because it is a substring of previously defined macro \"%s\"",
633 /* Check for an overriding command-line definition. */
635 if (m != NULL && m->command_line) return;
637 /* Redefinition must refer to an existing macro. */
642 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
646 /* We have a new definition. The macro_item structure includes a final vector
647 called "name" which is one byte long. Thus, adding "namelen" gives us enough
648 room to store the "name" string. */
652 m = store_get(sizeof(macro_item) + namelen);
653 if (macros == NULL) macros = m; else mlast->next = m;
654 Ustrncpy(m->name, name, namelen);
655 m->name[namelen] = 0;
657 m->command_line = FALSE;
660 /* Set the value of the new or redefined macro */
662 m->replacement = string_copy(s);
669 /*************************************************
670 * Read configuration line *
671 *************************************************/
673 /* A logical line of text is read from the configuration file into the big
674 buffer, taking account of macros, .includes, and continuations. The size of
675 big_buffer is increased if necessary. The count of configuration lines is
676 maintained. Physical input lines starting with # (ignoring leading white space,
677 and after macro replacement) and empty logical lines are always ignored.
678 Leading and trailing spaces are removed.
680 If we hit a line of the form "begin xxxx", the xxxx is placed in the
681 next_section vector, and the function returns NULL, indicating the end of a
682 configuration section. On end-of-file, NULL is returned with next_section
687 Returns: a pointer to the first non-blank in the line,
688 or NULL if eof or end of section is reached
692 get_config_line(void)
694 int startoffset = 0; /* To first non-blank char in logical line */
695 int len = 0; /* Of logical line so far */
701 /* Loop for handling continuation lines, skipping comments, and dealing with
706 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
708 if (config_file_stack != NULL) /* EOF inside .include */
710 (void)fclose(config_file);
711 config_file = config_file_stack->file;
712 config_filename = config_file_stack->filename;
713 config_lineno = config_file_stack->lineno;
714 config_file_stack = config_file_stack->next;
716 save_config_position(config_filename, config_lineno);
720 /* EOF at top level */
722 if (cstate_stack_ptr >= 0)
723 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
724 "Unexpected end of configuration file: .endif missing");
726 if (len != 0) break; /* EOF after continuation */
727 next_section[0] = 0; /* EOF at start of logical line */
732 newlen = len + Ustrlen(big_buffer + len);
734 if (config_lines && config_lineno == 1)
735 save_config_position(config_filename, config_lineno);
737 /* Handle pathologically long physical lines - yes, it did happen - by
738 extending big_buffer at this point. The code also copes with very long
741 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
744 big_buffer_size += BIG_BUFFER_SIZE;
745 newbuffer = store_malloc(big_buffer_size);
747 /* This use of strcpy is OK because we know that the string in the old
748 buffer is shorter than the new buffer. */
750 Ustrcpy(newbuffer, big_buffer);
751 store_free(big_buffer);
752 big_buffer = newbuffer;
753 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
755 newlen += Ustrlen(big_buffer + newlen);
758 /* Find the true start of the physical line - leading spaces are always
761 ss = big_buffer + len;
762 while (isspace(*ss)) ss++;
764 /* Process the physical line for macros. If this is the start of the logical
765 line, skip over initial text at the start of the line if it starts with an
766 upper case character followed by a sequence of name characters and an equals
767 sign, because that is the definition of a new macro, and we don't do
768 replacement therein. */
771 if (len == 0 && isupper(*s))
773 while (isalnum(*s) || *s == '_') s++;
774 while (isspace(*s)) s++;
775 if (*s != '=') s = ss; /* Not a macro definition */
778 /* For each defined macro, scan the line (from after XXX= if present),
779 replacing all occurrences of the macro. */
782 for (m = macros; m != NULL; m = m->next)
787 while ((p = Ustrstr(t, m->name)) != NULL)
790 int namelen = Ustrlen(m->name);
791 int replen = Ustrlen(m->replacement);
793 /* Expand the buffer if necessary */
795 while (newlen - namelen + replen + 1 > big_buffer_size)
797 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
798 uschar *newbuffer = store_malloc(newsize);
799 memcpy(newbuffer, big_buffer, newlen + 1);
800 p = newbuffer + (p - big_buffer);
801 s = newbuffer + (s - big_buffer);
802 ss = newbuffer + (ss - big_buffer);
803 t = newbuffer + (t - big_buffer);
804 big_buffer_size = newsize;
805 store_free(big_buffer);
806 big_buffer = newbuffer;
809 /* Shuffle the remaining characters up or down in the buffer before
810 copying in the replacement text. Don't rescan the replacement for this
814 moveby = replen - namelen;
817 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
820 Ustrncpy(p, m->replacement, replen);
826 /* An empty macro replacement at the start of a line could mean that ss no
827 longer points to the first non-blank character. */
829 while (isspace(*ss)) ss++;
831 /* Check for comment lines - these are physical lines. */
833 if (*ss == '#') continue;
835 /* Handle conditionals, which are also applied to physical lines. Conditions
836 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
837 expansion occured on the rest of the line. A preliminary test for the leading
838 '.' saves effort on most lines. */
844 /* Search the list of conditional directives */
846 for (i = 0; i < cond_list_size; i++)
849 cond_item *c = cond_list+i;
850 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
852 /* The following character must be white space or end of string */
854 n = ss[1 + c->namelen];
855 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
857 /* .ifdef and .ifndef push the current state onto the stack, then set
858 a new one from the table. Stack overflow is an error */
862 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
863 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
864 ".%s nested too deeply", c->name);
865 cstate_stack[++cstate_stack_ptr] = cstate;
866 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
869 /* For any of the others, stack underflow is an error. The next state
870 comes either from the stack (.endif) or from the table. */
874 if (cstate_stack_ptr < 0)
875 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
876 ".%s without matching .ifdef", c->name);
877 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
878 next_cstate[cstate][macro_found? c->action1 : c->action2];
881 /* Having dealt with a directive, break the loop */
886 /* If we have handled a conditional directive, continue with the next
887 physical line. Otherwise, fall through. */
889 if (i < cond_list_size) continue;
892 /* If the conditional state is not 0 (actively using these lines), ignore
895 if (cstate != 0) continue; /* Conditional skip */
897 /* Handle .include lines - these are also physical lines. */
899 if (Ustrncmp(ss, ".include", 8) == 0 &&
901 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
904 int include_if_exists = isspace(ss[8])? 0 : 10;
905 config_file_item *save;
908 ss += 9 + include_if_exists;
909 while (isspace(*ss)) ss++;
910 t = ss + Ustrlen(ss);
911 while (t > ss && isspace(t[-1])) t--;
912 if (*ss == '\"' && t[-1] == '\"')
920 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
921 "absolute path \"%s\"", ss);
923 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
926 save_config_position(config_filename, config_lineno);
927 save = store_get(sizeof(config_file_item));
928 save->next = config_file_stack;
929 config_file_stack = save;
930 save->file = config_file;
931 save->filename = config_filename;
932 save->lineno = config_lineno;
934 config_file = Ufopen(ss, "rb");
935 if (config_file == NULL)
936 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
937 "configuration file %s", ss);
938 config_filename = string_copy(ss);
943 /* If this is the start of the logical line, remember where the non-blank
944 data starts. Otherwise shuffle down continuation lines to remove leading
948 startoffset = ss - big_buffer;
951 s = big_buffer + len;
954 memmove(s, ss, (newlen - len) - (ss - s) + 1);
959 /* Accept the new addition to the line. Remove trailing white space. */
962 while (len > 0 && isspace(big_buffer[len-1])) len--;
965 /* We are done if the line does not end in backslash and contains some data.
966 Empty logical lines are ignored. For continuations, remove the backslash and
967 go round the loop to read the continuation line. */
971 if (big_buffer[len-1] != '\\') break; /* End of logical line */
972 big_buffer[--len] = 0; /* Remove backslash */
974 } /* Loop for reading multiple physical lines */
976 /* We now have a logical line. Test for the end of a configuration section (or,
977 more accurately, for the start of the next section). Place the name of the next
978 section in next_section, and return NULL. If the name given is longer than
979 next_section, truncate it. It will be unrecognized later, because all the known
980 section names do fit. Leave space for pluralizing. */
982 s = big_buffer + startoffset; /* First non-space character */
987 if (strncmpic(s, US"begin ", 6) == 0)
990 while (isspace(*s)) s++;
991 if (big_buffer + len - s > sizeof(next_section) - 2)
992 s[sizeof(next_section) - 2] = 0;
993 Ustrcpy(next_section, s);
997 /* Return the first non-blank character. */
1004 /*************************************************
1006 *************************************************/
1008 /* The yield is the pointer to the next uschar. Names longer than the
1009 output space are silently truncated. This function is also used from acl.c when
1013 name where to put the name
1017 Returns: new input pointer
1021 readconf_readname(uschar *name, int len, uschar *s)
1024 while (isspace(*s)) s++;
1027 while (isalnum(*s) || *s == '_')
1029 if (p < len-1) name[p++] = *s;
1034 while (isspace(*s)) s++;
1041 /*************************************************
1042 * Read a time value *
1043 *************************************************/
1045 /* This function is also called from outside, to read argument
1046 time values. The format of a time value is:
1048 [<n>w][<n>d][<n>h][<n>m][<n>s]
1050 as long as at least one is present. If a format error is encountered,
1051 return a negative value. The value must be terminated by the given
1056 terminator required terminating character
1057 return_msec if TRUE, allow fractional seconds and return milliseconds
1059 Returns: the time value, or -1 on syntax error
1060 value is seconds if return_msec is FALSE
1061 value is milliseconds if return_msec is TRUE
1065 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1073 if (!isdigit(*s)) return -1;
1074 (void)sscanf(CCS s, "%d%n", &value, &count);
1079 case 'w': value *= 7;
1080 case 'd': value *= 24;
1081 case 'h': value *= 60;
1082 case 'm': value *= 60;
1087 if (!return_msec) return -1;
1088 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1090 if (*s++ != 's') return -1;
1091 yield += (int)(fraction * 1000.0);
1097 if (return_msec) value *= 1000;
1099 if (*s == terminator) return yield;
1101 /* Control never reaches here. */
1106 /*************************************************
1107 * Read a fixed point value *
1108 *************************************************/
1110 /* The value is returned *1000
1114 terminator required terminator
1116 Returns: the value, or -1 on error
1120 readconf_readfixed(const uschar *s, int terminator)
1124 if (!isdigit(*s)) return -1;
1125 (void)sscanf(CS s, "%d%n", &value, &count);
1127 yield = value * 1000;
1131 while (isdigit((*(++s))))
1133 yield += (*s - '0') * m;
1138 return (*s == terminator)? yield : (-1);
1143 /*************************************************
1144 * Find option in list *
1145 *************************************************/
1147 /* The lists are always in order, so binary chop can be used.
1150 name the option name to search for
1151 ol the first entry in the option list
1152 last one more than the offset of the last entry in the option list
1154 Returns: pointer to an option entry, or NULL if not found
1158 find_option(uschar *name, optionlist *ol, int last)
1161 while (last > first)
1163 int middle = (first + last)/2;
1164 int c = Ustrcmp(name, ol[middle].name);
1165 if (c == 0) return ol + middle;
1166 else if (c > 0) first = middle + 1;
1174 /*************************************************
1175 * Find a set flag in option list *
1176 *************************************************/
1178 /* Because some versions of Unix make no restrictions on the values of uids and
1179 gids (even negative ones), we cannot represent "unset" by a special value.
1180 There is therefore a separate boolean variable for each one indicating whether
1181 a value is set or not. This function returns a pointer to the boolean, given
1182 the original option name. It is a major disaster if the flag cannot be found.
1185 name the name of the uid or gid option
1186 oltop points to the start of the relevant option list
1187 last one more than the offset of the last item in the option list
1188 data_block NULL when reading main options => data values in the option
1189 list are absolute addresses; otherwise they are byte offsets
1190 in data_block (used for driver options)
1192 Returns: a pointer to the boolean flag.
1196 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1200 sprintf(CS name2, "*set_%.50s", name);
1201 ol = find_option(name2, oltop, last);
1202 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1203 "Exim internal error: missing set flag for %s", name);
1204 return (data_block == NULL)? (BOOL *)(ol->value) :
1205 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1211 /*************************************************
1212 * Output extra characters message and die *
1213 *************************************************/
1215 /* Called when an option line has junk on the end. Sometimes this is because
1216 the sysadmin thinks comments are permitted.
1219 s points to the extra characters
1220 t1..t3 strings to insert in the log message
1222 Returns: doesn't return; dies
1226 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1228 uschar *comment = US"";
1229 if (*s == '#') comment = US" (# is comment only at line start)";
1230 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1231 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1236 /*************************************************
1237 * Read rewrite information *
1238 *************************************************/
1240 /* Each line of rewrite information contains:
1242 . A complete address in the form user@domain, possibly with
1243 leading * for each part; or alternatively, a regex.
1245 . A replacement string (which will be expanded).
1247 . An optional sequence of one-letter flags, indicating which
1248 headers etc. to apply this rule to.
1250 All this is decoded and placed into a control block. The OR of the flags is
1251 maintained in a common word.
1254 p points to the string that makes up the rule
1255 existflags points to the overall flag word
1256 isglobal TRUE if reading global rewrite rules
1258 Returns: the control block for the parsed rule.
1261 static rewrite_rule *
1262 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1264 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1267 next->key = string_dequote(&p);
1269 while (isspace(*p)) p++;
1271 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1272 "missing rewrite replacement string");
1275 next->replacement = string_dequote(&p);
1277 while (*p != 0) switch (*p++)
1279 case ' ': case '\t': break;
1281 case 'q': next->flags |= rewrite_quit; break;
1282 case 'w': next->flags |= rewrite_whole; break;
1284 case 'h': next->flags |= rewrite_all_headers; break;
1285 case 's': next->flags |= rewrite_sender; break;
1286 case 'f': next->flags |= rewrite_from; break;
1287 case 't': next->flags |= rewrite_to; break;
1288 case 'c': next->flags |= rewrite_cc; break;
1289 case 'b': next->flags |= rewrite_bcc; break;
1290 case 'r': next->flags |= rewrite_replyto; break;
1292 case 'E': next->flags |= rewrite_all_envelope; break;
1293 case 'F': next->flags |= rewrite_envfrom; break;
1294 case 'T': next->flags |= rewrite_envto; break;
1296 case 'Q': next->flags |= rewrite_qualify; break;
1297 case 'R': next->flags |= rewrite_repeat; break;
1300 next->flags |= rewrite_smtp;
1301 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1302 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1303 "rewrite rule has the S flag but is not a regular expression");
1307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1308 "unknown rewrite flag character '%c' "
1309 "(could be missing quotes round replacement item)", p[-1]);
1313 /* If no action flags are set, set all the "normal" rewrites. */
1315 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1316 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1318 /* Remember which exist, for optimization, and return the rule */
1320 *existflags |= next->flags;
1327 /*************************************************
1328 * Read global rewrite information *
1329 *************************************************/
1331 /* Each line is a single rewrite rule; it is parsed into a control block
1332 by readconf_one_rewrite(), and its flags are ORed into the global flag
1333 word rewrite_existflags. */
1336 readconf_rewrites(void)
1338 rewrite_rule **chain = &global_rewrite_rules;
1341 while ((p = get_config_line()) != NULL)
1343 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1345 chain = &(next->next);
1351 /*************************************************
1353 *************************************************/
1355 /* Strings are read into the normal store pool. As long we aren't too
1356 near the end of the current block, the string will just use what is necessary
1357 on the top of the stacking pool, because string_cat() uses the extension
1361 s the rest of the input line
1362 name the option name (for errors)
1364 Returns: pointer to the string
1368 read_string(const uschar *s, const uschar *name)
1373 if (*s != '\"') return string_copy(s);
1376 yield = string_dequote(&s);
1378 if (s == ss+1 || s[-1] != '\"')
1379 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1380 "missing quote at end of string value for %s", name);
1382 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1388 /*************************************************
1389 * Custom-handler options *
1390 *************************************************/
1392 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1395 smtp_receive_timeout_s = string_copy(str);
1398 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1399 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1400 if (smtp_receive_timeout < 0)
1401 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1406 /*************************************************
1407 * Handle option line *
1408 *************************************************/
1410 /* This function is called from several places to process a line containing the
1411 setting of an option. The first argument is the line to be decoded; it has been
1412 checked not to be empty and not to start with '#'. Trailing newlines and white
1413 space have been removed. The second argument is a pointer to the list of
1414 variable names that are to be recognized, together with their types and
1415 locations, and the third argument gives the number of entries in the list.
1417 The fourth argument is a pointer to a data block. If it is NULL, then the data
1418 values in the options list are absolute addresses. Otherwise, they are byte
1419 offsets in the data block.
1421 String option data may continue onto several lines; this function reads further
1422 data from config_file if necessary.
1424 The yield of this function is normally zero. If a string continues onto
1425 multiple lines, then the data value is permitted to be followed by a comma
1426 or a semicolon (for use in drivers) and the yield is that character.
1429 buffer contains the configuration line to be handled
1430 oltop points to the start of the relevant option list
1431 last one more than the offset of the last item in the option list
1432 data_block NULL when reading main options => data values in the option
1433 list are absolute addresses; otherwise they are byte offsets
1434 in data_block when they have opt_public set; otherwise
1435 they are byte offsets in data_block->options_block.
1436 unknown_txt format string to use in panic message for unknown option;
1437 must contain %s for option name
1438 if given as NULL, don't panic on unknown option
1440 Returns: TRUE if an option was read successfully,
1441 FALSE false for an unknown option if unknown_txt == NULL,
1442 otherwise panic and die on an unknown option
1446 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1447 void *data_block, uschar *unknown_txt)
1451 int n, count, type, value;
1455 BOOL boolvalue = TRUE;
1456 BOOL freesptr = TRUE;
1457 optionlist *ol, *ol2;
1461 uschar *inttype = US"";
1464 uschar *saved_condition, *strtemp;
1465 uschar **str_target;
1469 /* There may be leading spaces; thereafter, we expect an option name starting
1472 while (isspace(*s)) s++;
1474 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1476 /* Read the name of the option, and skip any subsequent white space. If
1477 it turns out that what we read was "hide", set the flag indicating that
1478 this is a secure option, and loop to read the next word. */
1480 for (n = 0; n < 2; n++)
1482 while (isalnum(*s) || *s == '_')
1484 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1488 while (isspace(*s)) s++;
1489 if (Ustrcmp(name, "hide") != 0) break;
1490 issecure = opt_secure;
1494 /* Deal with "no_" or "not_" here for booleans */
1496 if (Ustrncmp(name, "no_", 3) == 0)
1502 if (Ustrncmp(name, "not_", 4) == 0)
1508 /* Search the list for the given name. A non-existent name, or an option that
1509 is set twice, is a disaster. */
1511 ol = find_option(name + offset, oltop, last);
1515 if (unknown_txt == NULL) return FALSE;
1516 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1519 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1520 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1521 "\"%s\" option set for the second time", name);
1523 ol->type |= opt_set | issecure;
1524 type = ol->type & opt_mask;
1526 /* Types with data values must be followed by '='; the "no[t]_" prefix
1527 applies only to boolean values. */
1529 if (type < opt_bool || type > opt_bool_last)
1532 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1533 "negation prefix applied to a non-boolean option");
1535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1536 "unexpected end of line (data missing) after %s", name);
1538 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1541 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1542 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1543 ultimately expands to one of those values. */
1545 else if (*s != 0 && (offset != 0 || *s != '='))
1546 extra_chars_error(s, US"boolean option ", name, US"");
1548 /* Skip white space after = */
1550 if (*s == '=') while (isspace((*(++s))));
1552 /* If there is a data block and the opt_public flag is not set, change
1553 the data block pointer to the private options block. */
1555 if (data_block != NULL && (ol->type & opt_public) == 0)
1556 data_block = (void *)(((driver_instance *)data_block)->options_block);
1558 /* Now get the data according to the type. */
1562 /* If a string value is not enclosed in quotes, it consists of
1563 the rest of the current line, verbatim. Otherwise, string escapes
1566 A transport is specified as a string, which is then looked up in the
1567 list of transports. A search type is specified as one of a number of
1570 A set or rewrite rules for a driver is specified as a string, which is
1571 then parsed into a suitable chain of control blocks.
1573 Uids and gids are specified as strings which are then looked up in the
1574 passwd file. Lists of uids and gids are similarly specified as colon-
1575 separated strings. */
1580 case opt_expand_uid:
1581 case opt_expand_gid:
1586 reset_point = sptr = read_string(s, name);
1588 /* Having read a string, we now have several different ways of using it,
1589 depending on the data type, so do another switch. If keeping the actual
1590 string is not required (because it is interpreted), freesptr is set TRUE,
1591 and at the end we reset the pool. */
1595 /* If this was a string, set the variable to point to the new string,
1596 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1597 rules, we still keep the string (for printing), and parse the rules into a
1598 control block and flags word. */
1601 if (data_block == NULL)
1602 str_target = (uschar **)(ol->value);
1604 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1605 if (ol->type & opt_rep_con)
1607 /* We already have a condition, we're conducting a crude hack to let
1608 multiple condition rules be chained together, despite storing them in
1610 saved_condition = *str_target;
1611 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1612 saved_condition, sptr);
1613 *str_target = string_copy_malloc(strtemp);
1614 /* TODO(pdp): there is a memory leak here and just below
1615 when we set 3 or more conditions; I still don't
1616 understand the store mechanism enough to know
1617 what's the safe way to free content from an earlier store.
1618 AFAICT, stores stack, so freeing an early stored item also stores
1619 all data alloc'd after it. If we knew conditions were adjacent,
1620 we could survive that, but we don't. So I *think* we need to take
1621 another bit from opt_type to indicate "malloced"; this seems like
1622 quite a hack, especially for this one case. It also means that
1623 we can't ever reclaim the store from the *first* condition.
1625 Because we only do this once, near process start-up, I'm prepared to
1626 let this slide for the time being, even though it rankles. */
1628 else if (ol->type & opt_rep_str)
1630 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1631 int sep_i = -(int)sep_o;
1632 const uschar * list = sptr;
1634 uschar * list_o = *str_target;
1636 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1637 list_o = string_append_listele(list_o, sep_o, s);
1639 *str_target = string_copy_malloc(list_o);
1649 if (data_block == NULL)
1650 *((uschar **)(ol->value)) = sptr;
1652 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1654 if (type == opt_rewrite)
1659 rewrite_rule **chain;
1662 sprintf(CS name2, "*%.50s_rules", name);
1663 ol2 = find_option(name2, oltop, last);
1664 sprintf(CS name2, "*%.50s_flags", name);
1665 ol3 = find_option(name2, oltop, last);
1667 if (ol2 == NULL || ol3 == NULL)
1668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1669 "rewrite rules not available for driver");
1671 if (data_block == NULL)
1673 chain = (rewrite_rule **)(ol2->value);
1674 flagptr = (int *)(ol3->value);
1678 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1679 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1682 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1684 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1686 chain = &(next->next);
1689 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1690 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1691 "non-header rewrite - not allowed at transport time -");
1695 /* If it was an expanded uid, see if there is any expansion to be
1696 done by checking for the presence of a $ character. If there is, save it
1697 in the corresponding *expand_user option field. Otherwise, fall through
1698 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1701 case opt_expand_uid:
1702 sprintf(CS name2, "*expand_%.50s", name);
1703 ol2 = find_option(name2, oltop, last);
1706 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1708 if (data_block == NULL)
1709 *((uschar **)(ol2->value)) = ss;
1711 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1715 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1721 /* Look up a fixed uid, and also make use of the corresponding gid
1722 if a passwd entry is returned and the gid has not been set. */
1725 if (!route_finduser(sptr, &pw, &uid))
1726 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1727 if (data_block == NULL)
1728 *((uid_t *)(ol->value)) = uid;
1730 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1732 /* Set the flag indicating a fixed value is set */
1734 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1736 /* Handle matching gid if we have a passwd entry: done by finding the
1737 same name with terminating "user" changed to "group"; if not found,
1738 ignore. Also ignore if the value is already set. */
1740 if (pw == NULL) break;
1741 Ustrcpy(name+Ustrlen(name)-4, "group");
1742 ol2 = find_option(name, oltop, last);
1743 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1744 (ol2->type & opt_mask) == opt_expand_gid))
1746 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1749 if (data_block == NULL)
1750 *((gid_t *)(ol2->value)) = pw->pw_gid;
1752 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1758 /* If it was an expanded gid, see if there is any expansion to be
1759 done by checking for the presence of a $ character. If there is, save it
1760 in the corresponding *expand_user option field. Otherwise, fall through
1761 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1764 case opt_expand_gid:
1765 sprintf(CS name2, "*expand_%.50s", name);
1766 ol2 = find_option(name2, oltop, last);
1769 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1771 if (data_block == NULL)
1772 *((uschar **)(ol2->value)) = ss;
1774 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1778 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1784 /* Handle freestanding gid */
1787 if (!route_findgroup(sptr, &gid))
1788 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1789 if (data_block == NULL)
1790 *((gid_t *)(ol->value)) = gid;
1792 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1793 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1796 /* If it was a uid list, look up each individual entry, and build
1797 a vector of uids, with a count in the first element. Put the vector
1798 in malloc store so we can free the string. (We are reading into
1799 permanent store already.) */
1807 const uschar *op = expand_string (sptr);
1810 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1811 name, expand_string_message);
1814 if (*p != 0) count++;
1815 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1816 list = store_malloc(count*sizeof(uid_t));
1817 list[ptr++] = (uid_t)(count - 1);
1819 if (data_block == NULL)
1820 *((uid_t **)(ol->value)) = list;
1822 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1828 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1829 if (!route_finduser(big_buffer, NULL, &uid))
1830 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1837 /* If it was a gid list, look up each individual entry, and build
1838 a vector of gids, with a count in the first element. Put the vector
1839 in malloc store so we can free the string. (We are reading into permanent
1848 const uschar *op = expand_string (sptr);
1851 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1852 name, expand_string_message);
1855 if (*p != 0) count++;
1856 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1857 list = store_malloc(count*sizeof(gid_t));
1858 list[ptr++] = (gid_t)(count - 1);
1860 if (data_block == NULL)
1861 *((gid_t **)(ol->value)) = list;
1863 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1869 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1870 if (!route_findgroup(big_buffer, &gid))
1871 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1879 /* Release store if the value of the string doesn't need to be kept. */
1881 if (freesptr) store_reset(reset_point);
1884 /* Expanded boolean: if no characters follow, or if there are no dollar
1885 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1886 save the string for later expansion in the alternate place. */
1888 case opt_expand_bool:
1889 if (*s != 0 && Ustrchr(s, '$') != 0)
1891 sprintf(CS name2, "*expand_%.50s", name);
1892 ol2 = find_option(name2, oltop, last);
1895 reset_point = sptr = read_string(s, name);
1896 if (data_block == NULL)
1897 *((uschar **)(ol2->value)) = sptr;
1899 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1906 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1907 look for yes/not/true/false. Some booleans are stored in a single bit in
1908 a single int. There's a special fudge for verify settings; without a suffix
1909 they set both xx_sender and xx_recipient. The table points to the sender
1910 value; search subsequently for the recipient. There's another special case:
1911 opt_bool_set also notes when a boolean has been set. */
1915 case opt_bool_verify:
1919 s = readconf_readname(name2, 64, s);
1920 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1922 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1924 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1925 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1926 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1927 US"for boolean option ", name);
1930 /* Handle single-bit type. */
1932 if (type == opt_bit)
1934 int bit = 1 << ((ol->type >> 16) & 31);
1935 int *ptr = (data_block == NULL)?
1936 (int *)(ol->value) :
1937 (int *)((uschar *)data_block + (long int)ol->value);
1938 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1942 /* Handle full BOOL types */
1944 if (data_block == NULL)
1945 *((BOOL *)(ol->value)) = boolvalue;
1947 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1951 if (type == opt_bool_verify)
1953 sprintf(CS name2, "%.50s_recipient", name + offset);
1954 ol2 = find_option(name2, oltop, last);
1957 if (data_block == NULL)
1958 *((BOOL *)(ol2->value)) = boolvalue;
1960 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1964 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1966 else if (type == opt_bool_set)
1968 sprintf(CS name2, "*set_%.50s", name + offset);
1969 ol2 = find_option(name2, oltop, last);
1972 if (data_block == NULL)
1973 *((BOOL *)(ol2->value)) = TRUE;
1975 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1984 inttype = US"octal ";
1986 /* Integer: a simple(ish) case; allow octal and hex formats, and
1987 suffixes K and M. The different types affect output, not input. */
1996 lvalue = strtol(CS s, CSS &endptr, intbase);
1999 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2002 if (errno != ERANGE)
2004 if (tolower(*endptr) == 'k')
2006 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2007 else lvalue *= 1024;
2010 else if (tolower(*endptr) == 'm')
2012 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2014 else lvalue *= 1024*1024;
2019 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2020 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2021 "absolute value of integer \"%s\" is too large (overflow)", s);
2023 while (isspace(*endptr)) endptr++;
2025 extra_chars_error(endptr, inttype, US"integer value for ", name);
2027 value = (int)lvalue;
2030 if (data_block == NULL)
2031 *((int *)(ol->value)) = value;
2033 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2036 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
2038 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2044 value = strtol(CS s, CSS &endptr, intbase);
2047 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2050 if (errno != ERANGE)
2052 if (tolower(*endptr) == 'm')
2054 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
2058 else if (tolower(*endptr) == 'k')
2064 value = (value + 512)/1024;
2068 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2069 "absolute value of integer \"%s\" is too large (overflow)", s);
2071 while (isspace(*endptr)) endptr++;
2073 extra_chars_error(endptr, inttype, US"integer value for ", name);
2076 if (data_block == NULL)
2077 *((int *)(ol->value)) = value;
2079 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2082 /* Fixed-point number: held to 3 decimal places. */
2085 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2086 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2087 "fixed-point number expected for %s", name);
2089 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2090 "integer \"%s\" is too large (overflow)", s);
2094 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2095 "integer \"%s\" is too large (overflow)", s);
2097 if (s[count] == '.')
2100 while (isdigit(s[++count]))
2102 value += (s[count] - '0') * d;
2107 while (isspace(s[count])) count++;
2110 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2112 if (data_block == NULL)
2113 *((int *)(ol->value)) = value;
2115 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2118 /* There's a special routine to read time values. */
2121 value = readconf_readtime(s, 0, FALSE);
2123 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2125 if (data_block == NULL)
2126 *((int *)(ol->value)) = value;
2128 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2131 /* A time list is a list of colon-separated times, with the first
2132 element holding the size of the list and the second the number of
2138 int *list = (data_block == NULL)?
2139 (int *)(ol->value) :
2140 (int *)((uschar *)data_block + (long int)(ol->value));
2142 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2145 uschar *snext = Ustrchr(s, ':');
2149 while (ss > s && isspace(ss[-1])) ss--;
2152 value = readconf_readtime(s, terminator, FALSE);
2154 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2156 if (count > 1 && value <= list[count])
2157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2158 "time value out of order for %s", name);
2159 list[count+1] = value;
2160 if (snext == NULL) break;
2162 while (isspace(*s)) s++;
2165 if (count > list[0] - 2)
2166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2168 if (count > 0 && list[2] == 0) count = 0;
2175 void (*fn)() = ol->value;
2186 /*************************************************
2187 * Print a time value *
2188 *************************************************/
2191 Argument: a time value in seconds
2192 Returns: pointer to a fixed buffer containing the time as a string,
2193 in readconf_readtime() format
2197 readconf_printtime(int t)
2200 uschar *p = time_buffer;
2217 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2218 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2219 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2220 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2221 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2228 /*************************************************
2229 * Print an individual option value *
2230 *************************************************/
2232 /* This is used by the -bP option, so prints to the standard output.
2233 The entire options list is passed in as an argument, because some options come
2234 in pairs - typically uid/gid settings, which can either be explicit numerical
2235 values, or strings to be expanded later. If the numerical value is unset,
2236 search for "*expand_<name>" to see if there is a string equivalent.
2239 ol option entry, or NULL for an unknown option
2241 options_block NULL for main configuration options; otherwise points to
2242 a driver block; if the option doesn't have opt_public
2243 set, then options_block->options_block is where the item
2245 oltop points to the option list in which ol exists
2246 last one more than the offset of the last entry in optop
2247 no_labels do not show "foo = " at the start.
2253 print_ol(optionlist *ol, uschar *name, void *options_block,
2254 optionlist *oltop, int last, BOOL no_labels)
2267 printf("%s is not a known option\n", name);
2271 /* Non-admin callers cannot see options that have been flagged secure by the
2274 if (!admin_user && (ol->type & opt_secure) != 0)
2277 printf("%s\n", hidden);
2279 printf("%s = %s\n", name, hidden);
2283 /* Else show the value of the option */
2286 if (options_block != NULL)
2288 if ((ol->type & opt_public) == 0)
2289 options_block = (void *)(((driver_instance *)options_block)->options_block);
2290 value = (void *)((uschar *)options_block + (long int)value);
2293 switch(ol->type & opt_mask)
2296 case opt_rewrite: /* Show the text value */
2297 s = *((uschar **)value);
2298 if (!no_labels) printf("%s = ", name);
2299 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2303 if (!no_labels) printf("%s = ", name);
2304 printf("%d\n", *((int *)value));
2309 int x = *((int *)value);
2310 if (x != 0 && (x & 1023) == 0)
2314 if ((x & 1023) == 0)
2319 if (!no_labels) printf("%s = ", name);
2320 printf("%d%c\n", x, c);
2324 if (!no_labels) printf("%s = ", name);
2332 int x = *((int *)value);
2333 if (!no_labels) printf("%s = ", name);
2334 if (x == 0) printf("0\n");
2335 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2336 else printf("%dK\n", x);
2341 if (!no_labels) printf("%s = ", name);
2342 printf("%#o\n", *((int *)value));
2345 /* Can be negative only when "unset", in which case integer */
2349 int x = *((int *)value);
2352 if (x < 0) printf("%s =\n", name); else
2354 if (!no_labels) printf("%s = ", name);
2355 printf("%d.", x/1000);
2368 /* If the numerical value is unset, try for the string value */
2370 case opt_expand_uid:
2371 if (! *get_set_flag(name, oltop, last, options_block))
2373 sprintf(CS name2, "*expand_%.50s", name);
2374 ol2 = find_option(name2, oltop, last);
2377 void *value2 = ol2->value;
2378 if (options_block != NULL)
2379 value2 = (void *)((uschar *)options_block + (long int)value2);
2380 s = *((uschar **)value2);
2381 if (!no_labels) printf("%s = ", name);
2382 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2387 /* Else fall through */
2390 if (!no_labels) printf("%s = ", name);
2391 if (! *get_set_flag(name, oltop, last, options_block))
2395 pw = getpwuid(*((uid_t *)value));
2397 printf("%ld\n", (long int)(*((uid_t *)value)));
2398 else printf("%s\n", pw->pw_name);
2402 /* If the numerical value is unset, try for the string value */
2404 case opt_expand_gid:
2405 if (! *get_set_flag(name, oltop, last, options_block))
2407 sprintf(CS name2, "*expand_%.50s", name);
2408 ol2 = find_option(name2, oltop, last);
2409 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2411 void *value2 = ol2->value;
2412 if (options_block != NULL)
2413 value2 = (void *)((uschar *)options_block + (long int)value2);
2414 s = *((uschar **)value2);
2415 if (!no_labels) printf("%s = ", name);
2416 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2421 /* Else fall through */
2424 if (!no_labels) printf("%s = ", name);
2425 if (! *get_set_flag(name, oltop, last, options_block))
2429 gr = getgrgid(*((int *)value));
2431 printf("%ld\n", (long int)(*((int *)value)));
2432 else printf("%s\n", gr->gr_name);
2437 uidlist = *((uid_t **)value);
2438 if (!no_labels) printf("%s =", name);
2439 if (uidlist != NULL)
2443 if (no_labels) sep = '\0';
2444 for (i = 1; i <= (int)(uidlist[0]); i++)
2446 uschar *name = NULL;
2447 pw = getpwuid(uidlist[i]);
2448 if (pw != NULL) name = US pw->pw_name;
2449 if (sep != '\0') printf("%c", sep);
2450 if (name != NULL) printf("%s", name);
2451 else printf("%ld", (long int)(uidlist[i]));
2459 gidlist = *((gid_t **)value);
2460 if (!no_labels) printf("%s =", name);
2461 if (gidlist != NULL)
2465 if (no_labels) sep = '\0';
2466 for (i = 1; i <= (int)(gidlist[0]); i++)
2468 uschar *name = NULL;
2469 gr = getgrgid(gidlist[i]);
2470 if (gr != NULL) name = US gr->gr_name;
2471 if (sep != '\0') printf("%c", sep);
2472 if (name != NULL) printf("%s", name);
2473 else printf("%ld", (long int)(gidlist[i]));
2481 if (!no_labels) printf("%s = ", name);
2482 printf("%s\n", readconf_printtime(*((int *)value)));
2488 int *list = (int *)value;
2489 if (!no_labels) printf("%s = ", name);
2490 for (i = 0; i < list[1]; i++)
2491 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2497 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2501 case opt_expand_bool:
2502 sprintf(CS name2, "*expand_%.50s", name);
2503 ol2 = find_option(name2, oltop, last);
2504 if (ol2 != NULL && ol2->value != NULL)
2506 void *value2 = ol2->value;
2507 if (options_block != NULL)
2508 value2 = (void *)((uschar *)options_block + (long int)value2);
2509 s = *((uschar **)value2);
2512 if (!no_labels) printf("%s = ", name);
2513 printf("%s\n", string_printing(s));
2516 /* s == NULL => string not set; fall through */
2522 case opt_bool_verify:
2524 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2531 /*************************************************
2532 * Print value from main configuration *
2533 *************************************************/
2535 /* This function, called as a result of encountering the -bP option,
2536 causes the value of any main configuration variable to be output if the
2537 second argument is NULL. There are some special values:
2539 all print all main configuration options
2540 config_file print the name of the configuration file
2541 (configure_file will still work, for backward
2543 routers print the routers' configurations
2544 transports print the transports' configuration
2545 authenticators print the authenticators' configuration
2546 macros print the macros' configuration
2547 router_list print a list of router names
2548 transport_list print a list of transport names
2549 authenticator_list print a list of authentication mechanism names
2550 macro_list print a list of macro names
2551 +name print a named list item
2552 local_scan print the local_scan options
2553 config print the configuration as it is parsed
2554 environment print the used execution environment
2556 If the second argument is not NULL, it must be one of "router", "transport",
2557 "authenticator" or "macro" in which case the first argument identifies the
2558 driver whose options are to be printed.
2561 name option name if type == NULL; else driver name
2562 type NULL or driver type name, as described above
2563 no_labels avoid the "foo = " at the start of an item
2569 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2571 BOOL names_only = FALSE;
2573 optionlist *ol2 = NULL;
2574 driver_instance *d = NULL;
2585 static uschar *types[] = { US"address", US"domain", US"host",
2587 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2588 &hostlist_anchor, &localpartlist_anchor };
2590 for (i = 0; i < 4; i++)
2592 t = tree_search(*(anchors[i]), name+1);
2597 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2599 printf("%slist %s = %s\n", types[i], name+1,
2600 ((namedlist_block *)(t->data.ptr))->string);
2605 printf("no address, domain, host, or local part list called \"%s\" "
2606 "exists\n", name+1);
2611 if ( Ustrcmp(name, "configure_file") == 0
2612 ||Ustrcmp(name, "config_file") == 0)
2614 printf("%s\n", CS config_main_filename);
2618 if (Ustrcmp(name, "all") == 0)
2620 for (ol = optionlist_config;
2621 ol < optionlist_config + optionlist_config_size; ol++)
2623 if ((ol->type & opt_hidden) == 0)
2624 print_ol(ol, US ol->name, NULL,
2625 optionlist_config, optionlist_config_size,
2631 if (Ustrcmp(name, "local_scan") == 0)
2633 #ifndef LOCAL_SCAN_HAS_OPTIONS
2634 printf("local_scan() options are not supported\n");
2636 for (ol = local_scan_options;
2637 ol < local_scan_options + local_scan_options_count; ol++)
2639 print_ol(ol, US ol->name, NULL, local_scan_options,
2640 local_scan_options_count, no_labels);
2646 if (Ustrcmp(name, "config") == 0)
2648 print_config(admin_user, no_labels);
2652 if (Ustrcmp(name, "routers") == 0)
2657 else if (Ustrcmp(name, "transports") == 0)
2659 type = US"transport";
2663 else if (Ustrcmp(name, "authenticators") == 0)
2665 type = US"authenticator";
2669 else if (Ustrcmp(name, "macros") == 0)
2675 else if (Ustrcmp(name, "router_list") == 0)
2682 else if (Ustrcmp(name, "transport_list") == 0)
2684 type = US"transport";
2689 else if (Ustrcmp(name, "authenticator_list") == 0)
2691 type = US"authenticator";
2696 else if (Ustrcmp(name, "macro_list") == 0)
2703 else if (Ustrcmp(name, "environment") == 0)
2708 for (p = USS environ; *p; p++) ;
2709 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2711 for (p = USS environ; *p; p++)
2714 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2723 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2724 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2729 /* Handle the options for a router or transport. Skip options that are flagged
2730 as hidden. Some of these are options with names starting with '*', used for
2731 internal alternative representations of other options (which the printing
2732 function will sort out). Others are synonyms kept for backward compatibility.
2735 if (Ustrcmp(type, "router") == 0)
2737 d = (driver_instance *)routers;
2738 ol2 = optionlist_routers;
2739 size = optionlist_routers_size;
2741 else if (Ustrcmp(type, "transport") == 0)
2743 d = (driver_instance *)transports;
2744 ol2 = optionlist_transports;
2745 size = optionlist_transports_size;
2747 else if (Ustrcmp(type, "authenticator") == 0)
2749 d = (driver_instance *)auths;
2750 ol2 = optionlist_auths;
2751 size = optionlist_auths_size;
2754 else if (Ustrcmp(type, "macro") == 0)
2756 /* People store passwords in macros and they were previously not available
2757 for printing. So we have an admin_users restriction. */
2760 fprintf(stderr, "exim: permission denied\n");
2763 for (m = macros; m != NULL; m = m->next)
2765 if (name == NULL || Ustrcmp(name, m->name) == 0)
2768 printf("%s\n", CS m->name);
2770 printf("%s=%s\n", CS m->name, CS m->replacement);
2776 printf("%s %s not found\n", type, name);
2782 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2786 /* Either search for a given driver, or print all of them */
2788 for (; d != NULL; d = d->next)
2791 printf("\n%s %s:\n", d->name, type);
2792 else if (Ustrcmp(d->name, name) != 0) continue;
2794 for (ol = ol2; ol < ol2 + size; ol++)
2796 if ((ol->type & opt_hidden) == 0)
2797 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2800 for (ol = d->info->options;
2801 ol < d->info->options + *(d->info->options_count); ol++)
2803 if ((ol->type & opt_hidden) == 0)
2804 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2806 if (name != NULL) return;
2808 if (name != NULL) printf("%s %s not found\n", type, name);
2813 /*************************************************
2814 * Read a named list item *
2815 *************************************************/
2817 /* This function reads a name and a list (i.e. string). The name is used to
2818 save the list in a tree, sorted by its name. Each entry also has a number,
2819 which can be used for caching tests, but if the string contains any expansion
2820 items other than $key, the number is set negative to inhibit caching. This
2821 mechanism is used for domain, host, and address lists that are referenced by
2825 anchorp points to the tree anchor
2826 numberp points to the current number for this tree
2827 max the maximum number permitted
2828 s the text of the option line, starting immediately after the name
2830 tname the name of the list type, for messages
2836 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2839 BOOL forcecache = FALSE;
2842 namedlist_block *nb = store_get(sizeof(namedlist_block));
2844 if (Ustrncmp(s, "_cache", 6) == 0)
2851 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2853 if (*numberp >= max)
2854 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2857 while (isspace(*s)) s++;
2859 while (isalnum(*s) || *s == '_') s++;
2860 t = store_get(sizeof(tree_node) + s-ss);
2861 Ustrncpy(t->name, ss, s-ss);
2863 while (isspace(*s)) s++;
2865 if (!tree_insertnode(anchorp, t))
2866 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2867 "duplicate name \"%s\" for a named %s", t->name, tname);
2870 nb->number = *numberp;
2873 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2874 "missing '=' after \"%s\"", t->name);
2875 while (isspace(*s)) s++;
2876 nb->string = read_string(s, t->name);
2877 nb->cache_data = NULL;
2879 /* Check the string for any expansions; if any are found, mark this list
2880 uncacheable unless the user has explicited forced caching. */
2882 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2888 /*************************************************
2889 * Unpick data for a rate limit *
2890 *************************************************/
2892 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2896 s string, in the form t,b,f,l
2897 where t is the threshold (integer)
2898 b is the initial delay (time)
2899 f is the multiplicative factor (fixed point)
2900 k is the maximum time (time)
2901 threshold where to store threshold
2902 base where to store base in milliseconds
2903 factor where to store factor in milliseconds
2904 limit where to store limit
2906 Returns: nothing (panics on error)
2910 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2913 uschar bstring[16], lstring[16];
2915 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2916 factor, lstring) == 4)
2918 *base = readconf_readtime(bstring, 0, TRUE);
2919 *limit = readconf_readtime(lstring, 0, TRUE);
2920 if (*base >= 0 && *limit >= 0) return;
2922 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2928 /*************************************************
2929 * Drop privs for checking TLS config *
2930 *************************************************/
2932 /* We want to validate TLS options during readconf, but do not want to be
2933 root when we call into the TLS library, in case of library linkage errors
2934 which cause segfaults; before this check, those were always done as the Exim
2935 runtime user and it makes sense to continue with that.
2937 Assumes: tls_require_ciphers has been set, if it will be
2938 exim_user has been set, if it will be
2939 exim_group has been set, if it will be
2941 Returns: bool for "okay"; false will cause caller to immediately exit.
2946 tls_dropprivs_validate_require_cipher(BOOL nowarn)
2948 const uschar *errmsg;
2951 void (*oldsignal)(int);
2953 /* If TLS will never be used, no point checking ciphers */
2955 if ( !tls_advertise_hosts
2956 || !*tls_advertise_hosts
2957 || Ustrcmp(tls_advertise_hosts, ":") == 0
2960 else if (!nowarn && !tls_certificate)
2961 log_write(0, LOG_MAIN,
2962 "Warning: No server certificate defined; will use a selfsigned one.\n"
2963 " Suggested action: either install a certificate or change tls_advertise_hosts option");
2965 oldsignal = signal(SIGCHLD, SIG_DFL);
2968 if ((pid = fork()) < 0)
2969 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2973 /* in some modes, will have dropped privilege already */
2975 exim_setugid(exim_uid, exim_gid, FALSE,
2976 US"calling tls_validate_require_cipher");
2978 errmsg = tls_validate_require_cipher();
2981 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2982 "tls_require_ciphers invalid: %s", errmsg);
2989 rc = waitpid(pid, &status, 0);
2990 } while (rc < 0 && errno == EINTR);
2993 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2996 signal(SIGCHLD, oldsignal);
3000 #endif /* SUPPORT_TLS */
3005 /*************************************************
3006 * Read main configuration options *
3007 *************************************************/
3009 /* This function is the first to be called for configuration reading. It
3010 opens the configuration file and reads general configuration settings until
3011 it reaches the end of the configuration section. The file is then left open so
3012 that the remaining configuration data can subsequently be read if needed for
3015 The configuration file must be owned either by root or exim, and be writeable
3016 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3017 in the config file, so the test is done on the compiled in values. A slight
3018 anomaly, to be carefully documented.
3020 The name of the configuration file is taken from a list that is included in the
3021 binary of Exim. It can be altered from the command line, but if that is done,
3022 root privilege is immediately withdrawn unless the caller is root or exim.
3023 The first file on the list that exists is used.
3025 For use on multiple systems that share file systems, first look for a
3026 configuration file whose name has the current node name on the end. If that is
3027 not found, try the generic name. For really contorted configurations, that run
3028 multiple Exims with different uid settings, first try adding the effective uid
3029 before the node name. These complications are going to waste resources on most
3030 systems. Therefore they are available only when requested by compile-time
3034 readconf_main(BOOL nowarn)
3037 struct stat statbuf;
3038 uschar *s, *filename;
3039 const uschar *list = config_main_filelist;
3041 /* Loop through the possible file names */
3043 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
3047 /* Cut out all the fancy processing unless specifically wanted */
3049 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3050 uschar *suffix = filename + Ustrlen(filename);
3052 /* Try for the node-specific file if a node name exists */
3054 #ifdef CONFIGURE_FILE_USE_NODE
3056 if (uname(&uts) >= 0)
3058 #ifdef CONFIGURE_FILE_USE_EUID
3059 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3060 config_file = Ufopen(filename, "rb");
3061 if (config_file == NULL)
3062 #endif /* CONFIGURE_FILE_USE_EUID */
3064 sprintf(CS suffix, ".%.256s", uts.nodename);
3065 config_file = Ufopen(filename, "rb");
3068 #endif /* CONFIGURE_FILE_USE_NODE */
3070 /* Otherwise, try the generic name, possibly with the euid added */
3072 #ifdef CONFIGURE_FILE_USE_EUID
3073 if (config_file == NULL)
3075 sprintf(CS suffix, ".%ld", (long int)original_euid);
3076 config_file = Ufopen(filename, "rb");
3078 #endif /* CONFIGURE_FILE_USE_EUID */
3080 /* Finally, try the unadorned name */
3082 if (config_file == NULL)
3085 config_file = Ufopen(filename, "rb");
3087 #else /* if neither defined */
3089 /* This is the common case when the fancy processing is not included. */
3091 config_file = Ufopen(filename, "rb");
3094 /* If the file does not exist, continue to try any others. For any other
3095 error, break out (and die). */
3097 if (config_file != NULL || errno != ENOENT) break;
3100 /* Now, once we found and opened our configuration file, we change the directory
3101 to a safe place. Later we change to $spool_directory. */
3103 if (Uchdir("/") < 0)
3105 perror("exim: chdir `/': ");
3109 /* On success, save the name for verification; config_filename is used when
3110 logging configuration errors (it changes for .included files) whereas
3111 config_main_filename is the name shown by -bP. Failure to open a configuration
3112 file is a serious disaster. */
3114 if (config_file != NULL)
3117 config_filename = config_main_filename = string_copy(filename);
3119 p = Ustrrchr(filename, '/');
3120 config_main_directory = p ? string_copyn(filename, p - filename)
3121 : string_copy(US".");
3125 if (filename == NULL)
3126 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3127 "%s", config_main_filelist);
3129 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3130 "configuration file %s", filename));
3133 /* Check the status of the file we have opened, if we have retained root
3134 privileges and the file isn't /dev/null (which *should* be 0666). */
3136 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3138 if (fstat(fileno(config_file), &statbuf) != 0)
3139 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3142 if ((statbuf.st_uid != root_uid /* owner not root */
3143 #ifdef CONFIGURE_OWNER
3144 && statbuf.st_uid != config_uid /* owner not the special one */
3147 (statbuf.st_gid != root_gid /* group not root & */
3148 #ifdef CONFIGURE_GROUP
3149 && statbuf.st_gid != config_gid /* group not the special one */
3151 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3153 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3155 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3156 "wrong owner, group, or mode", big_buffer);
3159 /* Process the main configuration settings. They all begin with a lower case
3160 letter. If we see something starting with an upper case letter, it is taken as
3161 a macro definition. */
3163 while ((s = get_config_line()) != NULL)
3165 if (isupper(s[0])) read_macro_assignment(s);
3167 else if (Ustrncmp(s, "domainlist", 10) == 0)
3168 read_named_list(&domainlist_anchor, &domainlist_count,
3169 MAX_NAMED_LIST, s+10, US"domain list");
3171 else if (Ustrncmp(s, "hostlist", 8) == 0)
3172 read_named_list(&hostlist_anchor, &hostlist_count,
3173 MAX_NAMED_LIST, s+8, US"host list");
3175 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3176 read_named_list(&addresslist_anchor, &addresslist_count,
3177 MAX_NAMED_LIST, s+11, US"address list");
3179 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3180 read_named_list(&localpartlist_anchor, &localpartlist_count,
3181 MAX_NAMED_LIST, s+13, US"local part list");
3184 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3185 NULL, US"main option \"%s\" unknown");
3189 /* If local_sender_retain is set, local_from_check must be unset. */
3191 if (local_sender_retain && local_from_check)
3192 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3193 "local_sender_retain are set; this combination is not allowed");
3195 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3198 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3200 /* The max retry interval must not be greater than 24 hours. */
3202 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3204 /* remote_max_parallel must be > 0 */
3206 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3208 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3209 start of a new SMTP message. */
3211 freeze_tell_config = freeze_tell;
3213 /* The primary host name may be required for expansion of spool_directory
3214 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3215 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3216 canonize it. Some people like upper case letters in their host names, so we
3217 don't force the case. */
3219 if (primary_hostname == NULL)
3221 const uschar *hostname;
3223 if (uname(&uts) < 0)
3224 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3225 hostname = US uts.nodename;
3227 if (Ustrchr(hostname, '.') == NULL)
3230 struct hostent *hostdata;
3233 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3234 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3235 MCL_DOMAIN, TRUE, NULL) != OK))
3244 #if HAVE_GETIPNODEBYNAME
3246 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3248 hostdata = gethostbyname2(CS hostname, af);
3251 hostdata = gethostbyname(CS hostname);
3254 if (hostdata != NULL)
3256 hostname = US hostdata->h_name;
3260 if (af == AF_INET) break;
3265 primary_hostname = string_copy(hostname);
3268 /* Set up default value for smtp_active_hostname */
3270 smtp_active_hostname = primary_hostname;
3272 /* If spool_directory wasn't set in the build-time configuration, it must have
3273 got set above. Of course, writing to the log may not work if log_file_path is
3274 not set, but it will at least get to syslog or somewhere, with any luck. */
3276 if (*spool_directory == 0)
3277 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3280 /* Expand the spool directory name; it may, for example, contain the primary
3281 host name. Same comment about failure. */
3283 s = expand_string(spool_directory);
3285 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3286 "\"%s\": %s", spool_directory, expand_string_message);
3287 spool_directory = s;
3289 /* Expand log_file_path, which must contain "%s" in any component that isn't
3290 the null string or "syslog". It is also allowed to contain one instance of %D
3291 or %M. However, it must NOT contain % followed by anything else. */
3293 if (*log_file_path != 0)
3295 const uschar *ss, *sss;
3296 int sep = ':'; /* Fixed for log file path */
3297 s = expand_string(log_file_path);
3299 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3300 "\"%s\": %s", log_file_path, expand_string_message);
3303 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3306 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3307 t = Ustrstr(sss, "%s");
3309 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3310 "contain \"%%s\"", sss);
3312 t = Ustrchr(sss, '%');
3315 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3316 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3317 "unexpected \"%%\" character", s);
3324 /* Interpret syslog_facility into an integer argument for 'ident' param to
3325 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3328 if (syslog_facility_str != NULL)
3331 uschar *s = syslog_facility_str;
3333 if ((Ustrlen(syslog_facility_str) >= 4) &&
3334 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3337 for (i = 0; i < syslog_list_size; i++)
3339 if (strcmpic(s, syslog_list[i].name) == 0)
3341 syslog_facility = syslog_list[i].value;
3346 if (i >= syslog_list_size)
3348 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3349 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3353 /* Expand pid_file_path */
3355 if (*pid_file_path != 0)
3357 s = expand_string(pid_file_path);
3359 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3360 "\"%s\": %s", pid_file_path, expand_string_message);
3364 /* Set default value of process_log_path */
3366 if (process_log_path == NULL || *process_log_path =='\0')
3367 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3369 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3372 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3374 /* Unpick the SMTP rate limiting options, if set */
3376 if (smtp_ratelimit_mail != NULL)
3378 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3379 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3382 if (smtp_ratelimit_rcpt != NULL)
3384 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3385 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3388 /* The qualify domains default to the primary host name */
3390 if (qualify_domain_sender == NULL)
3391 qualify_domain_sender = primary_hostname;
3392 if (qualify_domain_recipient == NULL)
3393 qualify_domain_recipient = qualify_domain_sender;
3395 /* Setting system_filter_user in the configuration sets the gid as well if a
3396 name is given, but a numerical value does not. */
3398 if (system_filter_uid_set && !system_filter_gid_set)
3400 struct passwd *pw = getpwuid(system_filter_uid);
3402 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3403 (long int)system_filter_uid);
3404 system_filter_gid = pw->pw_gid;
3405 system_filter_gid_set = TRUE;
3408 /* If the errors_reply_to field is set, check that it is syntactically valid
3409 and ensure it contains a domain. */
3411 if (errors_reply_to != NULL)
3414 int start, end, domain;
3415 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3416 &start, &end, &domain, FALSE);
3418 if (recipient == NULL)
3419 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3420 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3423 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3424 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3427 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3428 smtp_accept_max must also be set. */
3430 if (smtp_accept_max == 0 &&
3431 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3432 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3433 "smtp_accept_max must be set if smtp_accept_queue or "
3434 "smtp_accept_max_per_host is set");
3436 /* Set up the host number if anything is specified. It is an expanded string
3437 so that it can be computed from the host name, for example. We do this last
3438 so as to ensure that everything else is set up before the expansion. */
3440 if (host_number_string != NULL)
3444 uschar *s = expand_string(host_number_string);
3446 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3447 "failed to expand localhost_number \"%s\": %s",
3448 host_number_string, expand_string_message);
3449 n = Ustrtol(s, &end, 0);
3450 while (isspace(*end)) end++;
3452 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3453 "localhost_number value is not a number: %s", s);
3454 if (n > LOCALHOST_MAX)
3455 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3456 "localhost_number is greater than the maximum allowed value (%d)",
3462 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3464 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3465 tls_verify_certificates == NULL)
3466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3467 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3468 (tls_verify_hosts != NULL)? "" : "try_");
3470 /* This also checks that the library linkage is working and we can call
3471 routines in it, so call even if tls_require_ciphers is unset */
3472 if (!tls_dropprivs_validate_require_cipher(nowarn))
3475 /* Magic number: at time of writing, 1024 has been the long-standing value
3476 used by so many clients, and what Exim used to use always, that it makes
3477 sense to just min-clamp this max-clamp at that. */
3478 if (tls_dh_max_bits < 1024)
3479 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3480 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3482 /* If openssl_options is set, validate it */
3483 if (openssl_options != NULL)
3486 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3487 "openssl_options is set but we're using GnuTLS");
3490 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3491 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3492 "openssl_options parse error: %s", openssl_options);
3495 #endif /*SUPPORT_TLS*/
3497 if (!nowarn && !keep_environment && environ && *environ)
3498 log_write(0, LOG_MAIN,
3499 "Warning: purging the environment.\n"
3500 " Suggested action: use keep_environment.");
3505 /*************************************************
3506 * Initialize one driver *
3507 *************************************************/
3509 /* This is called once the driver's generic options, if any, have been read.
3510 We can now find the driver, set up defaults for the private options, and
3511 unset any "set" bits in the private options table (which might have been
3512 set by another incarnation of the same driver).
3515 d pointer to driver instance block, with generic
3517 drivers_available vector of available drivers
3518 size_of_info size of each block in drivers_available
3519 class class of driver, for error message
3521 Returns: pointer to the driver info block
3524 static driver_info *
3525 init_driver(driver_instance *d, driver_info *drivers_available,
3526 int size_of_info, uschar *class)
3530 for (dd = drivers_available; dd->driver_name[0] != 0;
3531 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3533 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3536 int len = dd->options_len;
3538 d->options_block = store_get(len);
3539 memcpy(d->options_block, dd->options_block, len);
3540 for (i = 0; i < *(dd->options_count); i++)
3541 dd->options[i].type &= ~opt_set;
3546 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3547 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3549 return NULL; /* never obeyed */
3555 /*************************************************
3556 * Initialize driver list *
3557 *************************************************/
3559 /* This function is called for routers, transports, and authentication
3560 mechanisms. It reads the data from the current point in the configuration file
3561 up to the end of the section, and sets up a chain of instance blocks according
3562 to the file's contents. The file will already have been opened by a call to
3563 readconf_main, and must be left open for subsequent reading of further data.
3565 Any errors cause a panic crash. Note that the blocks with names driver_info and
3566 driver_instance must map the first portions of all the _info and _instance
3567 blocks for this shared code to work.
3570 class "router", "transport", or "authenticator"
3571 anchor &routers, &transports, &auths
3572 drivers_available available drivers
3573 size_of_info size of each info block
3574 instance_default points to default data for an instance
3575 instance_size size of instance block
3576 driver_optionlist generic option list
3577 driver_optionlist_count count of generic option list
3583 readconf_driver_init(
3585 driver_instance **anchor,
3586 driver_info *drivers_available,
3588 void *instance_default,
3590 optionlist *driver_optionlist,
3591 int driver_optionlist_count)
3593 driver_instance **p = anchor;
3594 driver_instance *d = NULL;
3597 while ((buffer = get_config_line()) != NULL)
3602 /* Read the first name on the line and test for the start of a new driver. A
3603 macro definition indicates the end of the previous driver. If this isn't the
3604 start of a new driver, the line will be re-read. */
3606 s = readconf_readname(name, sizeof(name), buffer);
3608 /* Handle macro definition, first finishing off the initialization of the
3609 previous driver, if any. */
3611 if (isupper(*name) && *s == '=')
3615 if (!d->driver_name)
3616 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3617 "no driver defined for %s \"%s\"", class, d->name);
3621 read_macro_assignment(buffer);
3625 /* If the line starts with a name terminated by a colon, we are at the
3626 start of the definition of a new driver. The rest of the line must be
3633 /* Finish off initializing the previous driver. */
3637 if (!d->driver_name)
3638 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3639 "no driver defined for %s \"%s\"", class, d->name);
3643 /* Check that we haven't already got a driver of this name */
3645 for (d = *anchor; d; d = d->next)
3646 if (Ustrcmp(name, d->name) == 0)
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3648 "there are two %ss called \"%s\"", class, name);
3650 /* Set up a new driver instance data block on the chain, with
3651 its default values installed. */
3653 d = store_get(instance_size);
3654 memcpy(d, instance_default, instance_size);
3657 d->name = string_copy(name);
3659 /* Clear out the "set" bits in the generic options */
3661 for (i = 0; i < driver_optionlist_count; i++)
3662 driver_optionlist[i].type &= ~opt_set;
3664 /* Check nothing more on this line, then do the next loop iteration. */
3666 while (isspace(*s)) s++;
3667 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3671 /* Not the start of a new driver. Give an error if we have not set up a
3672 current driver yet. */
3675 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3677 /* First look to see if this is a generic option; if it is "driver",
3678 initialize the driver. If is it not a generic option, we can look for a
3679 private option provided that the driver has been previously set up. */
3681 if (readconf_handle_option(buffer, driver_optionlist,
3682 driver_optionlist_count, d, NULL))
3684 if (!d->info && d->driver_name)
3685 init_driver(d, drivers_available, size_of_info, class);
3688 /* Handle private options - pass the generic block because some may
3689 live therein. A flag with each option indicates if it is in the public
3693 readconf_handle_option(buffer, d->info->options,
3694 *(d->info->options_count), d, US"option \"%s\" unknown");
3696 /* The option is not generic and the driver name has not yet been given. */
3698 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3699 "(\"driver\" must be specified before any private options)", name);
3702 /* Run the initialization function for the final driver. */
3706 if (!d->driver_name)
3707 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3708 "no driver defined for %s \"%s\"", class, d->name);
3715 /*************************************************
3716 * Check driver dependency *
3717 *************************************************/
3719 /* This function is passed a driver instance and a string. It checks whether
3720 any of the string options for the driver contains the given string as an
3724 d points to a driver instance block
3725 s the string to search for
3727 Returns: TRUE if a dependency is found
3731 readconf_depends(driver_instance *d, uschar *s)
3733 int count = *(d->info->options_count);
3737 for (ol = d->info->options; ol < d->info->options + count; ol++)
3739 void *options_block;
3741 int type = ol->type & opt_mask;
3742 if (type != opt_stringptr) continue;
3743 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3744 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3745 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3747 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3748 isalnum(ss[Ustrlen(s)])) continue;
3749 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3750 d->name, ol->name, s);
3755 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3762 /*************************************************
3763 * Decode an error type for retries *
3764 *************************************************/
3766 /* This function is global because it is also called from the main
3767 program when testing retry information. It decodes strings such as "quota_7d"
3768 into numerical error codes.
3771 pp points to start of text
3772 p points past end of text
3773 basic_errno points to an int to receive the main error number
3774 more_errno points to an int to receive the secondary error data
3776 Returns: NULL if decoded correctly; else points to error text
3780 readconf_retry_error(const uschar *pp, const uschar *p,
3781 int *basic_errno, int *more_errno)
3784 const uschar *q = pp;
3785 while (q < p && *q != '_') q++;
3788 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3790 *basic_errno = ERRNO_EXIMQUOTA;
3791 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3792 return US"bad time value";
3795 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3797 *basic_errno = ECONNREFUSED;
3800 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3801 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3802 else return US"A or MX expected after \"refused\"";
3806 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3808 *basic_errno = ETIMEDOUT;
3812 int xlen = p - q - 1;
3813 const uschar *x = q + 1;
3815 static uschar *extras[] =
3816 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3817 static int values[] =
3818 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3820 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3821 if (strncmpic(x, extras[i], xlen) == 0)
3823 *more_errno = values[i];
3827 if (i >= sizeof(extras)/sizeof(uschar *))
3828 if (strncmpic(x, US"DNS", xlen) == 0)
3829 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3830 "available in retry rules (it has never worked) - treated as "
3833 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3837 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3838 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3839 strncmpic(pp, US"data_4", 6) == 0)
3842 int x = 255; /* means "any 4xx code" */
3843 if (p != pp + 8) bad = TRUE; else
3845 int a = pp[6], b = pp[7];
3849 if (isdigit(b)) x += b - '0';
3850 else if (b == 'x') x += 100;
3853 else if (a != 'x' || b != 'x') bad = TRUE;
3857 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3858 "x is literal and d is any digit", pp);
3860 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3861 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3862 *more_errno = x << 8;
3865 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3866 strncmpic(q+1, US"failed", p-q-1) == 0)
3867 *basic_errno = ERRNO_AUTHFAIL;
3869 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3870 *basic_errno = ERRNO_SMTPCLOSED;
3872 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3873 *basic_errno = ERRNO_TLSREQUIRED;
3875 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3876 *basic_errno = ERRNO_UNKNOWNHOST;
3878 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3879 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3887 /*************************************************
3888 * Read retry information *
3889 *************************************************/
3891 /* Each line of retry information contains:
3893 . A domain name pattern or an address pattern;
3895 . An error name, possibly with additional data, or *;
3897 . An optional sequence of retry items, each consisting of an identifying
3898 letter, a cutoff time, and optional parameters.
3900 All this is decoded and placed into a control block. */
3903 /* Subroutine to read an argument, preceded by a comma and terminated
3904 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3905 1 = fixed point number (returned *1000).
3908 paddr pointer to pointer to current character; updated
3909 type 0 => read a time; 1 => read a fixed point number
3911 Returns: time in seconds or fixed point number * 1000
3915 retry_arg(const uschar **paddr, int type)
3917 const uschar *p = *paddr;
3920 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3922 while (isspace(*p)) p++;
3924 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3926 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3927 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3932 case 0: return readconf_readtime(pp, *p, FALSE);
3933 case 1: return readconf_readfixed(pp, *p);
3935 return 0; /* Keep picky compilers happy */
3938 /* The function proper */
3941 readconf_retries(void)
3943 retry_config **chain = &retries;
3947 while ((p = get_config_line()))
3949 retry_rule **rchain;
3953 next = store_get(sizeof(retry_config));
3956 chain = &(next->next);
3957 next->basic_errno = next->more_errno = 0;
3958 next->senders = NULL;
3960 rchain = &(next->rules);
3962 next->pattern = string_dequote(&p);
3963 while (isspace(*p)) p++;
3965 while (mac_isgraph(*p)) p++;
3966 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3967 "missing error type in retry rule");
3969 /* Test error names for things we understand. */
3971 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
3972 &next->more_errno)))
3973 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3975 /* There may be an optional address list of senders to be used as another
3976 constraint on the rule. This was added later, so the syntax is a bit of a
3977 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3980 while (isspace(*p)) p++;
3981 if (Ustrncmp(p, "senders", 7) == 0)
3984 while (isspace(*p)) p++;
3985 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3986 "\"=\" expected after \"senders\" in retry rule");
3987 while (isspace(*p)) p++;
3988 next->senders = string_dequote(&p);
3991 /* Now the retry rules. Keep the maximum timeout encountered. */
3993 while (isspace(*p)) p++;
3997 retry_rule *rule = store_get(sizeof(retry_rule));
3999 rchain = &(rule->next);
4001 rule->rule = toupper(*p++);
4002 rule->timeout = retry_arg(&p, 0);
4003 if (rule->timeout > retry_maximum_timeout)
4004 retry_maximum_timeout = rule->timeout;
4008 case 'F': /* Fixed interval */
4009 rule->p1 = retry_arg(&p, 0);
4012 case 'G': /* Geometrically increasing intervals */
4013 case 'H': /* Ditto, but with randomness */
4014 rule->p1 = retry_arg(&p, 0);
4015 rule->p2 = retry_arg(&p, 1);
4019 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4023 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4024 (rule->rule != 'F' && rule->p2 < 1000))
4025 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4026 "bad parameters for retry rule");
4028 while (isspace(*p)) p++;
4032 while (isspace(*p)) p++;
4035 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4042 /*************************************************
4043 * Initialize authenticators *
4044 *************************************************/
4046 /* Read the authenticators section of the configuration file.
4055 auth_instance *au, *bu;
4056 readconf_driver_init(US"authenticator",
4057 (driver_instance **)(&auths), /* chain anchor */
4058 (driver_info *)auths_available, /* available drivers */
4059 sizeof(auth_info), /* size of info block */
4060 &auth_defaults, /* default values for generic options */
4061 sizeof(auth_instance), /* size of instance block */
4062 optionlist_auths, /* generic options */
4063 optionlist_auths_size);
4065 for (au = auths; au; au = au->next)
4067 if (!au->public_name)
4068 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4069 "the %s authenticator", au->name);
4071 for (bu = au->next; bu; bu = bu->next)
4072 if (strcmpic(au->public_name, bu->public_name) == 0)
4073 if ((au->client && bu->client) || (au->server && bu->server))
4074 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4075 "(%s and %s) have the same public name (%s)",
4076 au->client ? US"client" : US"server", au->name, bu->name,
4084 /*************************************************
4085 * Read ACL information *
4086 *************************************************/
4088 /* If this run of Exim is not doing something that involves receiving a
4089 message, we can just skip over the ACL information. No need to parse it.
4091 First, we have a function for acl_read() to call back to get the next line. We
4092 need to remember the line we passed, because at the end it will contain the
4093 name of the next ACL. */
4095 static uschar *acl_line;
4100 acl_line = get_config_line();
4105 /* Now the main function:
4116 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4119 acl_line = get_config_line();
4121 while(acl_line != NULL)
4127 p = readconf_readname(name, sizeof(name), acl_line);
4128 if (isupper(*name) && *p == '=')
4130 read_macro_assignment(acl_line);
4131 acl_line = get_config_line();
4135 if (*p != ':' || name[0] == 0)
4136 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4138 node = store_get(sizeof(tree_node) + Ustrlen(name));
4139 Ustrcpy(node->name, name);
4140 if (!tree_insertnode(&acl_anchor, node))
4141 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4142 "there are two ACLs called \"%s\"", name);
4144 node->data.ptr = acl_read(acl_callback, &error);
4146 if (node->data.ptr == NULL && error != NULL)
4147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4153 /*************************************************
4154 * Read configuration for local_scan() *
4155 *************************************************/
4157 /* This function is called after "begin local_scan" is encountered in the
4158 configuration file. If the local_scan() function allows for configuration
4159 options, we can process them. Otherwise, we expire in a panic.
4166 local_scan_init(void)
4168 #ifndef LOCAL_SCAN_HAS_OPTIONS
4169 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4170 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4174 while ((p = get_config_line()) != NULL)
4176 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4177 NULL, US"local_scan option \"%s\" unknown");
4184 /*************************************************
4185 * Read rest of configuration (after main) *
4186 *************************************************/
4188 /* This function reads the rest of the runtime configuration, after the main
4189 configuration. It is called only when actually needed. Each subsequent section
4190 of the configuration starts with a line of the form
4194 where the name is "routers", "transports", etc. A section is terminated by
4195 hitting the next "begin" line, and the next name is left in next_section.
4196 Because it may confuse people as to whether the names are singular or plural,
4197 we add "s" if it's missing. There is always enough room in next_section for
4198 this. This function is basically just a switch.
4204 static uschar *section_list[] = {
4218 while(next_section[0] != 0)
4222 int last = sizeof(section_list) / sizeof(uschar *);
4224 int n = Ustrlen(next_section);
4226 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4230 int c = strcmpic(next_section, section_list[mid]);
4232 if (c > 0) first = mid + 1; else last = mid;
4234 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4235 "\"%.*s\" is not a known configuration section name", n, next_section);
4236 mid = (last + first)/2;
4240 if (((had ^= bit) & bit) == 0)
4241 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4242 "\"%.*s\" section is repeated in the configuration file", n,
4247 case 0: readconf_acl(); break;
4248 case 1: auths_init(); break;
4249 case 2: local_scan_init(); break;
4250 case 3: readconf_retries(); break;
4251 case 4: readconf_rewrites(); break;
4252 case 5: route_init(); break;
4253 case 6: transport_init(); break;
4257 (void)fclose(config_file);
4260 /* Init the storage for the pre-parsed config lines */
4262 readconf_save_config(const uschar *s)
4264 save_config_line(string_sprintf("# Exim Configuration (%s)",
4265 running_in_test_harness ? US"X" : s));
4269 save_config_position(const uschar *file, int line)
4271 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4274 /* Append a pre-parsed logical line to the config lines store,
4275 this operates on a global (static) list that holds all the pre-parsed
4276 config lines, we do no further processing here, output formatting and
4277 honouring of <hide> or macros will be done during output */
4279 save_config_line(const uschar* line)
4281 static config_line_item *current;
4282 config_line_item *next;
4284 next = (config_line_item*) store_get(sizeof(config_line_item));
4285 next->line = string_copy(line);
4288 if (!config_lines) config_lines = next;
4289 else current->next = next;
4294 /* List the parsed config lines, care about nice formatting and
4295 hide the <hide> values unless we're the admin user */
4297 print_config(BOOL admin, BOOL terse)
4299 config_line_item *i;
4300 const int TS = terse ? 0 : 2;
4303 for (i = config_lines; i; i = i->next)
4308 /* skip over to the first non-space */
4309 for (current = i->line; *current && isspace(*current); ++current)
4312 if (*current == '\0')
4315 /* Collapse runs of spaces. We stop this if we encounter one of the
4316 * following characters: "'$, as this may indicate careful formatting */
4317 for (p = current; *p; ++p)
4320 if (!isspace(*p)) continue;
4321 if (*p != ' ') *p = ' ';
4323 for (next = p; isspace(*next); ++next)
4327 memmove(p+1, next, Ustrlen(next)+1);
4329 if (*next == '"' || *next == '\'' || *next == '$')
4334 if (current[0] == '#')
4337 /* begin lines are left aligned */
4338 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4340 if (!terse) puts("");
4345 /* router/acl/transport block names */
4346 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4348 if (!terse) puts("");
4349 printf("%*s%s\n", TS, "", current);
4353 /* hidden lines (all MACROS or lines prefixed with "hide") */
4355 && ( isupper(*current)
4356 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4360 if ((p = Ustrchr(current, '=')))
4363 printf("%*s%s= %s\n", indent, "", current, hidden);
4365 /* e.g.: hide split_spool_directory */
4367 printf("%*s\n", indent, hidden);
4371 /* rest is public */
4372 printf("%*s%s\n", indent, "", current);
4378 /* End of readconf.c */