1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
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 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str);
15 static void save_config_line(const uschar* line);
16 static void save_config_position(const uschar *file, int line);
17 static void print_config(BOOL admin);
19 #define CSTATE_STACK_SIZE 10
22 /* Structure for chain (stack) of .included files */
24 typedef struct config_file_item {
25 struct config_file_item *next;
31 /* Structure for chain of configuration lines (-bP config) */
33 typedef struct config_line_item {
34 struct config_line_item *next;
38 static config_line_item* config_lines;
40 /* Structure of table of conditional words and their state transitions */
42 typedef struct cond_item {
50 /* Structure of table of syslog facility names and values */
52 typedef struct syslog_fac_item {
58 static const char * const hidden = "<value not displayable>";
60 /* Static variables */
62 static config_file_item *config_file_stack = NULL; /* For includes */
64 static uschar *syslog_facility_str = NULL;
65 static uschar next_section[24];
66 static uschar time_buffer[24];
68 /* State variables for conditional loading (.ifdef / .else / .endif) */
70 static int cstate = 0;
71 static int cstate_stack_ptr = -1;
72 static int cstate_stack[CSTATE_STACK_SIZE];
74 /* Table of state transitions for handling conditional inclusions. There are
75 four possible state transitions:
79 .elifdef true (or .else)
82 .endif just causes the previous cstate to be popped off the stack */
84 static int next_cstate[3][4] =
86 /* State 0: reading from file, or reading until next .else or .endif */
88 /* State 1: condition failed, skipping until next .else or .endif */
90 /* State 2: skipping until .endif */
94 /* Table of conditionals and the states to set. For each name, there are four
95 values: the length of the name (to save computing it each time), the state to
96 set if a macro was found in the line, the state to set if a macro was not found
97 in the line, and a stack manipulation setting which is:
99 -1 pull state value off the stack
100 0 don't alter the stack
101 +1 push value onto stack, before setting new state
104 static cond_item cond_list[] = {
105 { US"ifdef", 5, 0, 1, 1 },
106 { US"ifndef", 6, 1, 0, 1 },
107 { US"elifdef", 7, 2, 3, 0 },
108 { US"elifndef", 8, 3, 2, 0 },
109 { US"else", 4, 2, 2, 0 },
110 { US"endif", 5, 0, 0, -1 }
113 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
115 /* Table of syslog facility names and their values */
117 static syslog_fac_item syslog_list[] = {
118 { US"mail", LOG_MAIL },
119 { US"user", LOG_USER },
120 { US"news", LOG_NEWS },
121 { US"uucp", LOG_UUCP },
122 { US"local0", LOG_LOCAL0 },
123 { US"local1", LOG_LOCAL1 },
124 { US"local2", LOG_LOCAL2 },
125 { US"local3", LOG_LOCAL3 },
126 { US"local4", LOG_LOCAL4 },
127 { US"local5", LOG_LOCAL5 },
128 { US"local6", LOG_LOCAL6 },
129 { US"local7", LOG_LOCAL7 },
130 { US"daemon", LOG_DAEMON }
133 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
138 /*************************************************
139 * Main configuration options *
140 *************************************************/
142 /* The list of options that can be set in the main configuration file. This
143 must be in alphabetic order because it is searched by binary chop. */
145 static optionlist optionlist_config[] = {
146 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
147 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
148 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
149 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
150 { "accept_8bitmime", opt_bool, &accept_8bitmime },
151 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
152 #ifdef WITH_CONTENT_SCAN
153 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
155 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
156 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
157 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
158 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
160 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
163 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
165 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
166 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
167 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
168 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
169 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
170 #ifdef WITH_CONTENT_SCAN
171 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
173 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
174 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
175 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
176 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
178 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
180 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
181 { "add_environment", opt_stringptr, &add_environment },
182 { "admin_groups", opt_gidlist, &admin_groups },
183 { "allow_domain_literals", opt_bool, &allow_domain_literals },
184 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
185 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
186 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
187 { "auto_thaw", opt_time, &auto_thaw },
188 #ifdef WITH_CONTENT_SCAN
189 { "av_scanner", opt_stringptr, &av_scanner },
191 { "bi_command", opt_stringptr, &bi_command },
192 #ifdef EXPERIMENTAL_BRIGHTMAIL
193 { "bmi_config_file", opt_stringptr, &bmi_config_file },
195 { "bounce_message_file", opt_stringptr, &bounce_message_file },
196 { "bounce_message_text", opt_stringptr, &bounce_message_text },
197 { "bounce_return_body", opt_bool, &bounce_return_body },
198 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
199 { "bounce_return_message", opt_bool, &bounce_return_message },
200 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
201 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
202 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
203 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
204 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
205 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
206 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
207 { "check_log_inodes", opt_int, &check_log_inodes },
208 { "check_log_space", opt_Kint, &check_log_space },
209 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
210 { "check_spool_inodes", opt_int, &check_spool_inodes },
211 { "check_spool_space", opt_Kint, &check_spool_space },
212 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
213 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
214 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
215 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
216 #ifdef EXPERIMENTAL_DCC
217 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
218 { "dccifd_address", opt_stringptr, &dccifd_address },
219 { "dccifd_options", opt_stringptr, &dccifd_options },
221 { "delay_warning", opt_timelist, &delay_warning },
222 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
223 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
224 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
225 { "delivery_date_remove", opt_bool, &delivery_date_remove },
226 #ifdef ENABLE_DISABLE_FSYNC
227 { "disable_fsync", opt_bool, &disable_fsync },
229 { "disable_ipv6", opt_bool, &disable_ipv6 },
231 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
233 #ifdef EXPERIMENTAL_DMARC
234 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
235 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
236 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
238 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
239 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
240 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
241 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
242 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
243 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
244 { "dns_retrans", opt_time, &dns_retrans },
245 { "dns_retry", opt_int, &dns_retry },
246 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
247 { "dns_use_edns0", opt_int, &dns_use_edns0 },
248 /* This option is now a no-op, retained for compability */
249 { "drop_cr", opt_bool, &drop_cr },
250 /*********************************************************/
251 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
252 { "dsn_from", opt_stringptr, &dsn_from },
253 { "envelope_to_remove", opt_bool, &envelope_to_remove },
254 { "errors_copy", opt_stringptr, &errors_copy },
255 { "errors_reply_to", opt_stringptr, &errors_reply_to },
256 #ifndef DISABLE_EVENT
257 { "event_action", opt_stringptr, &event_action },
259 { "exim_group", opt_gid, &exim_gid },
260 { "exim_path", opt_stringptr, &exim_path },
261 { "exim_user", opt_uid, &exim_uid },
262 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
263 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
264 { "finduser_retries", opt_int, &finduser_retries },
265 { "freeze_tell", opt_stringptr, &freeze_tell },
266 { "gecos_name", opt_stringptr, &gecos_name },
267 { "gecos_pattern", opt_stringptr, &gecos_pattern },
269 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
270 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
271 /* These three gnutls_require_* options stopped working in Exim 4.80 */
272 /* From 4.83 we log a warning; a future relase will remove them */
273 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
274 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
275 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
277 { "header_line_maxsize", opt_int, &header_line_maxsize },
278 { "header_maxsize", opt_int, &header_maxsize },
279 { "headers_charset", opt_stringptr, &headers_charset },
280 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
281 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
282 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
283 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
284 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
285 { "hold_domains", opt_stringptr, &hold_domains },
286 { "host_lookup", opt_stringptr, &host_lookup },
287 { "host_lookup_order", opt_stringptr, &host_lookup_order },
288 { "host_reject_connection", opt_stringptr, &host_reject_connection },
289 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
291 { "hosts_proxy", opt_stringptr, &hosts_proxy },
293 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
295 { "ibase_servers", opt_stringptr, &ibase_servers },
297 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
298 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
299 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
300 { "keep_environment", opt_stringptr, &keep_environment },
301 { "keep_malformed", opt_time, &keep_malformed },
303 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
304 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
305 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
306 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
307 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
308 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
309 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
310 { "ldap_start_tls", opt_bool, &eldap_start_tls },
311 { "ldap_version", opt_int, &eldap_version },
313 { "local_from_check", opt_bool, &local_from_check },
314 { "local_from_prefix", opt_stringptr, &local_from_prefix },
315 { "local_from_suffix", opt_stringptr, &local_from_suffix },
316 { "local_interfaces", opt_stringptr, &local_interfaces },
317 { "local_scan_timeout", opt_time, &local_scan_timeout },
318 { "local_sender_retain", opt_bool, &local_sender_retain },
319 { "localhost_number", opt_stringptr, &host_number_string },
320 { "log_file_path", opt_stringptr, &log_file_path },
321 { "log_selector", opt_stringptr, &log_selector_string },
322 { "log_timezone", opt_bool, &log_timezone },
323 { "lookup_open_max", opt_int, &lookup_open_max },
324 { "max_username_length", opt_int, &max_username_length },
325 { "message_body_newlines", opt_bool, &message_body_newlines },
326 { "message_body_visible", opt_mkint, &message_body_visible },
327 { "message_id_header_domain", opt_stringptr, &message_id_domain },
328 { "message_id_header_text", opt_stringptr, &message_id_text },
329 { "message_logs", opt_bool, &message_logs },
330 { "message_size_limit", opt_stringptr, &message_size_limit },
331 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
332 { "move_frozen_messages", opt_bool, &move_frozen_messages },
334 { "mua_wrapper", opt_bool, &mua_wrapper },
336 { "mysql_servers", opt_stringptr, &mysql_servers },
338 { "never_users", opt_uidlist, &never_users },
340 { "openssl_options", opt_stringptr, &openssl_options },
343 { "oracle_servers", opt_stringptr, &oracle_servers },
345 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
347 { "perl_at_start", opt_bool, &opt_perl_at_start },
348 { "perl_startup", opt_stringptr, &opt_perl_startup },
351 { "pgsql_servers", opt_stringptr, &pgsql_servers },
353 { "pid_file_path", opt_stringptr, &pid_file_path },
354 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
356 { "prdr_enable", opt_bool, &prdr_enable },
358 { "preserve_message_logs", opt_bool, &preserve_message_logs },
359 { "primary_hostname", opt_stringptr, &primary_hostname },
360 { "print_topbitchars", opt_bool, &print_topbitchars },
361 { "process_log_path", opt_stringptr, &process_log_path },
362 { "prod_requires_admin", opt_bool, &prod_requires_admin },
363 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
364 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
365 { "queue_domains", opt_stringptr, &queue_domains },
366 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
367 { "queue_only", opt_bool, &queue_only },
368 { "queue_only_file", opt_stringptr, &queue_only_file },
369 { "queue_only_load", opt_fixed, &queue_only_load },
370 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
371 { "queue_only_override", opt_bool, &queue_only_override },
372 { "queue_run_in_order", opt_bool, &queue_run_in_order },
373 { "queue_run_max", opt_int, &queue_run_max },
374 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
375 { "receive_timeout", opt_time, &receive_timeout },
376 { "received_header_text", opt_stringptr, &received_header_text },
377 { "received_headers_max", opt_int, &received_headers_max },
378 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
379 { "recipients_max", opt_int, &recipients_max },
380 { "recipients_max_reject", opt_bool, &recipients_max_reject },
382 { "redis_servers", opt_stringptr, &redis_servers },
384 { "remote_max_parallel", opt_int, &remote_max_parallel },
385 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
386 { "retry_data_expire", opt_time, &retry_data_expire },
387 { "retry_interval_max", opt_time, &retry_interval_max },
388 { "return_path_remove", opt_bool, &return_path_remove },
389 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
390 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
391 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
392 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
393 { "slow_lookup_log", opt_int, &slow_lookup_log },
394 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
395 { "smtp_accept_max", opt_int, &smtp_accept_max },
396 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
397 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
398 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
399 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
400 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
401 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
402 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
403 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
404 { "smtp_banner", opt_stringptr, &smtp_banner },
405 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
406 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
407 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
408 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
409 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
410 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
411 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
412 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
413 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
414 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
415 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
416 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
417 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
418 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
420 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
422 #ifdef WITH_CONTENT_SCAN
423 { "spamd_address", opt_stringptr, &spamd_address },
425 #ifdef EXPERIMENTAL_SPF
426 { "spf_guess", opt_stringptr, &spf_guess },
428 { "split_spool_directory", opt_bool, &split_spool_directory },
429 { "spool_directory", opt_stringptr, &spool_directory },
431 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
433 #ifdef EXPERIMENTAL_SRS
434 { "srs_config", opt_stringptr, &srs_config },
435 { "srs_hashlength", opt_int, &srs_hashlength },
436 { "srs_hashmin", opt_int, &srs_hashmin },
437 { "srs_maxage", opt_int, &srs_maxage },
438 { "srs_secrets", opt_stringptr, &srs_secrets },
439 { "srs_usehash", opt_bool, &srs_usehash },
440 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
442 { "strict_acl_vars", opt_bool, &strict_acl_vars },
443 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
444 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
445 { "syslog_duplication", opt_bool, &syslog_duplication },
446 { "syslog_facility", opt_stringptr, &syslog_facility_str },
447 { "syslog_processname", opt_stringptr, &syslog_processname },
448 { "syslog_timestamp", opt_bool, &syslog_timestamp },
449 { "system_filter", opt_stringptr, &system_filter },
450 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
451 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
452 { "system_filter_group", opt_gid, &system_filter_gid },
453 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
454 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
455 { "system_filter_user", opt_uid, &system_filter_uid },
456 { "tcp_nodelay", opt_bool, &tcp_nodelay },
457 #ifdef USE_TCP_WRAPPERS
458 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
460 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
461 { "timezone", opt_stringptr, &timezone_string },
462 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
464 { "tls_certificate", opt_stringptr, &tls_certificate },
465 { "tls_crl", opt_stringptr, &tls_crl },
466 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
467 { "tls_dhparam", opt_stringptr, &tls_dhparam },
468 { "tls_eccurve", opt_stringptr, &tls_eccurve },
469 # ifndef DISABLE_OCSP
470 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
472 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
473 { "tls_privatekey", opt_stringptr, &tls_privatekey },
474 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
475 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
476 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
477 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
478 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
480 { "trusted_groups", opt_gidlist, &trusted_groups },
481 { "trusted_users", opt_uidlist, &trusted_users },
482 { "unknown_login", opt_stringptr, &unknown_login },
483 { "unknown_username", opt_stringptr, &unknown_username },
484 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
485 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
486 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
487 { "warn_message_file", opt_stringptr, &warn_message_file },
488 { "write_rejectlog", opt_bool, &write_rejectlog }
491 static int optionlist_config_size =
492 sizeof(optionlist_config)/sizeof(optionlist);
496 /*************************************************
497 * Find the name of an option *
498 *************************************************/
500 /* This function is to aid debugging. Various functions take arguments that are
501 pointer variables in the options table or in option tables for various drivers.
502 For debugging output, it is useful to be able to find the name of the option
503 which is currently being processed. This function finds it, if it exists, by
504 searching the table(s).
506 Arguments: a value that is presumed to be in the table above
507 Returns: the option name, or an empty string
511 readconf_find_option(void *p)
515 transport_instance *t;
517 for (i = 0; i < optionlist_config_size; i++)
518 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
520 for (r = routers; r != NULL; r = r->next)
522 router_info *ri = r->info;
523 for (i = 0; i < *ri->options_count; i++)
525 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
526 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
527 return US ri->options[i].name;
531 for (t = transports; t != NULL; t = t->next)
533 transport_info *ti = t->info;
534 for (i = 0; i < *ti->options_count; i++)
536 optionlist * op = &ti->options[i];
537 if ((op->type & opt_mask) != opt_stringptr) continue;
538 if (p == ( op->type & opt_public
540 : (char *)t->options_block
542 + (long int)op->value)
553 /*************************************************
554 * Deal with an assignment to a macro *
555 *************************************************/
557 /* This function is called when a line that starts with an upper case letter is
558 encountered. The argument "line" should contain a complete logical line, and
559 start with the first letter of the macro name. The macro name and the
560 replacement text are extracted and stored. Redefinition of existing,
561 non-command line, macros is permitted using '==' instead of '='.
564 s points to the start of the logical line
570 read_macro_assignment(uschar *s)
576 macro_item *mlast = NULL;
578 while (isalnum(*s) || *s == '_')
580 if (namelen >= sizeof(name) - 1)
581 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
582 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
583 name[namelen++] = *s++;
587 while (isspace(*s)) s++;
589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
596 while (isspace(*s)) s++;
598 /* If an existing macro of the same name was defined on the command line, we
599 just skip this definition. It's an error to attempt to redefine a macro without
600 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
601 It is also an error to define a macro whose name begins with the name of a
602 previously defined macro. Note: it is documented that the other way round
605 for (m = macros; m != NULL; m = m->next)
607 int len = Ustrlen(m->name);
609 if (Ustrcmp(m->name, name) == 0)
611 if (!m->command_line && !redef)
612 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
613 "defined (use \"==\" if you want to redefine it", name);
617 if (len < namelen && Ustrstr(name, m->name) != NULL)
618 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
619 "a macro because previously defined macro \"%s\" is a substring",
622 /* We cannot have this test, because it is documented that a substring
623 macro is permitted (there is even an example).
625 * if (len > namelen && Ustrstr(m->name, name) != NULL)
626 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
627 * "a macro because it is a substring of previously defined macro \"%s\"",
634 /* Check for an overriding command-line definition. */
636 if (m != NULL && m->command_line) return;
638 /* Redefinition must refer to an existing macro. */
643 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
647 /* We have a new definition. The macro_item structure includes a final vector
648 called "name" which is one byte long. Thus, adding "namelen" gives us enough
649 room to store the "name" string. */
653 m = store_get(sizeof(macro_item) + namelen);
654 if (macros == NULL) macros = m; else mlast->next = m;
655 Ustrncpy(m->name, name, namelen);
656 m->name[namelen] = 0;
658 m->command_line = FALSE;
661 /* Set the value of the new or redefined macro */
663 m->replacement = string_copy(s);
670 /*************************************************
671 * Read configuration line *
672 *************************************************/
674 /* A logical line of text is read from the configuration file into the big
675 buffer, taking account of macros, .includes, and continuations. The size of
676 big_buffer is increased if necessary. The count of configuration lines is
677 maintained. Physical input lines starting with # (ignoring leading white space,
678 and after macro replacement) and empty logical lines are always ignored.
679 Leading and trailing spaces are removed.
681 If we hit a line of the form "begin xxxx", the xxxx is placed in the
682 next_section vector, and the function returns NULL, indicating the end of a
683 configuration section. On end-of-file, NULL is returned with next_section
688 Returns: a pointer to the first non-blank in the line,
689 or NULL if eof or end of section is reached
693 get_config_line(void)
695 int startoffset = 0; /* To first non-blank char in logical line */
696 int len = 0; /* Of logical line so far */
702 /* Loop for handling continuation lines, skipping comments, and dealing with
707 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
709 if (config_file_stack != NULL) /* EOF inside .include */
711 (void)fclose(config_file);
712 config_file = config_file_stack->file;
713 config_filename = config_file_stack->filename;
714 config_lineno = config_file_stack->lineno;
715 config_file_stack = config_file_stack->next;
717 save_config_position(config_filename, config_lineno);
721 /* EOF at top level */
723 if (cstate_stack_ptr >= 0)
724 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
725 "Unexpected end of configuration file: .endif missing");
727 if (len != 0) break; /* EOF after continuation */
728 next_section[0] = 0; /* EOF at start of logical line */
733 newlen = len + Ustrlen(big_buffer + len);
735 if (config_lines && config_lineno == 1)
736 save_config_position(config_filename, config_lineno);
738 /* Handle pathologically long physical lines - yes, it did happen - by
739 extending big_buffer at this point. The code also copes with very long
742 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
745 big_buffer_size += BIG_BUFFER_SIZE;
746 newbuffer = store_malloc(big_buffer_size);
748 /* This use of strcpy is OK because we know that the string in the old
749 buffer is shorter than the new buffer. */
751 Ustrcpy(newbuffer, big_buffer);
752 store_free(big_buffer);
753 big_buffer = newbuffer;
754 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
756 newlen += Ustrlen(big_buffer + newlen);
759 /* Find the true start of the physical line - leading spaces are always
762 ss = big_buffer + len;
763 while (isspace(*ss)) ss++;
765 /* Process the physical line for macros. If this is the start of the logical
766 line, skip over initial text at the start of the line if it starts with an
767 upper case character followed by a sequence of name characters and an equals
768 sign, because that is the definition of a new macro, and we don't do
769 replacement therein. */
772 if (len == 0 && isupper(*s))
774 while (isalnum(*s) || *s == '_') s++;
775 while (isspace(*s)) s++;
776 if (*s != '=') s = ss; /* Not a macro definition */
779 /* For each defined macro, scan the line (from after XXX= if present),
780 replacing all occurrences of the macro. */
783 for (m = macros; m != NULL; m = m->next)
788 while ((p = Ustrstr(t, m->name)) != NULL)
791 int namelen = Ustrlen(m->name);
792 int replen = Ustrlen(m->replacement);
794 /* Expand the buffer if necessary */
796 while (newlen - namelen + replen + 1 > big_buffer_size)
798 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
799 uschar *newbuffer = store_malloc(newsize);
800 memcpy(newbuffer, big_buffer, newlen + 1);
801 p = newbuffer + (p - big_buffer);
802 s = newbuffer + (s - big_buffer);
803 ss = newbuffer + (ss - big_buffer);
804 t = newbuffer + (t - big_buffer);
805 big_buffer_size = newsize;
806 store_free(big_buffer);
807 big_buffer = newbuffer;
810 /* Shuffle the remaining characters up or down in the buffer before
811 copying in the replacement text. Don't rescan the replacement for this
815 moveby = replen - namelen;
818 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
821 Ustrncpy(p, m->replacement, replen);
827 /* An empty macro replacement at the start of a line could mean that ss no
828 longer points to the first non-blank character. */
830 while (isspace(*ss)) ss++;
832 /* Check for comment lines - these are physical lines. */
834 if (*ss == '#') continue;
836 /* Handle conditionals, which are also applied to physical lines. Conditions
837 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
838 expansion occured on the rest of the line. A preliminary test for the leading
839 '.' saves effort on most lines. */
845 /* Search the list of conditional directives */
847 for (i = 0; i < cond_list_size; i++)
850 cond_item *c = cond_list+i;
851 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
853 /* The following character must be white space or end of string */
855 n = ss[1 + c->namelen];
856 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
858 /* .ifdef and .ifndef push the current state onto the stack, then set
859 a new one from the table. Stack overflow is an error */
863 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
864 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
865 ".%s nested too deeply", c->name);
866 cstate_stack[++cstate_stack_ptr] = cstate;
867 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
870 /* For any of the others, stack underflow is an error. The next state
871 comes either from the stack (.endif) or from the table. */
875 if (cstate_stack_ptr < 0)
876 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
877 ".%s without matching .ifdef", c->name);
878 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
879 next_cstate[cstate][macro_found? c->action1 : c->action2];
882 /* Having dealt with a directive, break the loop */
887 /* If we have handled a conditional directive, continue with the next
888 physical line. Otherwise, fall through. */
890 if (i < cond_list_size) continue;
893 /* If the conditional state is not 0 (actively using these lines), ignore
896 if (cstate != 0) continue; /* Conditional skip */
898 /* Handle .include lines - these are also physical lines. */
900 if (Ustrncmp(ss, ".include", 8) == 0 &&
902 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
905 int include_if_exists = isspace(ss[8])? 0 : 10;
906 config_file_item *save;
909 ss += 9 + include_if_exists;
910 while (isspace(*ss)) ss++;
911 t = ss + Ustrlen(ss);
912 while (t > ss && isspace(t[-1])) t--;
913 if (*ss == '\"' && t[-1] == '\"')
921 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
922 "absolute path \"%s\"", ss);
924 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
927 save_config_position(config_filename, config_lineno);
928 save = store_get(sizeof(config_file_item));
929 save->next = config_file_stack;
930 config_file_stack = save;
931 save->file = config_file;
932 save->filename = config_filename;
933 save->lineno = config_lineno;
935 config_file = Ufopen(ss, "rb");
936 if (config_file == NULL)
937 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
938 "configuration file %s", ss);
939 config_filename = string_copy(ss);
944 /* If this is the start of the logical line, remember where the non-blank
945 data starts. Otherwise shuffle down continuation lines to remove leading
949 startoffset = ss - big_buffer;
952 s = big_buffer + len;
955 memmove(s, ss, (newlen - len) - (ss - s) + 1);
960 /* Accept the new addition to the line. Remove trailing white space. */
963 while (len > 0 && isspace(big_buffer[len-1])) len--;
966 /* We are done if the line does not end in backslash and contains some data.
967 Empty logical lines are ignored. For continuations, remove the backslash and
968 go round the loop to read the continuation line. */
972 if (big_buffer[len-1] != '\\') break; /* End of logical line */
973 big_buffer[--len] = 0; /* Remove backslash */
975 } /* Loop for reading multiple physical lines */
977 /* We now have a logical line. Test for the end of a configuration section (or,
978 more accurately, for the start of the next section). Place the name of the next
979 section in next_section, and return NULL. If the name given is longer than
980 next_section, truncate it. It will be unrecognized later, because all the known
981 section names do fit. Leave space for pluralizing. */
983 s = big_buffer + startoffset; /* First non-space character */
988 if (strncmpic(s, US"begin ", 6) == 0)
991 while (isspace(*s)) s++;
992 if (big_buffer + len - s > sizeof(next_section) - 2)
993 s[sizeof(next_section) - 2] = 0;
994 Ustrcpy(next_section, s);
998 /* Return the first non-blank character. */
1005 /*************************************************
1007 *************************************************/
1009 /* The yield is the pointer to the next uschar. Names longer than the
1010 output space are silently truncated. This function is also used from acl.c when
1014 name where to put the name
1018 Returns: new input pointer
1022 readconf_readname(uschar *name, int len, uschar *s)
1025 while (isspace(*s)) s++;
1028 while (isalnum(*s) || *s == '_')
1030 if (p < len-1) name[p++] = *s;
1035 while (isspace(*s)) s++;
1042 /*************************************************
1043 * Read a time value *
1044 *************************************************/
1046 /* This function is also called from outside, to read argument
1047 time values. The format of a time value is:
1049 [<n>w][<n>d][<n>h][<n>m][<n>s]
1051 as long as at least one is present. If a format error is encountered,
1052 return a negative value. The value must be terminated by the given
1057 terminator required terminating character
1058 return_msec if TRUE, allow fractional seconds and return milliseconds
1060 Returns: the time value, or -1 on syntax error
1061 value is seconds if return_msec is FALSE
1062 value is milliseconds if return_msec is TRUE
1066 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1074 if (!isdigit(*s)) return -1;
1075 (void)sscanf(CCS s, "%d%n", &value, &count);
1080 case 'w': value *= 7;
1081 case 'd': value *= 24;
1082 case 'h': value *= 60;
1083 case 'm': value *= 60;
1088 if (!return_msec) return -1;
1089 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1091 if (*s++ != 's') return -1;
1092 yield += (int)(fraction * 1000.0);
1098 if (return_msec) value *= 1000;
1100 if (*s == terminator) return yield;
1102 /* Control never reaches here. */
1107 /*************************************************
1108 * Read a fixed point value *
1109 *************************************************/
1111 /* The value is returned *1000
1115 terminator required terminator
1117 Returns: the value, or -1 on error
1121 readconf_readfixed(const uschar *s, int terminator)
1125 if (!isdigit(*s)) return -1;
1126 (void)sscanf(CS s, "%d%n", &value, &count);
1128 yield = value * 1000;
1132 while (isdigit((*(++s))))
1134 yield += (*s - '0') * m;
1139 return (*s == terminator)? yield : (-1);
1144 /*************************************************
1145 * Find option in list *
1146 *************************************************/
1148 /* The lists are always in order, so binary chop can be used.
1151 name the option name to search for
1152 ol the first entry in the option list
1153 last one more than the offset of the last entry in the option list
1155 Returns: pointer to an option entry, or NULL if not found
1159 find_option(uschar *name, optionlist *ol, int last)
1162 while (last > first)
1164 int middle = (first + last)/2;
1165 int c = Ustrcmp(name, ol[middle].name);
1166 if (c == 0) return ol + middle;
1167 else if (c > 0) first = middle + 1;
1175 /*************************************************
1176 * Find a set flag in option list *
1177 *************************************************/
1179 /* Because some versions of Unix make no restrictions on the values of uids and
1180 gids (even negative ones), we cannot represent "unset" by a special value.
1181 There is therefore a separate boolean variable for each one indicating whether
1182 a value is set or not. This function returns a pointer to the boolean, given
1183 the original option name. It is a major disaster if the flag cannot be found.
1186 name the name of the uid or gid option
1187 oltop points to the start of the relevant option list
1188 last one more than the offset of the last item in the option list
1189 data_block NULL when reading main options => data values in the option
1190 list are absolute addresses; otherwise they are byte offsets
1191 in data_block (used for driver options)
1193 Returns: a pointer to the boolean flag.
1197 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1201 sprintf(CS name2, "*set_%.50s", name);
1202 ol = find_option(name2, oltop, last);
1203 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1204 "Exim internal error: missing set flag for %s", name);
1205 return (data_block == NULL)? (BOOL *)(ol->value) :
1206 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1212 /*************************************************
1213 * Output extra characters message and die *
1214 *************************************************/
1216 /* Called when an option line has junk on the end. Sometimes this is because
1217 the sysadmin thinks comments are permitted.
1220 s points to the extra characters
1221 t1..t3 strings to insert in the log message
1223 Returns: doesn't return; dies
1227 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1229 uschar *comment = US"";
1230 if (*s == '#') comment = US" (# is comment only at line start)";
1231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1232 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1237 /*************************************************
1238 * Read rewrite information *
1239 *************************************************/
1241 /* Each line of rewrite information contains:
1243 . A complete address in the form user@domain, possibly with
1244 leading * for each part; or alternatively, a regex.
1246 . A replacement string (which will be expanded).
1248 . An optional sequence of one-letter flags, indicating which
1249 headers etc. to apply this rule to.
1251 All this is decoded and placed into a control block. The OR of the flags is
1252 maintained in a common word.
1255 p points to the string that makes up the rule
1256 existflags points to the overall flag word
1257 isglobal TRUE if reading global rewrite rules
1259 Returns: the control block for the parsed rule.
1262 static rewrite_rule *
1263 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1265 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1268 next->key = string_dequote(&p);
1270 while (isspace(*p)) p++;
1272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1273 "missing rewrite replacement string");
1276 next->replacement = string_dequote(&p);
1278 while (*p != 0) switch (*p++)
1280 case ' ': case '\t': break;
1282 case 'q': next->flags |= rewrite_quit; break;
1283 case 'w': next->flags |= rewrite_whole; break;
1285 case 'h': next->flags |= rewrite_all_headers; break;
1286 case 's': next->flags |= rewrite_sender; break;
1287 case 'f': next->flags |= rewrite_from; break;
1288 case 't': next->flags |= rewrite_to; break;
1289 case 'c': next->flags |= rewrite_cc; break;
1290 case 'b': next->flags |= rewrite_bcc; break;
1291 case 'r': next->flags |= rewrite_replyto; break;
1293 case 'E': next->flags |= rewrite_all_envelope; break;
1294 case 'F': next->flags |= rewrite_envfrom; break;
1295 case 'T': next->flags |= rewrite_envto; break;
1297 case 'Q': next->flags |= rewrite_qualify; break;
1298 case 'R': next->flags |= rewrite_repeat; break;
1301 next->flags |= rewrite_smtp;
1302 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1303 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1304 "rewrite rule has the S flag but is not a regular expression");
1308 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1309 "unknown rewrite flag character '%c' "
1310 "(could be missing quotes round replacement item)", p[-1]);
1314 /* If no action flags are set, set all the "normal" rewrites. */
1316 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1317 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1319 /* Remember which exist, for optimization, and return the rule */
1321 *existflags |= next->flags;
1328 /*************************************************
1329 * Read global rewrite information *
1330 *************************************************/
1332 /* Each line is a single rewrite rule; it is parsed into a control block
1333 by readconf_one_rewrite(), and its flags are ORed into the global flag
1334 word rewrite_existflags. */
1337 readconf_rewrites(void)
1339 rewrite_rule **chain = &global_rewrite_rules;
1342 while ((p = get_config_line()) != NULL)
1344 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1346 chain = &(next->next);
1352 /*************************************************
1354 *************************************************/
1356 /* Strings are read into the normal store pool. As long we aren't too
1357 near the end of the current block, the string will just use what is necessary
1358 on the top of the stacking pool, because string_cat() uses the extension
1362 s the rest of the input line
1363 name the option name (for errors)
1365 Returns: pointer to the string
1369 read_string(const uschar *s, const uschar *name)
1374 if (*s != '\"') return string_copy(s);
1377 yield = string_dequote(&s);
1379 if (s == ss+1 || s[-1] != '\"')
1380 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1381 "missing quote at end of string value for %s", name);
1383 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1389 /*************************************************
1390 * Custom-handler options *
1391 *************************************************/
1393 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1396 smtp_receive_timeout_s = string_copy(str);
1399 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1400 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1401 if (smtp_receive_timeout < 0)
1402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1407 /*************************************************
1408 * Handle option line *
1409 *************************************************/
1411 /* This function is called from several places to process a line containing the
1412 setting of an option. The first argument is the line to be decoded; it has been
1413 checked not to be empty and not to start with '#'. Trailing newlines and white
1414 space have been removed. The second argument is a pointer to the list of
1415 variable names that are to be recognized, together with their types and
1416 locations, and the third argument gives the number of entries in the list.
1418 The fourth argument is a pointer to a data block. If it is NULL, then the data
1419 values in the options list are absolute addresses. Otherwise, they are byte
1420 offsets in the data block.
1422 String option data may continue onto several lines; this function reads further
1423 data from config_file if necessary.
1425 The yield of this function is normally zero. If a string continues onto
1426 multiple lines, then the data value is permitted to be followed by a comma
1427 or a semicolon (for use in drivers) and the yield is that character.
1430 buffer contains the configuration line to be handled
1431 oltop points to the start of the relevant option list
1432 last one more than the offset of the last item in the option list
1433 data_block NULL when reading main options => data values in the option
1434 list are absolute addresses; otherwise they are byte offsets
1435 in data_block when they have opt_public set; otherwise
1436 they are byte offsets in data_block->options_block.
1437 unknown_txt format string to use in panic message for unknown option;
1438 must contain %s for option name
1439 if given as NULL, don't panic on unknown option
1441 Returns: TRUE if an option was read successfully,
1442 FALSE false for an unknown option if unknown_txt == NULL,
1443 otherwise panic and die on an unknown option
1447 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1448 void *data_block, uschar *unknown_txt)
1452 int n, count, type, value;
1456 BOOL boolvalue = TRUE;
1457 BOOL freesptr = TRUE;
1458 optionlist *ol, *ol2;
1462 uschar *inttype = US"";
1465 uschar *saved_condition, *strtemp;
1466 uschar **str_target;
1470 /* There may be leading spaces; thereafter, we expect an option name starting
1473 while (isspace(*s)) s++;
1475 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1477 /* Read the name of the option, and skip any subsequent white space. If
1478 it turns out that what we read was "hide", set the flag indicating that
1479 this is a secure option, and loop to read the next word. */
1481 for (n = 0; n < 2; n++)
1483 while (isalnum(*s) || *s == '_')
1485 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1489 while (isspace(*s)) s++;
1490 if (Ustrcmp(name, "hide") != 0) break;
1491 issecure = opt_secure;
1495 /* Deal with "no_" or "not_" here for booleans */
1497 if (Ustrncmp(name, "no_", 3) == 0)
1503 if (Ustrncmp(name, "not_", 4) == 0)
1509 /* Search the list for the given name. A non-existent name, or an option that
1510 is set twice, is a disaster. */
1512 ol = find_option(name + offset, oltop, last);
1516 if (unknown_txt == NULL) return FALSE;
1517 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1520 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1521 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1522 "\"%s\" option set for the second time", name);
1524 ol->type |= opt_set | issecure;
1525 type = ol->type & opt_mask;
1527 /* Types with data values must be followed by '='; the "no[t]_" prefix
1528 applies only to boolean values. */
1530 if (type < opt_bool || type > opt_bool_last)
1533 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1534 "negation prefix applied to a non-boolean option");
1536 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1537 "unexpected end of line (data missing) after %s", name);
1539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1542 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1543 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1544 ultimately expands to one of those values. */
1546 else if (*s != 0 && (offset != 0 || *s != '='))
1547 extra_chars_error(s, US"boolean option ", name, US"");
1549 /* Skip white space after = */
1551 if (*s == '=') while (isspace((*(++s))));
1553 /* If there is a data block and the opt_public flag is not set, change
1554 the data block pointer to the private options block. */
1556 if (data_block != NULL && (ol->type & opt_public) == 0)
1557 data_block = (void *)(((driver_instance *)data_block)->options_block);
1559 /* Now get the data according to the type. */
1563 /* If a string value is not enclosed in quotes, it consists of
1564 the rest of the current line, verbatim. Otherwise, string escapes
1567 A transport is specified as a string, which is then looked up in the
1568 list of transports. A search type is specified as one of a number of
1571 A set or rewrite rules for a driver is specified as a string, which is
1572 then parsed into a suitable chain of control blocks.
1574 Uids and gids are specified as strings which are then looked up in the
1575 passwd file. Lists of uids and gids are similarly specified as colon-
1576 separated strings. */
1581 case opt_expand_uid:
1582 case opt_expand_gid:
1587 reset_point = sptr = read_string(s, name);
1589 /* Having read a string, we now have several different ways of using it,
1590 depending on the data type, so do another switch. If keeping the actual
1591 string is not required (because it is interpreted), freesptr is set TRUE,
1592 and at the end we reset the pool. */
1596 /* If this was a string, set the variable to point to the new string,
1597 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1598 rules, we still keep the string (for printing), and parse the rules into a
1599 control block and flags word. */
1602 if (data_block == NULL)
1603 str_target = (uschar **)(ol->value);
1605 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1606 if (ol->type & opt_rep_con)
1608 /* We already have a condition, we're conducting a crude hack to let
1609 multiple condition rules be chained together, despite storing them in
1611 saved_condition = *str_target;
1612 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1613 saved_condition, sptr);
1614 *str_target = string_copy_malloc(strtemp);
1615 /* TODO(pdp): there is a memory leak here and just below
1616 when we set 3 or more conditions; I still don't
1617 understand the store mechanism enough to know
1618 what's the safe way to free content from an earlier store.
1619 AFAICT, stores stack, so freeing an early stored item also stores
1620 all data alloc'd after it. If we knew conditions were adjacent,
1621 we could survive that, but we don't. So I *think* we need to take
1622 another bit from opt_type to indicate "malloced"; this seems like
1623 quite a hack, especially for this one case. It also means that
1624 we can't ever reclaim the store from the *first* condition.
1626 Because we only do this once, near process start-up, I'm prepared to
1627 let this slide for the time being, even though it rankles. */
1629 else if (ol->type & opt_rep_str)
1631 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1632 int sep_i = -(int)sep_o;
1633 const uschar * list = sptr;
1635 uschar * list_o = *str_target;
1637 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1638 list_o = string_append_listele(list_o, sep_o, s);
1640 *str_target = string_copy_malloc(list_o);
1650 if (data_block == NULL)
1651 *((uschar **)(ol->value)) = sptr;
1653 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1655 if (type == opt_rewrite)
1660 rewrite_rule **chain;
1663 sprintf(CS name2, "*%.50s_rules", name);
1664 ol2 = find_option(name2, oltop, last);
1665 sprintf(CS name2, "*%.50s_flags", name);
1666 ol3 = find_option(name2, oltop, last);
1668 if (ol2 == NULL || ol3 == NULL)
1669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1670 "rewrite rules not available for driver");
1672 if (data_block == NULL)
1674 chain = (rewrite_rule **)(ol2->value);
1675 flagptr = (int *)(ol3->value);
1679 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1680 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1683 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1685 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1687 chain = &(next->next);
1690 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1691 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1692 "non-header rewrite - not allowed at transport time -");
1696 /* If it was an expanded uid, see if there is any expansion to be
1697 done by checking for the presence of a $ character. If there is, save it
1698 in the corresponding *expand_user option field. Otherwise, fall through
1699 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1702 case opt_expand_uid:
1703 sprintf(CS name2, "*expand_%.50s", name);
1704 ol2 = find_option(name2, oltop, last);
1707 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1709 if (data_block == NULL)
1710 *((uschar **)(ol2->value)) = ss;
1712 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1716 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1722 /* Look up a fixed uid, and also make use of the corresponding gid
1723 if a passwd entry is returned and the gid has not been set. */
1726 if (!route_finduser(sptr, &pw, &uid))
1727 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1728 if (data_block == NULL)
1729 *((uid_t *)(ol->value)) = uid;
1731 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1733 /* Set the flag indicating a fixed value is set */
1735 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1737 /* Handle matching gid if we have a passwd entry: done by finding the
1738 same name with terminating "user" changed to "group"; if not found,
1739 ignore. Also ignore if the value is already set. */
1741 if (pw == NULL) break;
1742 Ustrcpy(name+Ustrlen(name)-4, "group");
1743 ol2 = find_option(name, oltop, last);
1744 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1745 (ol2->type & opt_mask) == opt_expand_gid))
1747 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1750 if (data_block == NULL)
1751 *((gid_t *)(ol2->value)) = pw->pw_gid;
1753 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1759 /* If it was an expanded gid, see if there is any expansion to be
1760 done by checking for the presence of a $ character. If there is, save it
1761 in the corresponding *expand_user option field. Otherwise, fall through
1762 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1765 case opt_expand_gid:
1766 sprintf(CS name2, "*expand_%.50s", name);
1767 ol2 = find_option(name2, oltop, last);
1770 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1772 if (data_block == NULL)
1773 *((uschar **)(ol2->value)) = ss;
1775 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1779 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1785 /* Handle freestanding gid */
1788 if (!route_findgroup(sptr, &gid))
1789 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1790 if (data_block == NULL)
1791 *((gid_t *)(ol->value)) = gid;
1793 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1794 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1797 /* If it was a uid list, look up each individual entry, and build
1798 a vector of uids, with a count in the first element. Put the vector
1799 in malloc store so we can free the string. (We are reading into
1800 permanent store already.) */
1808 const uschar *op = expand_string (sptr);
1811 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1812 name, expand_string_message);
1815 if (*p != 0) count++;
1816 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1817 list = store_malloc(count*sizeof(uid_t));
1818 list[ptr++] = (uid_t)(count - 1);
1820 if (data_block == NULL)
1821 *((uid_t **)(ol->value)) = list;
1823 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1829 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1830 if (!route_finduser(big_buffer, NULL, &uid))
1831 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1838 /* If it was a gid list, look up each individual entry, and build
1839 a vector of gids, with a count in the first element. Put the vector
1840 in malloc store so we can free the string. (We are reading into permanent
1849 const uschar *op = expand_string (sptr);
1852 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1853 name, expand_string_message);
1856 if (*p != 0) count++;
1857 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1858 list = store_malloc(count*sizeof(gid_t));
1859 list[ptr++] = (gid_t)(count - 1);
1861 if (data_block == NULL)
1862 *((gid_t **)(ol->value)) = list;
1864 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1870 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1871 if (!route_findgroup(big_buffer, &gid))
1872 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1880 /* Release store if the value of the string doesn't need to be kept. */
1882 if (freesptr) store_reset(reset_point);
1885 /* Expanded boolean: if no characters follow, or if there are no dollar
1886 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1887 save the string for later expansion in the alternate place. */
1889 case opt_expand_bool:
1890 if (*s != 0 && Ustrchr(s, '$') != 0)
1892 sprintf(CS name2, "*expand_%.50s", name);
1893 ol2 = find_option(name2, oltop, last);
1896 reset_point = sptr = read_string(s, name);
1897 if (data_block == NULL)
1898 *((uschar **)(ol2->value)) = sptr;
1900 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1907 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1908 look for yes/not/true/false. Some booleans are stored in a single bit in
1909 a single int. There's a special fudge for verify settings; without a suffix
1910 they set both xx_sender and xx_recipient. The table points to the sender
1911 value; search subsequently for the recipient. There's another special case:
1912 opt_bool_set also notes when a boolean has been set. */
1916 case opt_bool_verify:
1920 s = readconf_readname(name2, 64, s);
1921 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1923 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1925 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1926 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1927 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1928 US"for boolean option ", name);
1931 /* Handle single-bit type. */
1933 if (type == opt_bit)
1935 int bit = 1 << ((ol->type >> 16) & 31);
1936 int *ptr = (data_block == NULL)?
1937 (int *)(ol->value) :
1938 (int *)((uschar *)data_block + (long int)ol->value);
1939 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1943 /* Handle full BOOL types */
1945 if (data_block == NULL)
1946 *((BOOL *)(ol->value)) = boolvalue;
1948 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1952 if (type == opt_bool_verify)
1954 sprintf(CS name2, "%.50s_recipient", name + offset);
1955 ol2 = find_option(name2, oltop, last);
1958 if (data_block == NULL)
1959 *((BOOL *)(ol2->value)) = boolvalue;
1961 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1965 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1967 else if (type == opt_bool_set)
1969 sprintf(CS name2, "*set_%.50s", name + offset);
1970 ol2 = find_option(name2, oltop, last);
1973 if (data_block == NULL)
1974 *((BOOL *)(ol2->value)) = TRUE;
1976 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1985 inttype = US"octal ";
1987 /* Integer: a simple(ish) case; allow octal and hex formats, and
1988 suffixes K and M. The different types affect output, not input. */
1997 lvalue = strtol(CS s, CSS &endptr, intbase);
2000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2003 if (errno != ERANGE)
2005 if (tolower(*endptr) == 'k')
2007 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2008 else lvalue *= 1024;
2011 else if (tolower(*endptr) == 'm')
2013 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2015 else lvalue *= 1024*1024;
2020 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2021 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2022 "absolute value of integer \"%s\" is too large (overflow)", s);
2024 while (isspace(*endptr)) endptr++;
2026 extra_chars_error(endptr, inttype, US"integer value for ", name);
2028 value = (int)lvalue;
2031 if (data_block == NULL)
2032 *((int *)(ol->value)) = value;
2034 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2037 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
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);
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)
2709 for (p = USS environ; *p; p++) ;
2710 n = p - USS environ;
2711 qsort(environ, p - USS environ, sizeof(*p), (__compar_fn_t) string_compare_by_pointer);
2713 for (p = USS environ; *p; p++)
2715 if (no_labels) *(Ustrchr(*p, '=')) = '\0';
2724 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2725 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2730 /* Handle the options for a router or transport. Skip options that are flagged
2731 as hidden. Some of these are options with names starting with '*', used for
2732 internal alternative representations of other options (which the printing
2733 function will sort out). Others are synonyms kept for backward compatibility.
2736 if (Ustrcmp(type, "router") == 0)
2738 d = (driver_instance *)routers;
2739 ol2 = optionlist_routers;
2740 size = optionlist_routers_size;
2742 else if (Ustrcmp(type, "transport") == 0)
2744 d = (driver_instance *)transports;
2745 ol2 = optionlist_transports;
2746 size = optionlist_transports_size;
2748 else if (Ustrcmp(type, "authenticator") == 0)
2750 d = (driver_instance *)auths;
2751 ol2 = optionlist_auths;
2752 size = optionlist_auths_size;
2755 else if (Ustrcmp(type, "macro") == 0)
2757 /* People store passwords in macros and they were previously not available
2758 for printing. So we have an admin_users restriction. */
2761 fprintf(stderr, "exim: permission denied\n");
2764 for (m = macros; m != NULL; m = m->next)
2766 if (name == NULL || Ustrcmp(name, m->name) == 0)
2769 printf("%s\n", CS m->name);
2771 printf("%s=%s\n", CS m->name, CS m->replacement);
2777 printf("%s %s not found\n", type, name);
2783 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2787 /* Either search for a given driver, or print all of them */
2789 for (; d != NULL; d = d->next)
2792 printf("\n%s %s:\n", d->name, type);
2793 else if (Ustrcmp(d->name, name) != 0) continue;
2795 for (ol = ol2; ol < ol2 + size; ol++)
2797 if ((ol->type & opt_hidden) == 0)
2798 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2801 for (ol = d->info->options;
2802 ol < d->info->options + *(d->info->options_count); ol++)
2804 if ((ol->type & opt_hidden) == 0)
2805 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2807 if (name != NULL) return;
2809 if (name != NULL) printf("%s %s not found\n", type, name);
2814 /*************************************************
2815 * Read a named list item *
2816 *************************************************/
2818 /* This function reads a name and a list (i.e. string). The name is used to
2819 save the list in a tree, sorted by its name. Each entry also has a number,
2820 which can be used for caching tests, but if the string contains any expansion
2821 items other than $key, the number is set negative to inhibit caching. This
2822 mechanism is used for domain, host, and address lists that are referenced by
2826 anchorp points to the tree anchor
2827 numberp points to the current number for this tree
2828 max the maximum number permitted
2829 s the text of the option line, starting immediately after the name
2831 tname the name of the list type, for messages
2837 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2840 BOOL forcecache = FALSE;
2843 namedlist_block *nb = store_get(sizeof(namedlist_block));
2845 if (Ustrncmp(s, "_cache", 6) == 0)
2852 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2854 if (*numberp >= max)
2855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2858 while (isspace(*s)) s++;
2860 while (isalnum(*s) || *s == '_') s++;
2861 t = store_get(sizeof(tree_node) + s-ss);
2862 Ustrncpy(t->name, ss, s-ss);
2864 while (isspace(*s)) s++;
2866 if (!tree_insertnode(anchorp, t))
2867 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2868 "duplicate name \"%s\" for a named %s", t->name, tname);
2871 nb->number = *numberp;
2874 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2875 "missing '=' after \"%s\"", t->name);
2876 while (isspace(*s)) s++;
2877 nb->string = read_string(s, t->name);
2878 nb->cache_data = NULL;
2880 /* Check the string for any expansions; if any are found, mark this list
2881 uncacheable unless the user has explicited forced caching. */
2883 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2889 /*************************************************
2890 * Unpick data for a rate limit *
2891 *************************************************/
2893 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2897 s string, in the form t,b,f,l
2898 where t is the threshold (integer)
2899 b is the initial delay (time)
2900 f is the multiplicative factor (fixed point)
2901 k is the maximum time (time)
2902 threshold where to store threshold
2903 base where to store base in milliseconds
2904 factor where to store factor in milliseconds
2905 limit where to store limit
2907 Returns: nothing (panics on error)
2911 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2914 uschar bstring[16], lstring[16];
2916 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2917 factor, lstring) == 4)
2919 *base = readconf_readtime(bstring, 0, TRUE);
2920 *limit = readconf_readtime(lstring, 0, TRUE);
2921 if (*base >= 0 && *limit >= 0) return;
2923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2929 /*************************************************
2930 * Drop privs for checking TLS config *
2931 *************************************************/
2933 /* We want to validate TLS options during readconf, but do not want to be
2934 root when we call into the TLS library, in case of library linkage errors
2935 which cause segfaults; before this check, those were always done as the Exim
2936 runtime user and it makes sense to continue with that.
2938 Assumes: tls_require_ciphers has been set, if it will be
2939 exim_user has been set, if it will be
2940 exim_group has been set, if it will be
2942 Returns: bool for "okay"; false will cause caller to immediately exit.
2947 tls_dropprivs_validate_require_cipher(void)
2949 const uschar *errmsg;
2952 void (*oldsignal)(int);
2954 /* If TLS will never be used, no point checking ciphers */
2956 if ( !tls_advertise_hosts
2957 || !*tls_advertise_hosts
2958 || Ustrcmp(tls_advertise_hosts, ":") == 0
2961 else if (!tls_certificate)
2962 log_write(0, LOG_MAIN|LOG_PANIC,
2963 "Warning: No server certificate defined; TLS connections will fail.\n"
2964 " Suggested action: either install a certificate or change tls_advertise_hosts option");
2966 oldsignal = signal(SIGCHLD, SIG_DFL);
2969 if ((pid = fork()) < 0)
2970 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2974 /* in some modes, will have dropped privilege already */
2976 exim_setugid(exim_uid, exim_gid, FALSE,
2977 US"calling tls_validate_require_cipher");
2979 errmsg = tls_validate_require_cipher();
2982 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2983 "tls_require_ciphers invalid: %s", errmsg);
2990 rc = waitpid(pid, &status, 0);
2991 } while (rc < 0 && errno == EINTR);
2994 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2997 signal(SIGCHLD, oldsignal);
3001 #endif /* SUPPORT_TLS */
3006 /*************************************************
3007 * Read main configuration options *
3008 *************************************************/
3010 /* This function is the first to be called for configuration reading. It
3011 opens the configuration file and reads general configuration settings until
3012 it reaches the end of the configuration section. The file is then left open so
3013 that the remaining configuration data can subsequently be read if needed for
3016 The configuration file must be owned either by root or exim, and be writeable
3017 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3018 in the config file, so the test is done on the compiled in values. A slight
3019 anomaly, to be carefully documented.
3021 The name of the configuration file is taken from a list that is included in the
3022 binary of Exim. It can be altered from the command line, but if that is done,
3023 root privilege is immediately withdrawn unless the caller is root or exim.
3024 The first file on the list that exists is used.
3026 For use on multiple systems that share file systems, first look for a
3027 configuration file whose name has the current node name on the end. If that is
3028 not found, try the generic name. For really contorted configurations, that run
3029 multiple Exims with different uid settings, first try adding the effective uid
3030 before the node name. These complications are going to waste resources on most
3031 systems. Therefore they are available only when requested by compile-time
3038 struct stat statbuf;
3039 uschar *s, *filename;
3040 const uschar *list = config_main_filelist;
3042 /* Loop through the possible file names */
3044 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
3048 /* To avoid confusion: Exim changes to / at the very beginning and
3049 * and to $spool_directory later. */
3050 if (filename[0] != '/')
3052 fprintf(stderr, "-C %s: only absolute names are allowed\n", filename);
3056 /* Cut out all the fancy processing unless specifically wanted */
3058 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3059 uschar *suffix = filename + Ustrlen(filename);
3061 /* Try for the node-specific file if a node name exists */
3063 #ifdef CONFIGURE_FILE_USE_NODE
3065 if (uname(&uts) >= 0)
3067 #ifdef CONFIGURE_FILE_USE_EUID
3068 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3069 config_file = Ufopen(filename, "rb");
3070 if (config_file == NULL)
3071 #endif /* CONFIGURE_FILE_USE_EUID */
3073 sprintf(CS suffix, ".%.256s", uts.nodename);
3074 config_file = Ufopen(filename, "rb");
3077 #endif /* CONFIGURE_FILE_USE_NODE */
3079 /* Otherwise, try the generic name, possibly with the euid added */
3081 #ifdef CONFIGURE_FILE_USE_EUID
3082 if (config_file == NULL)
3084 sprintf(CS suffix, ".%ld", (long int)original_euid);
3085 config_file = Ufopen(filename, "rb");
3087 #endif /* CONFIGURE_FILE_USE_EUID */
3089 /* Finally, try the unadorned name */
3091 if (config_file == NULL)
3094 config_file = Ufopen(filename, "rb");
3096 #else /* if neither defined */
3098 /* This is the common case when the fancy processing is not included. */
3100 config_file = Ufopen(filename, "rb");
3103 /* If the file does not exist, continue to try any others. For any other
3104 error, break out (and die). */
3106 if (config_file != NULL || errno != ENOENT) break;
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())
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);
3496 if (gnutls_require_kx || gnutls_require_mac || gnutls_require_proto)
3497 log_write(0, LOG_MAIN, "WARNING: main options"
3498 " gnutls_require_kx, gnutls_require_mac and gnutls_require_protocols"
3500 #endif /*SUPPORT_TLS*/
3502 if ((!add_environment || *add_environment == '\0') && !keep_environment)
3503 log_write(0, LOG_MAIN,
3504 "WARNING: purging the environment.\n"
3505 " Suggested action: use keep_environment and add_environment.\n");
3510 /*************************************************
3511 * Initialize one driver *
3512 *************************************************/
3514 /* This is called once the driver's generic options, if any, have been read.
3515 We can now find the driver, set up defaults for the private options, and
3516 unset any "set" bits in the private options table (which might have been
3517 set by another incarnation of the same driver).
3520 d pointer to driver instance block, with generic
3522 drivers_available vector of available drivers
3523 size_of_info size of each block in drivers_available
3524 class class of driver, for error message
3526 Returns: pointer to the driver info block
3529 static driver_info *
3530 init_driver(driver_instance *d, driver_info *drivers_available,
3531 int size_of_info, uschar *class)
3535 for (dd = drivers_available; dd->driver_name[0] != 0;
3536 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3538 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3541 int len = dd->options_len;
3543 d->options_block = store_get(len);
3544 memcpy(d->options_block, dd->options_block, len);
3545 for (i = 0; i < *(dd->options_count); i++)
3546 dd->options[i].type &= ~opt_set;
3551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3552 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3554 return NULL; /* never obeyed */
3560 /*************************************************
3561 * Initialize driver list *
3562 *************************************************/
3564 /* This function is called for routers, transports, and authentication
3565 mechanisms. It reads the data from the current point in the configuration file
3566 up to the end of the section, and sets up a chain of instance blocks according
3567 to the file's contents. The file will already have been opened by a call to
3568 readconf_main, and must be left open for subsequent reading of further data.
3570 Any errors cause a panic crash. Note that the blocks with names driver_info and
3571 driver_instance must map the first portions of all the _info and _instance
3572 blocks for this shared code to work.
3575 class "router", "transport", or "authenticator"
3576 anchor &routers, &transports, &auths
3577 drivers_available available drivers
3578 size_of_info size of each info block
3579 instance_default points to default data for an instance
3580 instance_size size of instance block
3581 driver_optionlist generic option list
3582 driver_optionlist_count count of generic option list
3588 readconf_driver_init(
3590 driver_instance **anchor,
3591 driver_info *drivers_available,
3593 void *instance_default,
3595 optionlist *driver_optionlist,
3596 int driver_optionlist_count)
3598 driver_instance **p = anchor;
3599 driver_instance *d = NULL;
3602 while ((buffer = get_config_line()) != NULL)
3607 /* Read the first name on the line and test for the start of a new driver. A
3608 macro definition indicates the end of the previous driver. If this isn't the
3609 start of a new driver, the line will be re-read. */
3611 s = readconf_readname(name, sizeof(name), buffer);
3613 /* Handle macro definition, first finishing off the initialization of the
3614 previous driver, if any. */
3616 if (isupper(*name) && *s == '=')
3620 if (d->driver_name == NULL)
3621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3622 "no driver defined for %s \"%s\"", class, d->name);
3626 read_macro_assignment(buffer);
3630 /* If the line starts with a name terminated by a colon, we are at the
3631 start of the definition of a new driver. The rest of the line must be
3638 /* Finish off initializing the previous driver. */
3642 if (d->driver_name == NULL)
3643 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3644 "no driver defined for %s \"%s\"", class, d->name);
3648 /* Check that we haven't already got a driver of this name */
3650 for (d = *anchor; d != NULL; d = d->next)
3651 if (Ustrcmp(name, d->name) == 0)
3652 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3653 "there are two %ss called \"%s\"", class, name);
3655 /* Set up a new driver instance data block on the chain, with
3656 its default values installed. */
3658 d = store_get(instance_size);
3659 memcpy(d, instance_default, instance_size);
3662 d->name = string_copy(name);
3664 /* Clear out the "set" bits in the generic options */
3666 for (i = 0; i < driver_optionlist_count; i++)
3667 driver_optionlist[i].type &= ~opt_set;
3669 /* Check nothing more on this line, then do the next loop iteration. */
3671 while (isspace(*s)) s++;
3672 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3676 /* Not the start of a new driver. Give an error if we have not set up a
3677 current driver yet. */
3679 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3680 "%s name missing", class);
3682 /* First look to see if this is a generic option; if it is "driver",
3683 initialize the driver. If is it not a generic option, we can look for a
3684 private option provided that the driver has been previously set up. */
3686 if (readconf_handle_option(buffer, driver_optionlist,
3687 driver_optionlist_count, d, NULL))
3689 if (d->info == NULL && d->driver_name != NULL)
3690 init_driver(d, drivers_available, size_of_info, class);
3693 /* Handle private options - pass the generic block because some may
3694 live therein. A flag with each option indicates if it is in the public
3697 else if (d->info != NULL)
3699 readconf_handle_option(buffer, d->info->options,
3700 *(d->info->options_count), d, US"option \"%s\" unknown");
3703 /* The option is not generic and the driver name has not yet been given. */
3705 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3706 "(\"driver\" must be specified before any private options)", name);
3709 /* Run the initialization function for the final driver. */
3713 if (d->driver_name == NULL)
3714 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3715 "no driver defined for %s \"%s\"", class, d->name);
3722 /*************************************************
3723 * Check driver dependency *
3724 *************************************************/
3726 /* This function is passed a driver instance and a string. It checks whether
3727 any of the string options for the driver contains the given string as an
3731 d points to a driver instance block
3732 s the string to search for
3734 Returns: TRUE if a dependency is found
3738 readconf_depends(driver_instance *d, uschar *s)
3740 int count = *(d->info->options_count);
3744 for (ol = d->info->options; ol < d->info->options + count; ol++)
3746 void *options_block;
3748 int type = ol->type & opt_mask;
3749 if (type != opt_stringptr) continue;
3750 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3751 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3752 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3754 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3755 isalnum(ss[Ustrlen(s)])) continue;
3756 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3757 d->name, ol->name, s);
3762 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3769 /*************************************************
3770 * Decode an error type for retries *
3771 *************************************************/
3773 /* This function is global because it is also called from the main
3774 program when testing retry information. It decodes strings such as "quota_7d"
3775 into numerical error codes.
3778 pp points to start of text
3779 p points past end of text
3780 basic_errno points to an int to receive the main error number
3781 more_errno points to an int to receive the secondary error data
3783 Returns: NULL if decoded correctly; else points to error text
3787 readconf_retry_error(const uschar *pp, const uschar *p,
3788 int *basic_errno, int *more_errno)
3791 const uschar *q = pp;
3792 while (q < p && *q != '_') q++;
3795 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3797 *basic_errno = ERRNO_EXIMQUOTA;
3798 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3799 return US"bad time value";
3802 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3804 *basic_errno = ECONNREFUSED;
3807 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3808 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3809 else return US"A or MX expected after \"refused\"";
3813 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3815 *basic_errno = ETIMEDOUT;
3819 int xlen = p - q - 1;
3820 const uschar *x = q + 1;
3822 static uschar *extras[] =
3823 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3824 static int values[] =
3825 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3827 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3828 if (strncmpic(x, extras[i], xlen) == 0)
3830 *more_errno = values[i];
3834 if (i >= sizeof(extras)/sizeof(uschar *))
3835 if (strncmpic(x, US"DNS", xlen) == 0)
3836 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3837 "available in retry rules (it has never worked) - treated as "
3840 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3844 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3845 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3846 strncmpic(pp, US"data_4", 6) == 0)
3849 int x = 255; /* means "any 4xx code" */
3850 if (p != pp + 8) bad = TRUE; else
3852 int a = pp[6], b = pp[7];
3856 if (isdigit(b)) x += b - '0';
3857 else if (b == 'x') x += 100;
3860 else if (a != 'x' || b != 'x') bad = TRUE;
3864 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3865 "x is literal and d is any digit", pp);
3867 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3868 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3869 *more_errno = x << 8;
3872 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3873 strncmpic(q+1, US"failed", p-q-1) == 0)
3874 *basic_errno = ERRNO_AUTHFAIL;
3876 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3877 *basic_errno = ERRNO_SMTPCLOSED;
3879 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3880 *basic_errno = ERRNO_TLSREQUIRED;
3882 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3883 *basic_errno = ERRNO_UNKNOWNHOST;
3885 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3886 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3894 /*************************************************
3895 * Read retry information *
3896 *************************************************/
3898 /* Each line of retry information contains:
3900 . A domain name pattern or an address pattern;
3902 . An error name, possibly with additional data, or *;
3904 . An optional sequence of retry items, each consisting of an identifying
3905 letter, a cutoff time, and optional parameters.
3907 All this is decoded and placed into a control block. */
3910 /* Subroutine to read an argument, preceded by a comma and terminated
3911 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3912 1 = fixed point number (returned *1000).
3915 paddr pointer to pointer to current character; updated
3916 type 0 => read a time; 1 => read a fixed point number
3918 Returns: time in seconds or fixed point number * 1000
3922 retry_arg(const uschar **paddr, int type)
3924 const uschar *p = *paddr;
3927 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3929 while (isspace(*p)) p++;
3931 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3933 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3934 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3939 case 0: return readconf_readtime(pp, *p, FALSE);
3940 case 1: return readconf_readfixed(pp, *p);
3942 return 0; /* Keep picky compilers happy */
3945 /* The function proper */
3948 readconf_retries(void)
3950 retry_config **chain = &retries;
3954 while ((p = get_config_line()))
3956 retry_rule **rchain;
3960 next = store_get(sizeof(retry_config));
3963 chain = &(next->next);
3964 next->basic_errno = next->more_errno = 0;
3965 next->senders = NULL;
3967 rchain = &(next->rules);
3969 next->pattern = string_dequote(&p);
3970 while (isspace(*p)) p++;
3972 while (mac_isgraph(*p)) p++;
3973 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3974 "missing error type in retry rule");
3976 /* Test error names for things we understand. */
3978 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
3979 &next->more_errno)))
3980 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3982 /* There may be an optional address list of senders to be used as another
3983 constraint on the rule. This was added later, so the syntax is a bit of a
3984 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3987 while (isspace(*p)) p++;
3988 if (Ustrncmp(p, "senders", 7) == 0)
3991 while (isspace(*p)) p++;
3992 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3993 "\"=\" expected after \"senders\" in retry rule");
3994 while (isspace(*p)) p++;
3995 next->senders = string_dequote(&p);
3998 /* Now the retry rules. Keep the maximum timeout encountered. */
4000 while (isspace(*p)) p++;
4004 retry_rule *rule = store_get(sizeof(retry_rule));
4006 rchain = &(rule->next);
4008 rule->rule = toupper(*p++);
4009 rule->timeout = retry_arg(&p, 0);
4010 if (rule->timeout > retry_maximum_timeout)
4011 retry_maximum_timeout = rule->timeout;
4015 case 'F': /* Fixed interval */
4016 rule->p1 = retry_arg(&p, 0);
4019 case 'G': /* Geometrically increasing intervals */
4020 case 'H': /* Ditto, but with randomness */
4021 rule->p1 = retry_arg(&p, 0);
4022 rule->p2 = retry_arg(&p, 1);
4026 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4030 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4031 (rule->rule != 'F' && rule->p2 < 1000))
4032 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4033 "bad parameters for retry rule");
4035 while (isspace(*p)) p++;
4039 while (isspace(*p)) p++;
4042 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4049 /*************************************************
4050 * Initialize authenticators *
4051 *************************************************/
4053 /* Read the authenticators section of the configuration file.
4062 auth_instance *au, *bu;
4063 readconf_driver_init(US"authenticator",
4064 (driver_instance **)(&auths), /* chain anchor */
4065 (driver_info *)auths_available, /* available drivers */
4066 sizeof(auth_info), /* size of info block */
4067 &auth_defaults, /* default values for generic options */
4068 sizeof(auth_instance), /* size of instance block */
4069 optionlist_auths, /* generic options */
4070 optionlist_auths_size);
4072 for (au = auths; au != NULL; au = au->next)
4074 if (au->public_name == NULL)
4075 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4076 "the %s authenticator", au->name);
4077 for (bu = au->next; bu != NULL; bu = bu->next)
4079 if (strcmpic(au->public_name, bu->public_name) == 0)
4081 if ((au->client && bu->client) || (au->server && bu->server))
4082 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4083 "(%s and %s) have the same public name (%s)",
4084 (au->client)? US"client" : US"server", au->name, bu->name,
4094 /*************************************************
4095 * Read ACL information *
4096 *************************************************/
4098 /* If this run of Exim is not doing something that involves receiving a
4099 message, we can just skip over the ACL information. No need to parse it.
4101 First, we have a function for acl_read() to call back to get the next line. We
4102 need to remember the line we passed, because at the end it will contain the
4103 name of the next ACL. */
4105 static uschar *acl_line;
4110 acl_line = get_config_line();
4115 /* Now the main function:
4126 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4129 acl_line = get_config_line();
4131 while(acl_line != NULL)
4137 p = readconf_readname(name, sizeof(name), acl_line);
4138 if (isupper(*name) && *p == '=')
4140 read_macro_assignment(acl_line);
4141 acl_line = get_config_line();
4145 if (*p != ':' || name[0] == 0)
4146 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4148 node = store_get(sizeof(tree_node) + Ustrlen(name));
4149 Ustrcpy(node->name, name);
4150 if (!tree_insertnode(&acl_anchor, node))
4151 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4152 "there are two ACLs called \"%s\"", name);
4154 node->data.ptr = acl_read(acl_callback, &error);
4156 if (node->data.ptr == NULL && error != NULL)
4157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4163 /*************************************************
4164 * Read configuration for local_scan() *
4165 *************************************************/
4167 /* This function is called after "begin local_scan" is encountered in the
4168 configuration file. If the local_scan() function allows for configuration
4169 options, we can process them. Otherwise, we expire in a panic.
4176 local_scan_init(void)
4178 #ifndef LOCAL_SCAN_HAS_OPTIONS
4179 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4180 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4184 while ((p = get_config_line()) != NULL)
4186 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4187 NULL, US"local_scan option \"%s\" unknown");
4194 /*************************************************
4195 * Read rest of configuration (after main) *
4196 *************************************************/
4198 /* This function reads the rest of the runtime configuration, after the main
4199 configuration. It is called only when actually needed. Each subsequent section
4200 of the configuration starts with a line of the form
4204 where the name is "routers", "transports", etc. A section is terminated by
4205 hitting the next "begin" line, and the next name is left in next_section.
4206 Because it may confuse people as to whether the names are singular or plural,
4207 we add "s" if it's missing. There is always enough room in next_section for
4208 this. This function is basically just a switch.
4214 static uschar *section_list[] = {
4228 while(next_section[0] != 0)
4232 int last = sizeof(section_list) / sizeof(uschar *);
4234 int n = Ustrlen(next_section);
4236 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4240 int c = strcmpic(next_section, section_list[mid]);
4242 if (c > 0) first = mid + 1; else last = mid;
4244 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4245 "\"%.*s\" is not a known configuration section name", n, next_section);
4246 mid = (last + first)/2;
4250 if (((had ^= bit) & bit) == 0)
4251 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4252 "\"%.*s\" section is repeated in the configuration file", n,
4257 case 0: readconf_acl(); break;
4258 case 1: auths_init(); break;
4259 case 2: local_scan_init(); break;
4260 case 3: readconf_retries(); break;
4261 case 4: readconf_rewrites(); break;
4262 case 5: route_init(); break;
4263 case 6: transport_init(); break;
4267 (void)fclose(config_file);
4270 /* Init the storage for the pre-parsed config lines */
4272 readconf_save_config(const uschar *s)
4274 save_config_line(string_sprintf("# Exim Configuration (%s)",
4275 running_in_test_harness ? US"X" : s));
4279 save_config_position(const uschar *file, int line)
4281 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4284 /* Append a pre-parsed logical line to the config lines store,
4285 this operates on a global (static) list that holds all the pre-parsed
4286 config lines, we do no further processing here, output formatting and
4287 honouring of <hide> or macros will be done during output */
4289 save_config_line(const uschar* line)
4291 static config_line_item *current;
4292 config_line_item *next;
4294 next = (config_line_item*) store_get(sizeof(config_line_item));
4295 next->line = string_copy(line);
4298 if (!config_lines) config_lines = next;
4299 else current->next = next;
4304 /* List the parsed config lines, care about nice formatting and
4305 hide the <hide> values unless we're the admin user */
4307 print_config(BOOL admin)
4309 config_line_item *i;
4313 for (i = config_lines; i; i = i->next)
4318 /* skip over to the first non-space */
4319 for (current = i->line; *current && isspace(*current); ++current)
4322 if (*current == '\0')
4325 /* Collapse runs of spaces. We stop this if we encounter one of the
4326 * following characters: "'$, as this may indicate careful formatting */
4327 for (p = current; *p; ++p)
4330 if (!isspace(*p)) continue;
4331 if (*p != ' ') *p = ' ';
4333 for (next = p; isspace(*next); ++next)
4337 memmove(p+1, next, Ustrlen(next)+1);
4339 if (*next == '"' || *next == '\'' || *next == '$')
4344 if (current[0] == '#')
4347 /* begin lines are left aligned */
4348 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4355 /* router/acl/transport block names */
4356 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4358 printf("\n%*s%s\n", TS, "", current);
4362 /* hidden lines (all MACROS or lines prefixed with "hide") */
4364 && ( isupper(*current)
4365 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4369 if ((p = Ustrchr(current, '=')))
4372 printf("%*s%s= %s\n", indent, "", current, hidden);
4374 /* e.g.: hide split_spool_directory */
4376 printf("%*s\n", indent, hidden);
4380 /* rest is public */
4381 printf("%*s%s\n", indent, "", current);
4387 /* End of readconf.c */