1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
14 extern char **environ;
16 static void fn_smtp_receive_timeout(const uschar * name, const uschar * str);
17 static void save_config_line(const uschar* line);
18 static void save_config_position(const uschar *file, int line);
19 static void print_config(BOOL admin, BOOL terse);
22 #define CSTATE_STACK_SIZE 10
25 /* Structure for chain (stack) of .included files */
27 typedef struct config_file_item {
28 struct config_file_item *next;
34 /* Structure for chain of configuration lines (-bP config) */
36 typedef struct config_line_item {
37 struct config_line_item *next;
41 static config_line_item* config_lines;
43 /* Structure of table of conditional words and their state transitions */
45 typedef struct cond_item {
53 /* Structure of table of syslog facility names and values */
55 typedef struct syslog_fac_item {
61 static const char * const hidden = "<value not displayable>";
63 /* Static variables */
65 static config_file_item *config_file_stack = NULL; /* For includes */
67 static uschar *syslog_facility_str = NULL;
68 static uschar next_section[24];
69 static uschar time_buffer[24];
71 /* State variables for conditional loading (.ifdef / .else / .endif) */
73 static int cstate = 0;
74 static int cstate_stack_ptr = -1;
75 static int cstate_stack[CSTATE_STACK_SIZE];
77 /* Table of state transitions for handling conditional inclusions. There are
78 four possible state transitions:
82 .elifdef true (or .else)
85 .endif just causes the previous cstate to be popped off the stack */
87 static int next_cstate[3][4] =
89 /* State 0: reading from file, or reading until next .else or .endif */
91 /* State 1: condition failed, skipping until next .else or .endif */
93 /* State 2: skipping until .endif */
97 /* Table of conditionals and the states to set. For each name, there are four
98 values: the length of the name (to save computing it each time), the state to
99 set if a macro was found in the line, the state to set if a macro was not found
100 in the line, and a stack manipulation setting which is:
102 -1 pull state value off the stack
103 0 don't alter the stack
104 +1 push value onto stack, before setting new state
107 static cond_item cond_list[] = {
108 { US"ifdef", 5, 0, 1, 1 },
109 { US"ifndef", 6, 1, 0, 1 },
110 { US"elifdef", 7, 2, 3, 0 },
111 { US"elifndef", 8, 3, 2, 0 },
112 { US"else", 4, 2, 2, 0 },
113 { US"endif", 5, 0, 0, -1 }
116 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
118 /* Table of syslog facility names and their values */
120 static syslog_fac_item syslog_list[] = {
121 { US"mail", LOG_MAIL },
122 { US"user", LOG_USER },
123 { US"news", LOG_NEWS },
124 { US"uucp", LOG_UUCP },
125 { US"local0", LOG_LOCAL0 },
126 { US"local1", LOG_LOCAL1 },
127 { US"local2", LOG_LOCAL2 },
128 { US"local3", LOG_LOCAL3 },
129 { US"local4", LOG_LOCAL4 },
130 { US"local5", LOG_LOCAL5 },
131 { US"local6", LOG_LOCAL6 },
132 { US"local7", LOG_LOCAL7 },
133 { US"daemon", LOG_DAEMON }
136 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
141 /*************************************************
142 * Main configuration options *
143 *************************************************/
145 /* The list of options that can be set in the main configuration file. This
146 must be in alphabetic order because it is searched by binary chop. */
148 static optionlist optionlist_config[] = {
149 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
150 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
151 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
152 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
153 { "accept_8bitmime", opt_bool, &accept_8bitmime },
154 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
155 #ifdef WITH_CONTENT_SCAN
156 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
158 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
159 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
160 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
161 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
163 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
166 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
168 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
169 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
170 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
171 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
172 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
173 #ifdef WITH_CONTENT_SCAN
174 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
176 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
177 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
178 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
179 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
181 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
183 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
184 { "add_environment", opt_stringptr, &add_environment },
185 { "admin_groups", opt_gidlist, &admin_groups },
186 { "allow_domain_literals", opt_bool, &allow_domain_literals },
187 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
188 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
189 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
190 { "auto_thaw", opt_time, &auto_thaw },
191 #ifdef WITH_CONTENT_SCAN
192 { "av_scanner", opt_stringptr, &av_scanner },
194 { "bi_command", opt_stringptr, &bi_command },
195 #ifdef EXPERIMENTAL_BRIGHTMAIL
196 { "bmi_config_file", opt_stringptr, &bmi_config_file },
198 { "bounce_message_file", opt_stringptr, &bounce_message_file },
199 { "bounce_message_text", opt_stringptr, &bounce_message_text },
200 { "bounce_return_body", opt_bool, &bounce_return_body },
201 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
202 { "bounce_return_message", opt_bool, &bounce_return_message },
203 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
204 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
205 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
206 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
207 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
208 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
209 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
210 { "check_log_inodes", opt_int, &check_log_inodes },
211 { "check_log_space", opt_Kint, &check_log_space },
212 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
213 { "check_spool_inodes", opt_int, &check_spool_inodes },
214 { "check_spool_space", opt_Kint, &check_spool_space },
215 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
216 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
217 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
218 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
219 #ifdef EXPERIMENTAL_DCC
220 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
221 { "dccifd_address", opt_stringptr, &dccifd_address },
222 { "dccifd_options", opt_stringptr, &dccifd_options },
224 { "delay_warning", opt_timelist, &delay_warning },
225 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
226 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
227 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
228 { "delivery_date_remove", opt_bool, &delivery_date_remove },
229 #ifdef ENABLE_DISABLE_FSYNC
230 { "disable_fsync", opt_bool, &disable_fsync },
232 { "disable_ipv6", opt_bool, &disable_ipv6 },
234 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
236 #ifdef EXPERIMENTAL_DMARC
237 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
238 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
239 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
241 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
242 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
243 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
244 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
245 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
246 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
247 { "dns_retrans", opt_time, &dns_retrans },
248 { "dns_retry", opt_int, &dns_retry },
249 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
250 { "dns_use_edns0", opt_int, &dns_use_edns0 },
251 /* This option is now a no-op, retained for compability */
252 { "drop_cr", opt_bool, &drop_cr },
253 /*********************************************************/
254 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
255 { "dsn_from", opt_stringptr, &dsn_from },
256 { "envelope_to_remove", opt_bool, &envelope_to_remove },
257 { "errors_copy", opt_stringptr, &errors_copy },
258 { "errors_reply_to", opt_stringptr, &errors_reply_to },
259 #ifndef DISABLE_EVENT
260 { "event_action", opt_stringptr, &event_action },
262 { "exim_group", opt_gid, &exim_gid },
263 { "exim_path", opt_stringptr, &exim_path },
264 { "exim_user", opt_uid, &exim_uid },
265 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
266 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
267 { "finduser_retries", opt_int, &finduser_retries },
268 { "freeze_tell", opt_stringptr, &freeze_tell },
269 { "gecos_name", opt_stringptr, &gecos_name },
270 { "gecos_pattern", opt_stringptr, &gecos_pattern },
272 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
273 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
274 /* These three gnutls_require_* options stopped working in Exim 4.80 */
275 /* From 4.83 we log a warning; a future relase will remove them */
276 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
277 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
278 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
280 { "header_line_maxsize", opt_int, &header_line_maxsize },
281 { "header_maxsize", opt_int, &header_maxsize },
282 { "headers_charset", opt_stringptr, &headers_charset },
283 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
284 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
285 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
286 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
287 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
288 { "hold_domains", opt_stringptr, &hold_domains },
289 { "host_lookup", opt_stringptr, &host_lookup },
290 { "host_lookup_order", opt_stringptr, &host_lookup_order },
291 { "host_reject_connection", opt_stringptr, &host_reject_connection },
292 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
294 { "hosts_proxy", opt_stringptr, &hosts_proxy },
296 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
298 { "ibase_servers", opt_stringptr, &ibase_servers },
300 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
301 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
302 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
303 { "keep_environment", opt_stringptr, &keep_environment },
304 { "keep_malformed", opt_time, &keep_malformed },
306 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
307 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
308 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
309 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
310 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
311 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
312 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
313 { "ldap_start_tls", opt_bool, &eldap_start_tls },
314 { "ldap_version", opt_int, &eldap_version },
316 { "local_from_check", opt_bool, &local_from_check },
317 { "local_from_prefix", opt_stringptr, &local_from_prefix },
318 { "local_from_suffix", opt_stringptr, &local_from_suffix },
319 { "local_interfaces", opt_stringptr, &local_interfaces },
320 { "local_scan_timeout", opt_time, &local_scan_timeout },
321 { "local_sender_retain", opt_bool, &local_sender_retain },
322 { "localhost_number", opt_stringptr, &host_number_string },
323 { "log_file_path", opt_stringptr, &log_file_path },
324 { "log_selector", opt_stringptr, &log_selector_string },
325 { "log_timezone", opt_bool, &log_timezone },
326 { "lookup_open_max", opt_int, &lookup_open_max },
327 { "max_username_length", opt_int, &max_username_length },
328 { "message_body_newlines", opt_bool, &message_body_newlines },
329 { "message_body_visible", opt_mkint, &message_body_visible },
330 { "message_id_header_domain", opt_stringptr, &message_id_domain },
331 { "message_id_header_text", opt_stringptr, &message_id_text },
332 { "message_logs", opt_bool, &message_logs },
333 { "message_size_limit", opt_stringptr, &message_size_limit },
334 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
335 { "move_frozen_messages", opt_bool, &move_frozen_messages },
337 { "mua_wrapper", opt_bool, &mua_wrapper },
339 { "mysql_servers", opt_stringptr, &mysql_servers },
341 { "never_users", opt_uidlist, &never_users },
343 { "openssl_options", opt_stringptr, &openssl_options },
346 { "oracle_servers", opt_stringptr, &oracle_servers },
348 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
350 { "perl_at_start", opt_bool, &opt_perl_at_start },
351 { "perl_startup", opt_stringptr, &opt_perl_startup },
354 { "pgsql_servers", opt_stringptr, &pgsql_servers },
356 { "pid_file_path", opt_stringptr, &pid_file_path },
357 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
359 { "prdr_enable", opt_bool, &prdr_enable },
361 { "preserve_message_logs", opt_bool, &preserve_message_logs },
362 { "primary_hostname", opt_stringptr, &primary_hostname },
363 { "print_topbitchars", opt_bool, &print_topbitchars },
364 { "process_log_path", opt_stringptr, &process_log_path },
365 { "prod_requires_admin", opt_bool, &prod_requires_admin },
366 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
367 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
368 { "queue_domains", opt_stringptr, &queue_domains },
369 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
370 { "queue_only", opt_bool, &queue_only },
371 { "queue_only_file", opt_stringptr, &queue_only_file },
372 { "queue_only_load", opt_fixed, &queue_only_load },
373 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
374 { "queue_only_override", opt_bool, &queue_only_override },
375 { "queue_run_in_order", opt_bool, &queue_run_in_order },
376 { "queue_run_max", opt_int, &queue_run_max },
377 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
378 { "receive_timeout", opt_time, &receive_timeout },
379 { "received_header_text", opt_stringptr, &received_header_text },
380 { "received_headers_max", opt_int, &received_headers_max },
381 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
382 { "recipients_max", opt_int, &recipients_max },
383 { "recipients_max_reject", opt_bool, &recipients_max_reject },
385 { "redis_servers", opt_stringptr, &redis_servers },
387 { "remote_max_parallel", opt_int, &remote_max_parallel },
388 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
389 { "retry_data_expire", opt_time, &retry_data_expire },
390 { "retry_interval_max", opt_time, &retry_interval_max },
391 { "return_path_remove", opt_bool, &return_path_remove },
392 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
393 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
394 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
395 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
396 { "slow_lookup_log", opt_int, &slow_lookup_log },
397 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
398 { "smtp_accept_max", opt_int, &smtp_accept_max },
399 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
400 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
401 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
402 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
403 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
404 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
405 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
406 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
407 { "smtp_banner", opt_stringptr, &smtp_banner },
408 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
409 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
410 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
411 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
412 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
413 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
414 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
415 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
416 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
417 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
418 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
419 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
420 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
421 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
423 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
425 #ifdef WITH_CONTENT_SCAN
426 { "spamd_address", opt_stringptr, &spamd_address },
428 #ifdef EXPERIMENTAL_SPF
429 { "spf_guess", opt_stringptr, &spf_guess },
431 { "split_spool_directory", opt_bool, &split_spool_directory },
432 { "spool_directory", opt_stringptr, &spool_directory },
434 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
436 #ifdef EXPERIMENTAL_SRS
437 { "srs_config", opt_stringptr, &srs_config },
438 { "srs_hashlength", opt_int, &srs_hashlength },
439 { "srs_hashmin", opt_int, &srs_hashmin },
440 { "srs_maxage", opt_int, &srs_maxage },
441 { "srs_secrets", opt_stringptr, &srs_secrets },
442 { "srs_usehash", opt_bool, &srs_usehash },
443 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
445 { "strict_acl_vars", opt_bool, &strict_acl_vars },
446 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
447 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
448 { "syslog_duplication", opt_bool, &syslog_duplication },
449 { "syslog_facility", opt_stringptr, &syslog_facility_str },
450 { "syslog_processname", opt_stringptr, &syslog_processname },
451 { "syslog_timestamp", opt_bool, &syslog_timestamp },
452 { "system_filter", opt_stringptr, &system_filter },
453 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
454 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
455 { "system_filter_group", opt_gid, &system_filter_gid },
456 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
457 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
458 { "system_filter_user", opt_uid, &system_filter_uid },
459 { "tcp_nodelay", opt_bool, &tcp_nodelay },
460 #ifdef USE_TCP_WRAPPERS
461 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
463 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
464 { "timezone", opt_stringptr, &timezone_string },
465 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
467 { "tls_certificate", opt_stringptr, &tls_certificate },
468 { "tls_crl", opt_stringptr, &tls_crl },
469 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
470 { "tls_dhparam", opt_stringptr, &tls_dhparam },
471 { "tls_eccurve", opt_stringptr, &tls_eccurve },
472 # ifndef DISABLE_OCSP
473 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
475 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
476 { "tls_privatekey", opt_stringptr, &tls_privatekey },
477 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
478 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
479 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
480 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
481 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
483 { "trusted_groups", opt_gidlist, &trusted_groups },
484 { "trusted_users", opt_uidlist, &trusted_users },
485 { "unknown_login", opt_stringptr, &unknown_login },
486 { "unknown_username", opt_stringptr, &unknown_username },
487 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
488 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
489 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
490 { "warn_message_file", opt_stringptr, &warn_message_file },
491 { "write_rejectlog", opt_bool, &write_rejectlog }
494 static int optionlist_config_size =
495 sizeof(optionlist_config)/sizeof(optionlist);
499 /*************************************************
500 * Find the name of an option *
501 *************************************************/
503 /* This function is to aid debugging. Various functions take arguments that are
504 pointer variables in the options table or in option tables for various drivers.
505 For debugging output, it is useful to be able to find the name of the option
506 which is currently being processed. This function finds it, if it exists, by
507 searching the table(s).
509 Arguments: a value that is presumed to be in the table above
510 Returns: the option name, or an empty string
514 readconf_find_option(void *p)
518 transport_instance *t;
520 for (i = 0; i < optionlist_config_size; i++)
521 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
523 for (r = routers; r != NULL; r = r->next)
525 router_info *ri = r->info;
526 for (i = 0; i < *ri->options_count; i++)
528 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
529 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
530 return US ri->options[i].name;
534 for (t = transports; t != NULL; t = t->next)
536 transport_info *ti = t->info;
537 for (i = 0; i < *ti->options_count; i++)
539 optionlist * op = &ti->options[i];
540 if ((op->type & opt_mask) != opt_stringptr) continue;
541 if (p == ( op->type & opt_public
543 : (char *)t->options_block
545 + (long int)op->value)
556 /*************************************************
557 * Deal with an assignment to a macro *
558 *************************************************/
560 /* This function is called when a line that starts with an upper case letter is
561 encountered. The argument "line" should contain a complete logical line, and
562 start with the first letter of the macro name. The macro name and the
563 replacement text are extracted and stored. Redefinition of existing,
564 non-command line, macros is permitted using '==' instead of '='.
567 s points to the start of the logical line
573 read_macro_assignment(uschar *s)
579 macro_item *mlast = NULL;
581 while (isalnum(*s) || *s == '_')
583 if (namelen >= sizeof(name) - 1)
584 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
585 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
586 name[namelen++] = *s++;
590 while (isspace(*s)) s++;
592 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
599 while (isspace(*s)) s++;
601 /* If an existing macro of the same name was defined on the command line, we
602 just skip this definition. It's an error to attempt to redefine a macro without
603 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
604 It is also an error to define a macro whose name begins with the name of a
605 previously defined macro. Note: it is documented that the other way round
608 for (m = macros; m != NULL; m = m->next)
610 int len = Ustrlen(m->name);
612 if (Ustrcmp(m->name, name) == 0)
614 if (!m->command_line && !redef)
615 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
616 "defined (use \"==\" if you want to redefine it", name);
620 if (len < namelen && Ustrstr(name, m->name) != NULL)
621 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
622 "a macro because previously defined macro \"%s\" is a substring",
625 /* We cannot have this test, because it is documented that a substring
626 macro is permitted (there is even an example).
628 * if (len > namelen && Ustrstr(m->name, name) != NULL)
629 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
630 * "a macro because it is a substring of previously defined macro \"%s\"",
637 /* Check for an overriding command-line definition. */
639 if (m != NULL && m->command_line) return;
641 /* Redefinition must refer to an existing macro. */
646 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
650 /* We have a new definition. The macro_item structure includes a final vector
651 called "name" which is one byte long. Thus, adding "namelen" gives us enough
652 room to store the "name" string. */
656 m = store_get(sizeof(macro_item) + namelen);
657 if (macros == NULL) macros = m; else mlast->next = m;
658 Ustrncpy(m->name, name, namelen);
659 m->name[namelen] = 0;
661 m->command_line = FALSE;
664 /* Set the value of the new or redefined macro */
666 m->replacement = string_copy(s);
673 /*************************************************
674 * Read configuration line *
675 *************************************************/
677 /* A logical line of text is read from the configuration file into the big
678 buffer, taking account of macros, .includes, and continuations. The size of
679 big_buffer is increased if necessary. The count of configuration lines is
680 maintained. Physical input lines starting with # (ignoring leading white space,
681 and after macro replacement) and empty logical lines are always ignored.
682 Leading and trailing spaces are removed.
684 If we hit a line of the form "begin xxxx", the xxxx is placed in the
685 next_section vector, and the function returns NULL, indicating the end of a
686 configuration section. On end-of-file, NULL is returned with next_section
691 Returns: a pointer to the first non-blank in the line,
692 or NULL if eof or end of section is reached
696 get_config_line(void)
698 int startoffset = 0; /* To first non-blank char in logical line */
699 int len = 0; /* Of logical line so far */
705 /* Loop for handling continuation lines, skipping comments, and dealing with
710 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
712 if (config_file_stack != NULL) /* EOF inside .include */
714 (void)fclose(config_file);
715 config_file = config_file_stack->file;
716 config_filename = config_file_stack->filename;
717 config_lineno = config_file_stack->lineno;
718 config_file_stack = config_file_stack->next;
720 save_config_position(config_filename, config_lineno);
724 /* EOF at top level */
726 if (cstate_stack_ptr >= 0)
727 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
728 "Unexpected end of configuration file: .endif missing");
730 if (len != 0) break; /* EOF after continuation */
731 next_section[0] = 0; /* EOF at start of logical line */
736 newlen = len + Ustrlen(big_buffer + len);
738 if (config_lines && config_lineno == 1)
739 save_config_position(config_filename, config_lineno);
741 /* Handle pathologically long physical lines - yes, it did happen - by
742 extending big_buffer at this point. The code also copes with very long
745 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
748 big_buffer_size += BIG_BUFFER_SIZE;
749 newbuffer = store_malloc(big_buffer_size);
751 /* This use of strcpy is OK because we know that the string in the old
752 buffer is shorter than the new buffer. */
754 Ustrcpy(newbuffer, big_buffer);
755 store_free(big_buffer);
756 big_buffer = newbuffer;
757 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
759 newlen += Ustrlen(big_buffer + newlen);
762 /* Find the true start of the physical line - leading spaces are always
765 ss = big_buffer + len;
766 while (isspace(*ss)) ss++;
768 /* Process the physical line for macros. If this is the start of the logical
769 line, skip over initial text at the start of the line if it starts with an
770 upper case character followed by a sequence of name characters and an equals
771 sign, because that is the definition of a new macro, and we don't do
772 replacement therein. */
775 if (len == 0 && isupper(*s))
777 while (isalnum(*s) || *s == '_') s++;
778 while (isspace(*s)) s++;
779 if (*s != '=') s = ss; /* Not a macro definition */
782 /* For each defined macro, scan the line (from after XXX= if present),
783 replacing all occurrences of the macro. */
786 for (m = macros; m != NULL; m = m->next)
791 while ((p = Ustrstr(t, m->name)) != NULL)
794 int namelen = Ustrlen(m->name);
795 int replen = Ustrlen(m->replacement);
797 /* Expand the buffer if necessary */
799 while (newlen - namelen + replen + 1 > big_buffer_size)
801 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
802 uschar *newbuffer = store_malloc(newsize);
803 memcpy(newbuffer, big_buffer, newlen + 1);
804 p = newbuffer + (p - big_buffer);
805 s = newbuffer + (s - big_buffer);
806 ss = newbuffer + (ss - big_buffer);
807 t = newbuffer + (t - big_buffer);
808 big_buffer_size = newsize;
809 store_free(big_buffer);
810 big_buffer = newbuffer;
813 /* Shuffle the remaining characters up or down in the buffer before
814 copying in the replacement text. Don't rescan the replacement for this
818 moveby = replen - namelen;
821 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
824 Ustrncpy(p, m->replacement, replen);
830 /* An empty macro replacement at the start of a line could mean that ss no
831 longer points to the first non-blank character. */
833 while (isspace(*ss)) ss++;
835 /* Check for comment lines - these are physical lines. */
837 if (*ss == '#') continue;
839 /* Handle conditionals, which are also applied to physical lines. Conditions
840 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
841 expansion occured on the rest of the line. A preliminary test for the leading
842 '.' saves effort on most lines. */
848 /* Search the list of conditional directives */
850 for (i = 0; i < cond_list_size; i++)
853 cond_item *c = cond_list+i;
854 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
856 /* The following character must be white space or end of string */
858 n = ss[1 + c->namelen];
859 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
861 /* .ifdef and .ifndef push the current state onto the stack, then set
862 a new one from the table. Stack overflow is an error */
866 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
867 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
868 ".%s nested too deeply", c->name);
869 cstate_stack[++cstate_stack_ptr] = cstate;
870 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
873 /* For any of the others, stack underflow is an error. The next state
874 comes either from the stack (.endif) or from the table. */
878 if (cstate_stack_ptr < 0)
879 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
880 ".%s without matching .ifdef", c->name);
881 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
882 next_cstate[cstate][macro_found? c->action1 : c->action2];
885 /* Having dealt with a directive, break the loop */
890 /* If we have handled a conditional directive, continue with the next
891 physical line. Otherwise, fall through. */
893 if (i < cond_list_size) continue;
896 /* If the conditional state is not 0 (actively using these lines), ignore
899 if (cstate != 0) continue; /* Conditional skip */
901 /* Handle .include lines - these are also physical lines. */
903 if (Ustrncmp(ss, ".include", 8) == 0 &&
905 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
908 int include_if_exists = isspace(ss[8])? 0 : 10;
909 config_file_item *save;
912 ss += 9 + include_if_exists;
913 while (isspace(*ss)) ss++;
914 t = ss + Ustrlen(ss);
915 while (t > ss && isspace(t[-1])) t--;
916 if (*ss == '\"' && t[-1] == '\"')
924 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
925 "absolute path \"%s\"", ss);
927 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
930 save_config_position(config_filename, config_lineno);
931 save = store_get(sizeof(config_file_item));
932 save->next = config_file_stack;
933 config_file_stack = save;
934 save->file = config_file;
935 save->filename = config_filename;
936 save->lineno = config_lineno;
938 config_file = Ufopen(ss, "rb");
939 if (config_file == NULL)
940 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
941 "configuration file %s", ss);
942 config_filename = string_copy(ss);
947 /* If this is the start of the logical line, remember where the non-blank
948 data starts. Otherwise shuffle down continuation lines to remove leading
952 startoffset = ss - big_buffer;
955 s = big_buffer + len;
958 memmove(s, ss, (newlen - len) - (ss - s) + 1);
963 /* Accept the new addition to the line. Remove trailing white space. */
966 while (len > 0 && isspace(big_buffer[len-1])) len--;
969 /* We are done if the line does not end in backslash and contains some data.
970 Empty logical lines are ignored. For continuations, remove the backslash and
971 go round the loop to read the continuation line. */
975 if (big_buffer[len-1] != '\\') break; /* End of logical line */
976 big_buffer[--len] = 0; /* Remove backslash */
978 } /* Loop for reading multiple physical lines */
980 /* We now have a logical line. Test for the end of a configuration section (or,
981 more accurately, for the start of the next section). Place the name of the next
982 section in next_section, and return NULL. If the name given is longer than
983 next_section, truncate it. It will be unrecognized later, because all the known
984 section names do fit. Leave space for pluralizing. */
986 s = big_buffer + startoffset; /* First non-space character */
991 if (strncmpic(s, US"begin ", 6) == 0)
994 while (isspace(*s)) s++;
995 if (big_buffer + len - s > sizeof(next_section) - 2)
996 s[sizeof(next_section) - 2] = 0;
997 Ustrcpy(next_section, s);
1001 /* Return the first non-blank character. */
1008 /*************************************************
1010 *************************************************/
1012 /* The yield is the pointer to the next uschar. Names longer than the
1013 output space are silently truncated. This function is also used from acl.c when
1017 name where to put the name
1021 Returns: new input pointer
1025 readconf_readname(uschar *name, int len, uschar *s)
1028 while (isspace(*s)) s++;
1031 while (isalnum(*s) || *s == '_')
1033 if (p < len-1) name[p++] = *s;
1038 while (isspace(*s)) s++;
1045 /*************************************************
1046 * Read a time value *
1047 *************************************************/
1049 /* This function is also called from outside, to read argument
1050 time values. The format of a time value is:
1052 [<n>w][<n>d][<n>h][<n>m][<n>s]
1054 as long as at least one is present. If a format error is encountered,
1055 return a negative value. The value must be terminated by the given
1060 terminator required terminating character
1061 return_msec if TRUE, allow fractional seconds and return milliseconds
1063 Returns: the time value, or -1 on syntax error
1064 value is seconds if return_msec is FALSE
1065 value is milliseconds if return_msec is TRUE
1069 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1077 if (!isdigit(*s)) return -1;
1078 (void)sscanf(CCS s, "%d%n", &value, &count);
1083 case 'w': value *= 7;
1084 case 'd': value *= 24;
1085 case 'h': value *= 60;
1086 case 'm': value *= 60;
1091 if (!return_msec) return -1;
1092 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1094 if (*s++ != 's') return -1;
1095 yield += (int)(fraction * 1000.0);
1101 if (return_msec) value *= 1000;
1103 if (*s == terminator) return yield;
1105 /* Control never reaches here. */
1110 /*************************************************
1111 * Read a fixed point value *
1112 *************************************************/
1114 /* The value is returned *1000
1118 terminator required terminator
1120 Returns: the value, or -1 on error
1124 readconf_readfixed(const uschar *s, int terminator)
1128 if (!isdigit(*s)) return -1;
1129 (void)sscanf(CS s, "%d%n", &value, &count);
1131 yield = value * 1000;
1135 while (isdigit((*(++s))))
1137 yield += (*s - '0') * m;
1142 return (*s == terminator)? yield : (-1);
1147 /*************************************************
1148 * Find option in list *
1149 *************************************************/
1151 /* The lists are always in order, so binary chop can be used.
1154 name the option name to search for
1155 ol the first entry in the option list
1156 last one more than the offset of the last entry in the option list
1158 Returns: pointer to an option entry, or NULL if not found
1162 find_option(uschar *name, optionlist *ol, int last)
1165 while (last > first)
1167 int middle = (first + last)/2;
1168 int c = Ustrcmp(name, ol[middle].name);
1169 if (c == 0) return ol + middle;
1170 else if (c > 0) first = middle + 1;
1178 /*************************************************
1179 * Find a set flag in option list *
1180 *************************************************/
1182 /* Because some versions of Unix make no restrictions on the values of uids and
1183 gids (even negative ones), we cannot represent "unset" by a special value.
1184 There is therefore a separate boolean variable for each one indicating whether
1185 a value is set or not. This function returns a pointer to the boolean, given
1186 the original option name. It is a major disaster if the flag cannot be found.
1189 name the name of the uid or gid option
1190 oltop points to the start of the relevant option list
1191 last one more than the offset of the last item in the option list
1192 data_block NULL when reading main options => data values in the option
1193 list are absolute addresses; otherwise they are byte offsets
1194 in data_block (used for driver options)
1196 Returns: a pointer to the boolean flag.
1200 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1204 sprintf(CS name2, "*set_%.50s", name);
1205 ol = find_option(name2, oltop, last);
1206 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1207 "Exim internal error: missing set flag for %s", name);
1208 return (data_block == NULL)? (BOOL *)(ol->value) :
1209 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1215 /*************************************************
1216 * Output extra characters message and die *
1217 *************************************************/
1219 /* Called when an option line has junk on the end. Sometimes this is because
1220 the sysadmin thinks comments are permitted.
1223 s points to the extra characters
1224 t1..t3 strings to insert in the log message
1226 Returns: doesn't return; dies
1230 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1232 uschar *comment = US"";
1233 if (*s == '#') comment = US" (# is comment only at line start)";
1234 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1235 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1240 /*************************************************
1241 * Read rewrite information *
1242 *************************************************/
1244 /* Each line of rewrite information contains:
1246 . A complete address in the form user@domain, possibly with
1247 leading * for each part; or alternatively, a regex.
1249 . A replacement string (which will be expanded).
1251 . An optional sequence of one-letter flags, indicating which
1252 headers etc. to apply this rule to.
1254 All this is decoded and placed into a control block. The OR of the flags is
1255 maintained in a common word.
1258 p points to the string that makes up the rule
1259 existflags points to the overall flag word
1260 isglobal TRUE if reading global rewrite rules
1262 Returns: the control block for the parsed rule.
1265 static rewrite_rule *
1266 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1268 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1271 next->key = string_dequote(&p);
1273 while (isspace(*p)) p++;
1275 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1276 "missing rewrite replacement string");
1279 next->replacement = string_dequote(&p);
1281 while (*p != 0) switch (*p++)
1283 case ' ': case '\t': break;
1285 case 'q': next->flags |= rewrite_quit; break;
1286 case 'w': next->flags |= rewrite_whole; break;
1288 case 'h': next->flags |= rewrite_all_headers; break;
1289 case 's': next->flags |= rewrite_sender; break;
1290 case 'f': next->flags |= rewrite_from; break;
1291 case 't': next->flags |= rewrite_to; break;
1292 case 'c': next->flags |= rewrite_cc; break;
1293 case 'b': next->flags |= rewrite_bcc; break;
1294 case 'r': next->flags |= rewrite_replyto; break;
1296 case 'E': next->flags |= rewrite_all_envelope; break;
1297 case 'F': next->flags |= rewrite_envfrom; break;
1298 case 'T': next->flags |= rewrite_envto; break;
1300 case 'Q': next->flags |= rewrite_qualify; break;
1301 case 'R': next->flags |= rewrite_repeat; break;
1304 next->flags |= rewrite_smtp;
1305 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1306 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1307 "rewrite rule has the S flag but is not a regular expression");
1311 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1312 "unknown rewrite flag character '%c' "
1313 "(could be missing quotes round replacement item)", p[-1]);
1317 /* If no action flags are set, set all the "normal" rewrites. */
1319 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1320 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1322 /* Remember which exist, for optimization, and return the rule */
1324 *existflags |= next->flags;
1331 /*************************************************
1332 * Read global rewrite information *
1333 *************************************************/
1335 /* Each line is a single rewrite rule; it is parsed into a control block
1336 by readconf_one_rewrite(), and its flags are ORed into the global flag
1337 word rewrite_existflags. */
1340 readconf_rewrites(void)
1342 rewrite_rule **chain = &global_rewrite_rules;
1345 while ((p = get_config_line()) != NULL)
1347 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1349 chain = &(next->next);
1355 /*************************************************
1357 *************************************************/
1359 /* Strings are read into the normal store pool. As long we aren't too
1360 near the end of the current block, the string will just use what is necessary
1361 on the top of the stacking pool, because string_cat() uses the extension
1365 s the rest of the input line
1366 name the option name (for errors)
1368 Returns: pointer to the string
1372 read_string(const uschar *s, const uschar *name)
1377 if (*s != '\"') return string_copy(s);
1380 yield = string_dequote(&s);
1382 if (s == ss+1 || s[-1] != '\"')
1383 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1384 "missing quote at end of string value for %s", name);
1386 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1392 /*************************************************
1393 * Custom-handler options *
1394 *************************************************/
1396 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1399 smtp_receive_timeout_s = string_copy(str);
1402 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1403 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1404 if (smtp_receive_timeout < 0)
1405 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1410 /*************************************************
1411 * Handle option line *
1412 *************************************************/
1414 /* This function is called from several places to process a line containing the
1415 setting of an option. The first argument is the line to be decoded; it has been
1416 checked not to be empty and not to start with '#'. Trailing newlines and white
1417 space have been removed. The second argument is a pointer to the list of
1418 variable names that are to be recognized, together with their types and
1419 locations, and the third argument gives the number of entries in the list.
1421 The fourth argument is a pointer to a data block. If it is NULL, then the data
1422 values in the options list are absolute addresses. Otherwise, they are byte
1423 offsets in the data block.
1425 String option data may continue onto several lines; this function reads further
1426 data from config_file if necessary.
1428 The yield of this function is normally zero. If a string continues onto
1429 multiple lines, then the data value is permitted to be followed by a comma
1430 or a semicolon (for use in drivers) and the yield is that character.
1433 buffer contains the configuration line to be handled
1434 oltop points to the start of the relevant option list
1435 last one more than the offset of the last item in the option list
1436 data_block NULL when reading main options => data values in the option
1437 list are absolute addresses; otherwise they are byte offsets
1438 in data_block when they have opt_public set; otherwise
1439 they are byte offsets in data_block->options_block.
1440 unknown_txt format string to use in panic message for unknown option;
1441 must contain %s for option name
1442 if given as NULL, don't panic on unknown option
1444 Returns: TRUE if an option was read successfully,
1445 FALSE false for an unknown option if unknown_txt == NULL,
1446 otherwise panic and die on an unknown option
1450 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1451 void *data_block, uschar *unknown_txt)
1455 int n, count, type, value;
1459 BOOL boolvalue = TRUE;
1460 BOOL freesptr = TRUE;
1461 optionlist *ol, *ol2;
1465 uschar *inttype = US"";
1468 uschar *saved_condition, *strtemp;
1469 uschar **str_target;
1473 /* There may be leading spaces; thereafter, we expect an option name starting
1476 while (isspace(*s)) s++;
1478 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1480 /* Read the name of the option, and skip any subsequent white space. If
1481 it turns out that what we read was "hide", set the flag indicating that
1482 this is a secure option, and loop to read the next word. */
1484 for (n = 0; n < 2; n++)
1486 while (isalnum(*s) || *s == '_')
1488 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1492 while (isspace(*s)) s++;
1493 if (Ustrcmp(name, "hide") != 0) break;
1494 issecure = opt_secure;
1498 /* Deal with "no_" or "not_" here for booleans */
1500 if (Ustrncmp(name, "no_", 3) == 0)
1506 if (Ustrncmp(name, "not_", 4) == 0)
1512 /* Search the list for the given name. A non-existent name, or an option that
1513 is set twice, is a disaster. */
1515 ol = find_option(name + offset, oltop, last);
1519 if (unknown_txt == NULL) return FALSE;
1520 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1523 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1524 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1525 "\"%s\" option set for the second time", name);
1527 ol->type |= opt_set | issecure;
1528 type = ol->type & opt_mask;
1530 /* Types with data values must be followed by '='; the "no[t]_" prefix
1531 applies only to boolean values. */
1533 if (type < opt_bool || type > opt_bool_last)
1536 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1537 "negation prefix applied to a non-boolean option");
1539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1540 "unexpected end of line (data missing) after %s", name);
1542 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1545 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1546 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1547 ultimately expands to one of those values. */
1549 else if (*s != 0 && (offset != 0 || *s != '='))
1550 extra_chars_error(s, US"boolean option ", name, US"");
1552 /* Skip white space after = */
1554 if (*s == '=') while (isspace((*(++s))));
1556 /* If there is a data block and the opt_public flag is not set, change
1557 the data block pointer to the private options block. */
1559 if (data_block != NULL && (ol->type & opt_public) == 0)
1560 data_block = (void *)(((driver_instance *)data_block)->options_block);
1562 /* Now get the data according to the type. */
1566 /* If a string value is not enclosed in quotes, it consists of
1567 the rest of the current line, verbatim. Otherwise, string escapes
1570 A transport is specified as a string, which is then looked up in the
1571 list of transports. A search type is specified as one of a number of
1574 A set or rewrite rules for a driver is specified as a string, which is
1575 then parsed into a suitable chain of control blocks.
1577 Uids and gids are specified as strings which are then looked up in the
1578 passwd file. Lists of uids and gids are similarly specified as colon-
1579 separated strings. */
1584 case opt_expand_uid:
1585 case opt_expand_gid:
1590 reset_point = sptr = read_string(s, name);
1592 /* Having read a string, we now have several different ways of using it,
1593 depending on the data type, so do another switch. If keeping the actual
1594 string is not required (because it is interpreted), freesptr is set TRUE,
1595 and at the end we reset the pool. */
1599 /* If this was a string, set the variable to point to the new string,
1600 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1601 rules, we still keep the string (for printing), and parse the rules into a
1602 control block and flags word. */
1605 if (data_block == NULL)
1606 str_target = (uschar **)(ol->value);
1608 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1609 if (ol->type & opt_rep_con)
1611 /* We already have a condition, we're conducting a crude hack to let
1612 multiple condition rules be chained together, despite storing them in
1614 saved_condition = *str_target;
1615 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1616 saved_condition, sptr);
1617 *str_target = string_copy_malloc(strtemp);
1618 /* TODO(pdp): there is a memory leak here and just below
1619 when we set 3 or more conditions; I still don't
1620 understand the store mechanism enough to know
1621 what's the safe way to free content from an earlier store.
1622 AFAICT, stores stack, so freeing an early stored item also stores
1623 all data alloc'd after it. If we knew conditions were adjacent,
1624 we could survive that, but we don't. So I *think* we need to take
1625 another bit from opt_type to indicate "malloced"; this seems like
1626 quite a hack, especially for this one case. It also means that
1627 we can't ever reclaim the store from the *first* condition.
1629 Because we only do this once, near process start-up, I'm prepared to
1630 let this slide for the time being, even though it rankles. */
1632 else if (ol->type & opt_rep_str)
1634 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1635 int sep_i = -(int)sep_o;
1636 const uschar * list = sptr;
1638 uschar * list_o = *str_target;
1640 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1641 list_o = string_append_listele(list_o, sep_o, s);
1643 *str_target = string_copy_malloc(list_o);
1653 if (data_block == NULL)
1654 *((uschar **)(ol->value)) = sptr;
1656 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1658 if (type == opt_rewrite)
1663 rewrite_rule **chain;
1666 sprintf(CS name2, "*%.50s_rules", name);
1667 ol2 = find_option(name2, oltop, last);
1668 sprintf(CS name2, "*%.50s_flags", name);
1669 ol3 = find_option(name2, oltop, last);
1671 if (ol2 == NULL || ol3 == NULL)
1672 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1673 "rewrite rules not available for driver");
1675 if (data_block == NULL)
1677 chain = (rewrite_rule **)(ol2->value);
1678 flagptr = (int *)(ol3->value);
1682 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1683 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1686 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1688 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1690 chain = &(next->next);
1693 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1694 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1695 "non-header rewrite - not allowed at transport time -");
1699 /* If it was an expanded uid, see if there is any expansion to be
1700 done by checking for the presence of a $ character. If there is, save it
1701 in the corresponding *expand_user option field. Otherwise, fall through
1702 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1705 case opt_expand_uid:
1706 sprintf(CS name2, "*expand_%.50s", name);
1707 ol2 = find_option(name2, oltop, last);
1710 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1712 if (data_block == NULL)
1713 *((uschar **)(ol2->value)) = ss;
1715 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1719 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1725 /* Look up a fixed uid, and also make use of the corresponding gid
1726 if a passwd entry is returned and the gid has not been set. */
1729 if (!route_finduser(sptr, &pw, &uid))
1730 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1731 if (data_block == NULL)
1732 *((uid_t *)(ol->value)) = uid;
1734 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1736 /* Set the flag indicating a fixed value is set */
1738 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1740 /* Handle matching gid if we have a passwd entry: done by finding the
1741 same name with terminating "user" changed to "group"; if not found,
1742 ignore. Also ignore if the value is already set. */
1744 if (pw == NULL) break;
1745 Ustrcpy(name+Ustrlen(name)-4, "group");
1746 ol2 = find_option(name, oltop, last);
1747 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1748 (ol2->type & opt_mask) == opt_expand_gid))
1750 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1753 if (data_block == NULL)
1754 *((gid_t *)(ol2->value)) = pw->pw_gid;
1756 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1762 /* If it was an expanded gid, see if there is any expansion to be
1763 done by checking for the presence of a $ character. If there is, save it
1764 in the corresponding *expand_user option field. Otherwise, fall through
1765 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1768 case opt_expand_gid:
1769 sprintf(CS name2, "*expand_%.50s", name);
1770 ol2 = find_option(name2, oltop, last);
1773 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1775 if (data_block == NULL)
1776 *((uschar **)(ol2->value)) = ss;
1778 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1782 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1788 /* Handle freestanding gid */
1791 if (!route_findgroup(sptr, &gid))
1792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1793 if (data_block == NULL)
1794 *((gid_t *)(ol->value)) = gid;
1796 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1797 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1800 /* If it was a uid list, look up each individual entry, and build
1801 a vector of uids, with a count in the first element. Put the vector
1802 in malloc store so we can free the string. (We are reading into
1803 permanent store already.) */
1811 const uschar *op = expand_string (sptr);
1814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1815 name, expand_string_message);
1818 if (*p != 0) count++;
1819 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1820 list = store_malloc(count*sizeof(uid_t));
1821 list[ptr++] = (uid_t)(count - 1);
1823 if (data_block == NULL)
1824 *((uid_t **)(ol->value)) = list;
1826 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1832 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1833 if (!route_finduser(big_buffer, NULL, &uid))
1834 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1841 /* If it was a gid list, look up each individual entry, and build
1842 a vector of gids, with a count in the first element. Put the vector
1843 in malloc store so we can free the string. (We are reading into permanent
1852 const uschar *op = expand_string (sptr);
1855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1856 name, expand_string_message);
1859 if (*p != 0) count++;
1860 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1861 list = store_malloc(count*sizeof(gid_t));
1862 list[ptr++] = (gid_t)(count - 1);
1864 if (data_block == NULL)
1865 *((gid_t **)(ol->value)) = list;
1867 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1873 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1874 if (!route_findgroup(big_buffer, &gid))
1875 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1883 /* Release store if the value of the string doesn't need to be kept. */
1885 if (freesptr) store_reset(reset_point);
1888 /* Expanded boolean: if no characters follow, or if there are no dollar
1889 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1890 save the string for later expansion in the alternate place. */
1892 case opt_expand_bool:
1893 if (*s != 0 && Ustrchr(s, '$') != 0)
1895 sprintf(CS name2, "*expand_%.50s", name);
1896 ol2 = find_option(name2, oltop, last);
1899 reset_point = sptr = read_string(s, name);
1900 if (data_block == NULL)
1901 *((uschar **)(ol2->value)) = sptr;
1903 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1910 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1911 look for yes/not/true/false. Some booleans are stored in a single bit in
1912 a single int. There's a special fudge for verify settings; without a suffix
1913 they set both xx_sender and xx_recipient. The table points to the sender
1914 value; search subsequently for the recipient. There's another special case:
1915 opt_bool_set also notes when a boolean has been set. */
1919 case opt_bool_verify:
1923 s = readconf_readname(name2, 64, s);
1924 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1926 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1928 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1929 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1930 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1931 US"for boolean option ", name);
1934 /* Handle single-bit type. */
1936 if (type == opt_bit)
1938 int bit = 1 << ((ol->type >> 16) & 31);
1939 int *ptr = (data_block == NULL)?
1940 (int *)(ol->value) :
1941 (int *)((uschar *)data_block + (long int)ol->value);
1942 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1946 /* Handle full BOOL types */
1948 if (data_block == NULL)
1949 *((BOOL *)(ol->value)) = boolvalue;
1951 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1955 if (type == opt_bool_verify)
1957 sprintf(CS name2, "%.50s_recipient", name + offset);
1958 ol2 = find_option(name2, oltop, last);
1961 if (data_block == NULL)
1962 *((BOOL *)(ol2->value)) = boolvalue;
1964 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1968 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1970 else if (type == opt_bool_set)
1972 sprintf(CS name2, "*set_%.50s", name + offset);
1973 ol2 = find_option(name2, oltop, last);
1976 if (data_block == NULL)
1977 *((BOOL *)(ol2->value)) = TRUE;
1979 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1988 inttype = US"octal ";
1990 /* Integer: a simple(ish) case; allow octal and hex formats, and
1991 suffixes K and M. The different types affect output, not input. */
2000 lvalue = strtol(CS s, CSS &endptr, intbase);
2003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2006 if (errno != ERANGE)
2008 if (tolower(*endptr) == 'k')
2010 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2011 else lvalue *= 1024;
2014 else if (tolower(*endptr) == 'm')
2016 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2018 else lvalue *= 1024*1024;
2023 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2024 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2025 "absolute value of integer \"%s\" is too large (overflow)", s);
2027 while (isspace(*endptr)) endptr++;
2029 extra_chars_error(endptr, inttype, US"integer value for ", name);
2031 value = (int)lvalue;
2034 if (data_block == NULL)
2035 *((int *)(ol->value)) = value;
2037 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2040 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
2042 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2048 value = strtol(CS s, CSS &endptr, intbase);
2051 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2054 if (errno != ERANGE)
2056 if (tolower(*endptr) == 'm')
2058 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
2062 else if (tolower(*endptr) == 'k')
2068 value = (value + 512)/1024;
2072 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2073 "absolute value of integer \"%s\" is too large (overflow)", s);
2075 while (isspace(*endptr)) endptr++;
2077 extra_chars_error(endptr, inttype, US"integer value for ", name);
2080 if (data_block == NULL)
2081 *((int *)(ol->value)) = value;
2083 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2086 /* Fixed-point number: held to 3 decimal places. */
2089 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2090 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2091 "fixed-point number expected for %s", name);
2093 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2094 "integer \"%s\" is too large (overflow)", s);
2098 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2099 "integer \"%s\" is too large (overflow)", s);
2101 if (s[count] == '.')
2104 while (isdigit(s[++count]))
2106 value += (s[count] - '0') * d;
2111 while (isspace(s[count])) count++;
2114 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2116 if (data_block == NULL)
2117 *((int *)(ol->value)) = value;
2119 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2122 /* There's a special routine to read time values. */
2125 value = readconf_readtime(s, 0, FALSE);
2127 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2129 if (data_block == NULL)
2130 *((int *)(ol->value)) = value;
2132 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2135 /* A time list is a list of colon-separated times, with the first
2136 element holding the size of the list and the second the number of
2142 int *list = (data_block == NULL)?
2143 (int *)(ol->value) :
2144 (int *)((uschar *)data_block + (long int)(ol->value));
2146 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2149 uschar *snext = Ustrchr(s, ':');
2153 while (ss > s && isspace(ss[-1])) ss--;
2156 value = readconf_readtime(s, terminator, FALSE);
2158 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2160 if (count > 1 && value <= list[count])
2161 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2162 "time value out of order for %s", name);
2163 list[count+1] = value;
2164 if (snext == NULL) break;
2166 while (isspace(*s)) s++;
2169 if (count > list[0] - 2)
2170 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2172 if (count > 0 && list[2] == 0) count = 0;
2179 void (*fn)() = ol->value;
2190 /*************************************************
2191 * Print a time value *
2192 *************************************************/
2195 Argument: a time value in seconds
2196 Returns: pointer to a fixed buffer containing the time as a string,
2197 in readconf_readtime() format
2201 readconf_printtime(int t)
2204 uschar *p = time_buffer;
2221 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2222 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2223 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2224 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2225 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2232 /*************************************************
2233 * Print an individual option value *
2234 *************************************************/
2236 /* This is used by the -bP option, so prints to the standard output.
2237 The entire options list is passed in as an argument, because some options come
2238 in pairs - typically uid/gid settings, which can either be explicit numerical
2239 values, or strings to be expanded later. If the numerical value is unset,
2240 search for "*expand_<name>" to see if there is a string equivalent.
2243 ol option entry, or NULL for an unknown option
2245 options_block NULL for main configuration options; otherwise points to
2246 a driver block; if the option doesn't have opt_public
2247 set, then options_block->options_block is where the item
2249 oltop points to the option list in which ol exists
2250 last one more than the offset of the last entry in optop
2251 no_labels do not show "foo = " at the start.
2257 print_ol(optionlist *ol, uschar *name, void *options_block,
2258 optionlist *oltop, int last, BOOL no_labels)
2271 printf("%s is not a known option\n", name);
2275 /* Non-admin callers cannot see options that have been flagged secure by the
2278 if (!admin_user && (ol->type & opt_secure) != 0)
2281 printf("%s\n", hidden);
2283 printf("%s = %s\n", name, hidden);
2287 /* Else show the value of the option */
2290 if (options_block != NULL)
2292 if ((ol->type & opt_public) == 0)
2293 options_block = (void *)(((driver_instance *)options_block)->options_block);
2294 value = (void *)((uschar *)options_block + (long int)value);
2297 switch(ol->type & opt_mask)
2300 case opt_rewrite: /* Show the text value */
2301 s = *((uschar **)value);
2302 if (!no_labels) printf("%s = ", name);
2303 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2307 if (!no_labels) printf("%s = ", name);
2308 printf("%d\n", *((int *)value));
2313 int x = *((int *)value);
2314 if (x != 0 && (x & 1023) == 0)
2318 if ((x & 1023) == 0)
2323 if (!no_labels) printf("%s = ", name);
2324 printf("%d%c\n", x, c);
2328 if (!no_labels) printf("%s = ", name);
2336 int x = *((int *)value);
2337 if (!no_labels) printf("%s = ", name);
2338 if (x == 0) printf("0\n");
2339 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2340 else printf("%dK\n", x);
2345 if (!no_labels) printf("%s = ", name);
2346 printf("%#o\n", *((int *)value));
2349 /* Can be negative only when "unset", in which case integer */
2353 int x = *((int *)value);
2356 if (x < 0) printf("%s =\n", name); else
2358 if (!no_labels) printf("%s = ", name);
2359 printf("%d.", x/1000);
2372 /* If the numerical value is unset, try for the string value */
2374 case opt_expand_uid:
2375 if (! *get_set_flag(name, oltop, last, options_block))
2377 sprintf(CS name2, "*expand_%.50s", name);
2378 ol2 = find_option(name2, oltop, last);
2381 void *value2 = ol2->value;
2382 if (options_block != NULL)
2383 value2 = (void *)((uschar *)options_block + (long int)value2);
2384 s = *((uschar **)value2);
2385 if (!no_labels) printf("%s = ", name);
2386 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2391 /* Else fall through */
2394 if (!no_labels) printf("%s = ", name);
2395 if (! *get_set_flag(name, oltop, last, options_block))
2399 pw = getpwuid(*((uid_t *)value));
2401 printf("%ld\n", (long int)(*((uid_t *)value)));
2402 else printf("%s\n", pw->pw_name);
2406 /* If the numerical value is unset, try for the string value */
2408 case opt_expand_gid:
2409 if (! *get_set_flag(name, oltop, last, options_block))
2411 sprintf(CS name2, "*expand_%.50s", name);
2412 ol2 = find_option(name2, oltop, last);
2413 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2415 void *value2 = ol2->value;
2416 if (options_block != NULL)
2417 value2 = (void *)((uschar *)options_block + (long int)value2);
2418 s = *((uschar **)value2);
2419 if (!no_labels) printf("%s = ", name);
2420 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2425 /* Else fall through */
2428 if (!no_labels) printf("%s = ", name);
2429 if (! *get_set_flag(name, oltop, last, options_block))
2433 gr = getgrgid(*((int *)value));
2435 printf("%ld\n", (long int)(*((int *)value)));
2436 else printf("%s\n", gr->gr_name);
2441 uidlist = *((uid_t **)value);
2442 if (!no_labels) printf("%s =", name);
2443 if (uidlist != NULL)
2447 if (no_labels) sep = '\0';
2448 for (i = 1; i <= (int)(uidlist[0]); i++)
2450 uschar *name = NULL;
2451 pw = getpwuid(uidlist[i]);
2452 if (pw != NULL) name = US pw->pw_name;
2453 if (sep != '\0') printf("%c", sep);
2454 if (name != NULL) printf("%s", name);
2455 else printf("%ld", (long int)(uidlist[i]));
2463 gidlist = *((gid_t **)value);
2464 if (!no_labels) printf("%s =", name);
2465 if (gidlist != NULL)
2469 if (no_labels) sep = '\0';
2470 for (i = 1; i <= (int)(gidlist[0]); i++)
2472 uschar *name = NULL;
2473 gr = getgrgid(gidlist[i]);
2474 if (gr != NULL) name = US gr->gr_name;
2475 if (sep != '\0') printf("%c", sep);
2476 if (name != NULL) printf("%s", name);
2477 else printf("%ld", (long int)(gidlist[i]));
2485 if (!no_labels) printf("%s = ", name);
2486 printf("%s\n", readconf_printtime(*((int *)value)));
2492 int *list = (int *)value;
2493 if (!no_labels) printf("%s = ", name);
2494 for (i = 0; i < list[1]; i++)
2495 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2501 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2505 case opt_expand_bool:
2506 sprintf(CS name2, "*expand_%.50s", name);
2507 ol2 = find_option(name2, oltop, last);
2508 if (ol2 != NULL && ol2->value != NULL)
2510 void *value2 = ol2->value;
2511 if (options_block != NULL)
2512 value2 = (void *)((uschar *)options_block + (long int)value2);
2513 s = *((uschar **)value2);
2516 if (!no_labels) printf("%s = ", name);
2517 printf("%s\n", string_printing(s));
2520 /* s == NULL => string not set; fall through */
2526 case opt_bool_verify:
2528 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2535 /*************************************************
2536 * Print value from main configuration *
2537 *************************************************/
2539 /* This function, called as a result of encountering the -bP option,
2540 causes the value of any main configuration variable to be output if the
2541 second argument is NULL. There are some special values:
2543 all print all main configuration options
2544 config_file print the name of the configuration file
2545 (configure_file will still work, for backward
2547 routers print the routers' configurations
2548 transports print the transports' configuration
2549 authenticators print the authenticators' configuration
2550 macros print the macros' configuration
2551 router_list print a list of router names
2552 transport_list print a list of transport names
2553 authenticator_list print a list of authentication mechanism names
2554 macro_list print a list of macro names
2555 +name print a named list item
2556 local_scan print the local_scan options
2557 config print the configuration as it is parsed
2558 environment print the used execution environment
2560 If the second argument is not NULL, it must be one of "router", "transport",
2561 "authenticator" or "macro" in which case the first argument identifies the
2562 driver whose options are to be printed.
2565 name option name if type == NULL; else driver name
2566 type NULL or driver type name, as described above
2567 no_labels avoid the "foo = " at the start of an item
2573 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2575 BOOL names_only = FALSE;
2577 optionlist *ol2 = NULL;
2578 driver_instance *d = NULL;
2589 static uschar *types[] = { US"address", US"domain", US"host",
2591 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2592 &hostlist_anchor, &localpartlist_anchor };
2594 for (i = 0; i < 4; i++)
2596 t = tree_search(*(anchors[i]), name+1);
2601 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2603 printf("%slist %s = %s\n", types[i], name+1,
2604 ((namedlist_block *)(t->data.ptr))->string);
2609 printf("no address, domain, host, or local part list called \"%s\" "
2610 "exists\n", name+1);
2615 if ( Ustrcmp(name, "configure_file") == 0
2616 ||Ustrcmp(name, "config_file") == 0)
2618 printf("%s\n", CS config_main_filename);
2622 if (Ustrcmp(name, "all") == 0)
2624 for (ol = optionlist_config;
2625 ol < optionlist_config + optionlist_config_size; ol++)
2627 if ((ol->type & opt_hidden) == 0)
2628 print_ol(ol, US ol->name, NULL,
2629 optionlist_config, optionlist_config_size,
2635 if (Ustrcmp(name, "local_scan") == 0)
2637 #ifndef LOCAL_SCAN_HAS_OPTIONS
2638 printf("local_scan() options are not supported\n");
2640 for (ol = local_scan_options;
2641 ol < local_scan_options + local_scan_options_count; ol++)
2643 print_ol(ol, US ol->name, NULL, local_scan_options,
2644 local_scan_options_count, no_labels);
2650 if (Ustrcmp(name, "config") == 0)
2652 print_config(admin_user, no_labels);
2656 if (Ustrcmp(name, "routers") == 0)
2661 else if (Ustrcmp(name, "transports") == 0)
2663 type = US"transport";
2667 else if (Ustrcmp(name, "authenticators") == 0)
2669 type = US"authenticator";
2673 else if (Ustrcmp(name, "macros") == 0)
2679 else if (Ustrcmp(name, "router_list") == 0)
2686 else if (Ustrcmp(name, "transport_list") == 0)
2688 type = US"transport";
2693 else if (Ustrcmp(name, "authenticator_list") == 0)
2695 type = US"authenticator";
2700 else if (Ustrcmp(name, "macro_list") == 0)
2707 else if (Ustrcmp(name, "environment") == 0)
2712 for (p = USS environ; *p; p++) ;
2713 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2715 for (p = USS environ; *p; p++)
2718 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2727 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2728 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2733 /* Handle the options for a router or transport. Skip options that are flagged
2734 as hidden. Some of these are options with names starting with '*', used for
2735 internal alternative representations of other options (which the printing
2736 function will sort out). Others are synonyms kept for backward compatibility.
2739 if (Ustrcmp(type, "router") == 0)
2741 d = (driver_instance *)routers;
2742 ol2 = optionlist_routers;
2743 size = optionlist_routers_size;
2745 else if (Ustrcmp(type, "transport") == 0)
2747 d = (driver_instance *)transports;
2748 ol2 = optionlist_transports;
2749 size = optionlist_transports_size;
2751 else if (Ustrcmp(type, "authenticator") == 0)
2753 d = (driver_instance *)auths;
2754 ol2 = optionlist_auths;
2755 size = optionlist_auths_size;
2758 else if (Ustrcmp(type, "macro") == 0)
2760 /* People store passwords in macros and they were previously not available
2761 for printing. So we have an admin_users restriction. */
2764 fprintf(stderr, "exim: permission denied\n");
2767 for (m = macros; m != NULL; m = m->next)
2769 if (name == NULL || Ustrcmp(name, m->name) == 0)
2772 printf("%s\n", CS m->name);
2774 printf("%s=%s\n", CS m->name, CS m->replacement);
2780 printf("%s %s not found\n", type, name);
2786 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2790 /* Either search for a given driver, or print all of them */
2792 for (; d != NULL; d = d->next)
2795 printf("\n%s %s:\n", d->name, type);
2796 else if (Ustrcmp(d->name, name) != 0) continue;
2798 for (ol = ol2; ol < ol2 + size; ol++)
2800 if ((ol->type & opt_hidden) == 0)
2801 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2804 for (ol = d->info->options;
2805 ol < d->info->options + *(d->info->options_count); ol++)
2807 if ((ol->type & opt_hidden) == 0)
2808 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2810 if (name != NULL) return;
2812 if (name != NULL) printf("%s %s not found\n", type, name);
2817 /*************************************************
2818 * Read a named list item *
2819 *************************************************/
2821 /* This function reads a name and a list (i.e. string). The name is used to
2822 save the list in a tree, sorted by its name. Each entry also has a number,
2823 which can be used for caching tests, but if the string contains any expansion
2824 items other than $key, the number is set negative to inhibit caching. This
2825 mechanism is used for domain, host, and address lists that are referenced by
2829 anchorp points to the tree anchor
2830 numberp points to the current number for this tree
2831 max the maximum number permitted
2832 s the text of the option line, starting immediately after the name
2834 tname the name of the list type, for messages
2840 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2843 BOOL forcecache = FALSE;
2846 namedlist_block *nb = store_get(sizeof(namedlist_block));
2848 if (Ustrncmp(s, "_cache", 6) == 0)
2855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2857 if (*numberp >= max)
2858 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2861 while (isspace(*s)) s++;
2863 while (isalnum(*s) || *s == '_') s++;
2864 t = store_get(sizeof(tree_node) + s-ss);
2865 Ustrncpy(t->name, ss, s-ss);
2867 while (isspace(*s)) s++;
2869 if (!tree_insertnode(anchorp, t))
2870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2871 "duplicate name \"%s\" for a named %s", t->name, tname);
2874 nb->number = *numberp;
2877 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2878 "missing '=' after \"%s\"", t->name);
2879 while (isspace(*s)) s++;
2880 nb->string = read_string(s, t->name);
2881 nb->cache_data = NULL;
2883 /* Check the string for any expansions; if any are found, mark this list
2884 uncacheable unless the user has explicited forced caching. */
2886 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2892 /*************************************************
2893 * Unpick data for a rate limit *
2894 *************************************************/
2896 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2900 s string, in the form t,b,f,l
2901 where t is the threshold (integer)
2902 b is the initial delay (time)
2903 f is the multiplicative factor (fixed point)
2904 k is the maximum time (time)
2905 threshold where to store threshold
2906 base where to store base in milliseconds
2907 factor where to store factor in milliseconds
2908 limit where to store limit
2910 Returns: nothing (panics on error)
2914 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2917 uschar bstring[16], lstring[16];
2919 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2920 factor, lstring) == 4)
2922 *base = readconf_readtime(bstring, 0, TRUE);
2923 *limit = readconf_readtime(lstring, 0, TRUE);
2924 if (*base >= 0 && *limit >= 0) return;
2926 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2932 /*************************************************
2933 * Drop privs for checking TLS config *
2934 *************************************************/
2936 /* We want to validate TLS options during readconf, but do not want to be
2937 root when we call into the TLS library, in case of library linkage errors
2938 which cause segfaults; before this check, those were always done as the Exim
2939 runtime user and it makes sense to continue with that.
2941 Assumes: tls_require_ciphers has been set, if it will be
2942 exim_user has been set, if it will be
2943 exim_group has been set, if it will be
2945 Returns: bool for "okay"; false will cause caller to immediately exit.
2950 tls_dropprivs_validate_require_cipher(BOOL nowarn)
2952 const uschar *errmsg;
2955 void (*oldsignal)(int);
2957 /* If TLS will never be used, no point checking ciphers */
2959 if ( !tls_advertise_hosts
2960 || !*tls_advertise_hosts
2961 || Ustrcmp(tls_advertise_hosts, ":") == 0
2964 else if (!nowarn && !tls_certificate)
2965 log_write(0, LOG_MAIN|LOG_PANIC,
2966 "Warning: No server certificate defined; TLS connections will fail.\n"
2967 " Suggested action: either install a certificate or change tls_advertise_hosts option");
2969 oldsignal = signal(SIGCHLD, SIG_DFL);
2972 if ((pid = fork()) < 0)
2973 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2977 /* in some modes, will have dropped privilege already */
2979 exim_setugid(exim_uid, exim_gid, FALSE,
2980 US"calling tls_validate_require_cipher");
2982 errmsg = tls_validate_require_cipher();
2985 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2986 "tls_require_ciphers invalid: %s", errmsg);
2993 rc = waitpid(pid, &status, 0);
2994 } while (rc < 0 && errno == EINTR);
2997 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3000 signal(SIGCHLD, oldsignal);
3004 #endif /* SUPPORT_TLS */
3009 /*************************************************
3010 * Read main configuration options *
3011 *************************************************/
3013 /* This function is the first to be called for configuration reading. It
3014 opens the configuration file and reads general configuration settings until
3015 it reaches the end of the configuration section. The file is then left open so
3016 that the remaining configuration data can subsequently be read if needed for
3019 The configuration file must be owned either by root or exim, and be writeable
3020 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3021 in the config file, so the test is done on the compiled in values. A slight
3022 anomaly, to be carefully documented.
3024 The name of the configuration file is taken from a list that is included in the
3025 binary of Exim. It can be altered from the command line, but if that is done,
3026 root privilege is immediately withdrawn unless the caller is root or exim.
3027 The first file on the list that exists is used.
3029 For use on multiple systems that share file systems, first look for a
3030 configuration file whose name has the current node name on the end. If that is
3031 not found, try the generic name. For really contorted configurations, that run
3032 multiple Exims with different uid settings, first try adding the effective uid
3033 before the node name. These complications are going to waste resources on most
3034 systems. Therefore they are available only when requested by compile-time
3038 readconf_main(BOOL nowarn)
3041 struct stat statbuf;
3042 uschar *s, *filename;
3043 const uschar *list = config_main_filelist;
3045 /* Loop through the possible file names */
3047 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
3051 /* Cut out all the fancy processing unless specifically wanted */
3053 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3054 uschar *suffix = filename + Ustrlen(filename);
3056 /* Try for the node-specific file if a node name exists */
3058 #ifdef CONFIGURE_FILE_USE_NODE
3060 if (uname(&uts) >= 0)
3062 #ifdef CONFIGURE_FILE_USE_EUID
3063 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3064 config_file = Ufopen(filename, "rb");
3065 if (config_file == NULL)
3066 #endif /* CONFIGURE_FILE_USE_EUID */
3068 sprintf(CS suffix, ".%.256s", uts.nodename);
3069 config_file = Ufopen(filename, "rb");
3072 #endif /* CONFIGURE_FILE_USE_NODE */
3074 /* Otherwise, try the generic name, possibly with the euid added */
3076 #ifdef CONFIGURE_FILE_USE_EUID
3077 if (config_file == NULL)
3079 sprintf(CS suffix, ".%ld", (long int)original_euid);
3080 config_file = Ufopen(filename, "rb");
3082 #endif /* CONFIGURE_FILE_USE_EUID */
3084 /* Finally, try the unadorned name */
3086 if (config_file == NULL)
3089 config_file = Ufopen(filename, "rb");
3091 #else /* if neither defined */
3093 /* This is the common case when the fancy processing is not included. */
3095 config_file = Ufopen(filename, "rb");
3098 /* If the file does not exist, continue to try any others. For any other
3099 error, break out (and die). */
3101 if (config_file != NULL || errno != ENOENT) break;
3104 /* Now, once we found and opened our configuration file, we change the directory
3105 to a safe place. Later we change to $spool_directory. */
3107 if (Uchdir("/") < 0)
3109 perror("exim: chdir `/': ");
3113 /* On success, save the name for verification; config_filename is used when
3114 logging configuration errors (it changes for .included files) whereas
3115 config_main_filename is the name shown by -bP. Failure to open a configuration
3116 file is a serious disaster. */
3118 if (config_file != NULL)
3121 config_filename = config_main_filename = string_copy(filename);
3123 p = Ustrrchr(filename, '/');
3124 config_main_directory = p ? string_copyn(filename, p - filename)
3125 : string_copy(US".");
3129 if (filename == NULL)
3130 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3131 "%s", config_main_filelist);
3133 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3134 "configuration file %s", filename));
3137 /* Check the status of the file we have opened, if we have retained root
3138 privileges and the file isn't /dev/null (which *should* be 0666). */
3140 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3142 if (fstat(fileno(config_file), &statbuf) != 0)
3143 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3146 if ((statbuf.st_uid != root_uid /* owner not root */
3147 #ifdef CONFIGURE_OWNER
3148 && statbuf.st_uid != config_uid /* owner not the special one */
3151 (statbuf.st_gid != root_gid /* group not root & */
3152 #ifdef CONFIGURE_GROUP
3153 && statbuf.st_gid != config_gid /* group not the special one */
3155 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3157 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3159 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3160 "wrong owner, group, or mode", big_buffer);
3163 /* Process the main configuration settings. They all begin with a lower case
3164 letter. If we see something starting with an upper case letter, it is taken as
3165 a macro definition. */
3167 while ((s = get_config_line()) != NULL)
3169 if (isupper(s[0])) read_macro_assignment(s);
3171 else if (Ustrncmp(s, "domainlist", 10) == 0)
3172 read_named_list(&domainlist_anchor, &domainlist_count,
3173 MAX_NAMED_LIST, s+10, US"domain list");
3175 else if (Ustrncmp(s, "hostlist", 8) == 0)
3176 read_named_list(&hostlist_anchor, &hostlist_count,
3177 MAX_NAMED_LIST, s+8, US"host list");
3179 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3180 read_named_list(&addresslist_anchor, &addresslist_count,
3181 MAX_NAMED_LIST, s+11, US"address list");
3183 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3184 read_named_list(&localpartlist_anchor, &localpartlist_count,
3185 MAX_NAMED_LIST, s+13, US"local part list");
3188 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3189 NULL, US"main option \"%s\" unknown");
3193 /* If local_sender_retain is set, local_from_check must be unset. */
3195 if (local_sender_retain && local_from_check)
3196 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3197 "local_sender_retain are set; this combination is not allowed");
3199 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3202 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3204 /* The max retry interval must not be greater than 24 hours. */
3206 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3208 /* remote_max_parallel must be > 0 */
3210 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3212 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3213 start of a new SMTP message. */
3215 freeze_tell_config = freeze_tell;
3217 /* The primary host name may be required for expansion of spool_directory
3218 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3219 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3220 canonize it. Some people like upper case letters in their host names, so we
3221 don't force the case. */
3223 if (primary_hostname == NULL)
3225 const uschar *hostname;
3227 if (uname(&uts) < 0)
3228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3229 hostname = US uts.nodename;
3231 if (Ustrchr(hostname, '.') == NULL)
3234 struct hostent *hostdata;
3237 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3238 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3239 MCL_DOMAIN, TRUE, NULL) != OK))
3248 #if HAVE_GETIPNODEBYNAME
3250 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3252 hostdata = gethostbyname2(CS hostname, af);
3255 hostdata = gethostbyname(CS hostname);
3258 if (hostdata != NULL)
3260 hostname = US hostdata->h_name;
3264 if (af == AF_INET) break;
3269 primary_hostname = string_copy(hostname);
3272 /* Set up default value for smtp_active_hostname */
3274 smtp_active_hostname = primary_hostname;
3276 /* If spool_directory wasn't set in the build-time configuration, it must have
3277 got set above. Of course, writing to the log may not work if log_file_path is
3278 not set, but it will at least get to syslog or somewhere, with any luck. */
3280 if (*spool_directory == 0)
3281 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3284 /* Expand the spool directory name; it may, for example, contain the primary
3285 host name. Same comment about failure. */
3287 s = expand_string(spool_directory);
3289 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3290 "\"%s\": %s", spool_directory, expand_string_message);
3291 spool_directory = s;
3293 /* Expand log_file_path, which must contain "%s" in any component that isn't
3294 the null string or "syslog". It is also allowed to contain one instance of %D
3295 or %M. However, it must NOT contain % followed by anything else. */
3297 if (*log_file_path != 0)
3299 const uschar *ss, *sss;
3300 int sep = ':'; /* Fixed for log file path */
3301 s = expand_string(log_file_path);
3303 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3304 "\"%s\": %s", log_file_path, expand_string_message);
3307 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3310 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3311 t = Ustrstr(sss, "%s");
3313 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3314 "contain \"%%s\"", sss);
3316 t = Ustrchr(sss, '%');
3319 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3320 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3321 "unexpected \"%%\" character", s);
3328 /* Interpret syslog_facility into an integer argument for 'ident' param to
3329 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3332 if (syslog_facility_str != NULL)
3335 uschar *s = syslog_facility_str;
3337 if ((Ustrlen(syslog_facility_str) >= 4) &&
3338 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3341 for (i = 0; i < syslog_list_size; i++)
3343 if (strcmpic(s, syslog_list[i].name) == 0)
3345 syslog_facility = syslog_list[i].value;
3350 if (i >= syslog_list_size)
3352 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3353 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3357 /* Expand pid_file_path */
3359 if (*pid_file_path != 0)
3361 s = expand_string(pid_file_path);
3363 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3364 "\"%s\": %s", pid_file_path, expand_string_message);
3368 /* Set default value of process_log_path */
3370 if (process_log_path == NULL || *process_log_path =='\0')
3371 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3373 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3376 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3378 /* Unpick the SMTP rate limiting options, if set */
3380 if (smtp_ratelimit_mail != NULL)
3382 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3383 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3386 if (smtp_ratelimit_rcpt != NULL)
3388 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3389 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3392 /* The qualify domains default to the primary host name */
3394 if (qualify_domain_sender == NULL)
3395 qualify_domain_sender = primary_hostname;
3396 if (qualify_domain_recipient == NULL)
3397 qualify_domain_recipient = qualify_domain_sender;
3399 /* Setting system_filter_user in the configuration sets the gid as well if a
3400 name is given, but a numerical value does not. */
3402 if (system_filter_uid_set && !system_filter_gid_set)
3404 struct passwd *pw = getpwuid(system_filter_uid);
3406 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3407 (long int)system_filter_uid);
3408 system_filter_gid = pw->pw_gid;
3409 system_filter_gid_set = TRUE;
3412 /* If the errors_reply_to field is set, check that it is syntactically valid
3413 and ensure it contains a domain. */
3415 if (errors_reply_to != NULL)
3418 int start, end, domain;
3419 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3420 &start, &end, &domain, FALSE);
3422 if (recipient == NULL)
3423 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3424 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3427 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3428 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3431 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3432 smtp_accept_max must also be set. */
3434 if (smtp_accept_max == 0 &&
3435 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3436 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3437 "smtp_accept_max must be set if smtp_accept_queue or "
3438 "smtp_accept_max_per_host is set");
3440 /* Set up the host number if anything is specified. It is an expanded string
3441 so that it can be computed from the host name, for example. We do this last
3442 so as to ensure that everything else is set up before the expansion. */
3444 if (host_number_string != NULL)
3448 uschar *s = expand_string(host_number_string);
3450 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3451 "failed to expand localhost_number \"%s\": %s",
3452 host_number_string, expand_string_message);
3453 n = Ustrtol(s, &end, 0);
3454 while (isspace(*end)) end++;
3456 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3457 "localhost_number value is not a number: %s", s);
3458 if (n > LOCALHOST_MAX)
3459 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3460 "localhost_number is greater than the maximum allowed value (%d)",
3466 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3468 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3469 tls_verify_certificates == NULL)
3470 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3471 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3472 (tls_verify_hosts != NULL)? "" : "try_");
3474 /* This also checks that the library linkage is working and we can call
3475 routines in it, so call even if tls_require_ciphers is unset */
3476 if (!tls_dropprivs_validate_require_cipher(nowarn))
3479 /* Magic number: at time of writing, 1024 has been the long-standing value
3480 used by so many clients, and what Exim used to use always, that it makes
3481 sense to just min-clamp this max-clamp at that. */
3482 if (tls_dh_max_bits < 1024)
3483 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3484 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3486 /* If openssl_options is set, validate it */
3487 if (openssl_options != NULL)
3490 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3491 "openssl_options is set but we're using GnuTLS");
3494 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3495 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3496 "openssl_options parse error: %s", openssl_options);
3500 if (!nowarn && (gnutls_require_kx || gnutls_require_mac || gnutls_require_proto))
3501 log_write(0, LOG_MAIN, "WARNING: main options"
3502 " gnutls_require_kx, gnutls_require_mac and gnutls_require_protocols"
3504 #endif /*SUPPORT_TLS*/
3506 if (!nowarn && !keep_environment && environ && *environ)
3507 log_write(0, LOG_MAIN,
3508 "Warning: purging the environment.\n"
3509 " Suggested action: use keep_environment.");
3514 /*************************************************
3515 * Initialize one driver *
3516 *************************************************/
3518 /* This is called once the driver's generic options, if any, have been read.
3519 We can now find the driver, set up defaults for the private options, and
3520 unset any "set" bits in the private options table (which might have been
3521 set by another incarnation of the same driver).
3524 d pointer to driver instance block, with generic
3526 drivers_available vector of available drivers
3527 size_of_info size of each block in drivers_available
3528 class class of driver, for error message
3530 Returns: pointer to the driver info block
3533 static driver_info *
3534 init_driver(driver_instance *d, driver_info *drivers_available,
3535 int size_of_info, uschar *class)
3539 for (dd = drivers_available; dd->driver_name[0] != 0;
3540 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3542 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3545 int len = dd->options_len;
3547 d->options_block = store_get(len);
3548 memcpy(d->options_block, dd->options_block, len);
3549 for (i = 0; i < *(dd->options_count); i++)
3550 dd->options[i].type &= ~opt_set;
3555 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3556 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3558 return NULL; /* never obeyed */
3564 /*************************************************
3565 * Initialize driver list *
3566 *************************************************/
3568 /* This function is called for routers, transports, and authentication
3569 mechanisms. It reads the data from the current point in the configuration file
3570 up to the end of the section, and sets up a chain of instance blocks according
3571 to the file's contents. The file will already have been opened by a call to
3572 readconf_main, and must be left open for subsequent reading of further data.
3574 Any errors cause a panic crash. Note that the blocks with names driver_info and
3575 driver_instance must map the first portions of all the _info and _instance
3576 blocks for this shared code to work.
3579 class "router", "transport", or "authenticator"
3580 anchor &routers, &transports, &auths
3581 drivers_available available drivers
3582 size_of_info size of each info block
3583 instance_default points to default data for an instance
3584 instance_size size of instance block
3585 driver_optionlist generic option list
3586 driver_optionlist_count count of generic option list
3592 readconf_driver_init(
3594 driver_instance **anchor,
3595 driver_info *drivers_available,
3597 void *instance_default,
3599 optionlist *driver_optionlist,
3600 int driver_optionlist_count)
3602 driver_instance **p = anchor;
3603 driver_instance *d = NULL;
3606 while ((buffer = get_config_line()) != NULL)
3611 /* Read the first name on the line and test for the start of a new driver. A
3612 macro definition indicates the end of the previous driver. If this isn't the
3613 start of a new driver, the line will be re-read. */
3615 s = readconf_readname(name, sizeof(name), buffer);
3617 /* Handle macro definition, first finishing off the initialization of the
3618 previous driver, if any. */
3620 if (isupper(*name) && *s == '=')
3624 if (!d->driver_name)
3625 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3626 "no driver defined for %s \"%s\"", class, d->name);
3630 read_macro_assignment(buffer);
3634 /* If the line starts with a name terminated by a colon, we are at the
3635 start of the definition of a new driver. The rest of the line must be
3642 /* Finish off initializing the previous driver. */
3646 if (!d->driver_name)
3647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3648 "no driver defined for %s \"%s\"", class, d->name);
3652 /* Check that we haven't already got a driver of this name */
3654 for (d = *anchor; d; d = d->next)
3655 if (Ustrcmp(name, d->name) == 0)
3656 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3657 "there are two %ss called \"%s\"", class, name);
3659 /* Set up a new driver instance data block on the chain, with
3660 its default values installed. */
3662 d = store_get(instance_size);
3663 memcpy(d, instance_default, instance_size);
3666 d->name = string_copy(name);
3668 /* Clear out the "set" bits in the generic options */
3670 for (i = 0; i < driver_optionlist_count; i++)
3671 driver_optionlist[i].type &= ~opt_set;
3673 /* Check nothing more on this line, then do the next loop iteration. */
3675 while (isspace(*s)) s++;
3676 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3680 /* Not the start of a new driver. Give an error if we have not set up a
3681 current driver yet. */
3684 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3686 /* First look to see if this is a generic option; if it is "driver",
3687 initialize the driver. If is it not a generic option, we can look for a
3688 private option provided that the driver has been previously set up. */
3690 if (readconf_handle_option(buffer, driver_optionlist,
3691 driver_optionlist_count, d, NULL))
3693 if (!d->info && d->driver_name)
3694 init_driver(d, drivers_available, size_of_info, class);
3697 /* Handle private options - pass the generic block because some may
3698 live therein. A flag with each option indicates if it is in the public
3702 readconf_handle_option(buffer, d->info->options,
3703 *(d->info->options_count), d, US"option \"%s\" unknown");
3705 /* The option is not generic and the driver name has not yet been given. */
3707 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3708 "(\"driver\" must be specified before any private options)", name);
3711 /* Run the initialization function for the final driver. */
3715 if (!d->driver_name)
3716 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3717 "no driver defined for %s \"%s\"", class, d->name);
3724 /*************************************************
3725 * Check driver dependency *
3726 *************************************************/
3728 /* This function is passed a driver instance and a string. It checks whether
3729 any of the string options for the driver contains the given string as an
3733 d points to a driver instance block
3734 s the string to search for
3736 Returns: TRUE if a dependency is found
3740 readconf_depends(driver_instance *d, uschar *s)
3742 int count = *(d->info->options_count);
3746 for (ol = d->info->options; ol < d->info->options + count; ol++)
3748 void *options_block;
3750 int type = ol->type & opt_mask;
3751 if (type != opt_stringptr) continue;
3752 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3753 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3754 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3756 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3757 isalnum(ss[Ustrlen(s)])) continue;
3758 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3759 d->name, ol->name, s);
3764 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3771 /*************************************************
3772 * Decode an error type for retries *
3773 *************************************************/
3775 /* This function is global because it is also called from the main
3776 program when testing retry information. It decodes strings such as "quota_7d"
3777 into numerical error codes.
3780 pp points to start of text
3781 p points past end of text
3782 basic_errno points to an int to receive the main error number
3783 more_errno points to an int to receive the secondary error data
3785 Returns: NULL if decoded correctly; else points to error text
3789 readconf_retry_error(const uschar *pp, const uschar *p,
3790 int *basic_errno, int *more_errno)
3793 const uschar *q = pp;
3794 while (q < p && *q != '_') q++;
3797 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3799 *basic_errno = ERRNO_EXIMQUOTA;
3800 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3801 return US"bad time value";
3804 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3806 *basic_errno = ECONNREFUSED;
3809 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3810 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3811 else return US"A or MX expected after \"refused\"";
3815 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3817 *basic_errno = ETIMEDOUT;
3821 int xlen = p - q - 1;
3822 const uschar *x = q + 1;
3824 static uschar *extras[] =
3825 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3826 static int values[] =
3827 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3829 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3830 if (strncmpic(x, extras[i], xlen) == 0)
3832 *more_errno = values[i];
3836 if (i >= sizeof(extras)/sizeof(uschar *))
3837 if (strncmpic(x, US"DNS", xlen) == 0)
3838 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3839 "available in retry rules (it has never worked) - treated as "
3842 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3846 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3847 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3848 strncmpic(pp, US"data_4", 6) == 0)
3851 int x = 255; /* means "any 4xx code" */
3852 if (p != pp + 8) bad = TRUE; else
3854 int a = pp[6], b = pp[7];
3858 if (isdigit(b)) x += b - '0';
3859 else if (b == 'x') x += 100;
3862 else if (a != 'x' || b != 'x') bad = TRUE;
3866 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3867 "x is literal and d is any digit", pp);
3869 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
3870 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3871 *more_errno = x << 8;
3874 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3875 strncmpic(q+1, US"failed", p-q-1) == 0)
3876 *basic_errno = ERRNO_AUTHFAIL;
3878 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3879 *basic_errno = ERRNO_SMTPCLOSED;
3881 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3882 *basic_errno = ERRNO_TLSREQUIRED;
3884 else if (strncmpic(pp, US"lookup", p - pp) == 0)
3885 *basic_errno = ERRNO_UNKNOWNHOST;
3887 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3888 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3896 /*************************************************
3897 * Read retry information *
3898 *************************************************/
3900 /* Each line of retry information contains:
3902 . A domain name pattern or an address pattern;
3904 . An error name, possibly with additional data, or *;
3906 . An optional sequence of retry items, each consisting of an identifying
3907 letter, a cutoff time, and optional parameters.
3909 All this is decoded and placed into a control block. */
3912 /* Subroutine to read an argument, preceded by a comma and terminated
3913 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3914 1 = fixed point number (returned *1000).
3917 paddr pointer to pointer to current character; updated
3918 type 0 => read a time; 1 => read a fixed point number
3920 Returns: time in seconds or fixed point number * 1000
3924 retry_arg(const uschar **paddr, int type)
3926 const uschar *p = *paddr;
3929 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3931 while (isspace(*p)) p++;
3933 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3935 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3936 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3941 case 0: return readconf_readtime(pp, *p, FALSE);
3942 case 1: return readconf_readfixed(pp, *p);
3944 return 0; /* Keep picky compilers happy */
3947 /* The function proper */
3950 readconf_retries(void)
3952 retry_config **chain = &retries;
3956 while ((p = get_config_line()))
3958 retry_rule **rchain;
3962 next = store_get(sizeof(retry_config));
3965 chain = &(next->next);
3966 next->basic_errno = next->more_errno = 0;
3967 next->senders = NULL;
3969 rchain = &(next->rules);
3971 next->pattern = string_dequote(&p);
3972 while (isspace(*p)) p++;
3974 while (mac_isgraph(*p)) p++;
3975 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3976 "missing error type in retry rule");
3978 /* Test error names for things we understand. */
3980 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
3981 &next->more_errno)))
3982 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3984 /* There may be an optional address list of senders to be used as another
3985 constraint on the rule. This was added later, so the syntax is a bit of a
3986 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3989 while (isspace(*p)) p++;
3990 if (Ustrncmp(p, "senders", 7) == 0)
3993 while (isspace(*p)) p++;
3994 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3995 "\"=\" expected after \"senders\" in retry rule");
3996 while (isspace(*p)) p++;
3997 next->senders = string_dequote(&p);
4000 /* Now the retry rules. Keep the maximum timeout encountered. */
4002 while (isspace(*p)) p++;
4006 retry_rule *rule = store_get(sizeof(retry_rule));
4008 rchain = &(rule->next);
4010 rule->rule = toupper(*p++);
4011 rule->timeout = retry_arg(&p, 0);
4012 if (rule->timeout > retry_maximum_timeout)
4013 retry_maximum_timeout = rule->timeout;
4017 case 'F': /* Fixed interval */
4018 rule->p1 = retry_arg(&p, 0);
4021 case 'G': /* Geometrically increasing intervals */
4022 case 'H': /* Ditto, but with randomness */
4023 rule->p1 = retry_arg(&p, 0);
4024 rule->p2 = retry_arg(&p, 1);
4028 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4032 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4033 (rule->rule != 'F' && rule->p2 < 1000))
4034 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4035 "bad parameters for retry rule");
4037 while (isspace(*p)) p++;
4041 while (isspace(*p)) p++;
4044 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4051 /*************************************************
4052 * Initialize authenticators *
4053 *************************************************/
4055 /* Read the authenticators section of the configuration file.
4064 auth_instance *au, *bu;
4065 readconf_driver_init(US"authenticator",
4066 (driver_instance **)(&auths), /* chain anchor */
4067 (driver_info *)auths_available, /* available drivers */
4068 sizeof(auth_info), /* size of info block */
4069 &auth_defaults, /* default values for generic options */
4070 sizeof(auth_instance), /* size of instance block */
4071 optionlist_auths, /* generic options */
4072 optionlist_auths_size);
4074 for (au = auths; au; au = au->next)
4076 if (!au->public_name)
4077 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4078 "the %s authenticator", au->name);
4080 for (bu = au->next; bu; bu = bu->next)
4081 if (strcmpic(au->public_name, bu->public_name) == 0)
4082 if ((au->client && bu->client) || (au->server && bu->server))
4083 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4084 "(%s and %s) have the same public name (%s)",
4085 au->client ? US"client" : US"server", au->name, bu->name,
4093 /*************************************************
4094 * Read ACL information *
4095 *************************************************/
4097 /* If this run of Exim is not doing something that involves receiving a
4098 message, we can just skip over the ACL information. No need to parse it.
4100 First, we have a function for acl_read() to call back to get the next line. We
4101 need to remember the line we passed, because at the end it will contain the
4102 name of the next ACL. */
4104 static uschar *acl_line;
4109 acl_line = get_config_line();
4114 /* Now the main function:
4125 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4128 acl_line = get_config_line();
4130 while(acl_line != NULL)
4136 p = readconf_readname(name, sizeof(name), acl_line);
4137 if (isupper(*name) && *p == '=')
4139 read_macro_assignment(acl_line);
4140 acl_line = get_config_line();
4144 if (*p != ':' || name[0] == 0)
4145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4147 node = store_get(sizeof(tree_node) + Ustrlen(name));
4148 Ustrcpy(node->name, name);
4149 if (!tree_insertnode(&acl_anchor, node))
4150 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4151 "there are two ACLs called \"%s\"", name);
4153 node->data.ptr = acl_read(acl_callback, &error);
4155 if (node->data.ptr == NULL && error != NULL)
4156 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4162 /*************************************************
4163 * Read configuration for local_scan() *
4164 *************************************************/
4166 /* This function is called after "begin local_scan" is encountered in the
4167 configuration file. If the local_scan() function allows for configuration
4168 options, we can process them. Otherwise, we expire in a panic.
4175 local_scan_init(void)
4177 #ifndef LOCAL_SCAN_HAS_OPTIONS
4178 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4179 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4183 while ((p = get_config_line()) != NULL)
4185 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4186 NULL, US"local_scan option \"%s\" unknown");
4193 /*************************************************
4194 * Read rest of configuration (after main) *
4195 *************************************************/
4197 /* This function reads the rest of the runtime configuration, after the main
4198 configuration. It is called only when actually needed. Each subsequent section
4199 of the configuration starts with a line of the form
4203 where the name is "routers", "transports", etc. A section is terminated by
4204 hitting the next "begin" line, and the next name is left in next_section.
4205 Because it may confuse people as to whether the names are singular or plural,
4206 we add "s" if it's missing. There is always enough room in next_section for
4207 this. This function is basically just a switch.
4213 static uschar *section_list[] = {
4227 while(next_section[0] != 0)
4231 int last = sizeof(section_list) / sizeof(uschar *);
4233 int n = Ustrlen(next_section);
4235 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4239 int c = strcmpic(next_section, section_list[mid]);
4241 if (c > 0) first = mid + 1; else last = mid;
4243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4244 "\"%.*s\" is not a known configuration section name", n, next_section);
4245 mid = (last + first)/2;
4249 if (((had ^= bit) & bit) == 0)
4250 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4251 "\"%.*s\" section is repeated in the configuration file", n,
4256 case 0: readconf_acl(); break;
4257 case 1: auths_init(); break;
4258 case 2: local_scan_init(); break;
4259 case 3: readconf_retries(); break;
4260 case 4: readconf_rewrites(); break;
4261 case 5: route_init(); break;
4262 case 6: transport_init(); break;
4266 (void)fclose(config_file);
4269 /* Init the storage for the pre-parsed config lines */
4271 readconf_save_config(const uschar *s)
4273 save_config_line(string_sprintf("# Exim Configuration (%s)",
4274 running_in_test_harness ? US"X" : s));
4278 save_config_position(const uschar *file, int line)
4280 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4283 /* Append a pre-parsed logical line to the config lines store,
4284 this operates on a global (static) list that holds all the pre-parsed
4285 config lines, we do no further processing here, output formatting and
4286 honouring of <hide> or macros will be done during output */
4288 save_config_line(const uschar* line)
4290 static config_line_item *current;
4291 config_line_item *next;
4293 next = (config_line_item*) store_get(sizeof(config_line_item));
4294 next->line = string_copy(line);
4297 if (!config_lines) config_lines = next;
4298 else current->next = next;
4303 /* List the parsed config lines, care about nice formatting and
4304 hide the <hide> values unless we're the admin user */
4306 print_config(BOOL admin, BOOL terse)
4308 config_line_item *i;
4309 const int TS = terse ? 0 : 2;
4312 for (i = config_lines; i; i = i->next)
4317 /* skip over to the first non-space */
4318 for (current = i->line; *current && isspace(*current); ++current)
4321 if (*current == '\0')
4324 /* Collapse runs of spaces. We stop this if we encounter one of the
4325 * following characters: "'$, as this may indicate careful formatting */
4326 for (p = current; *p; ++p)
4329 if (!isspace(*p)) continue;
4330 if (*p != ' ') *p = ' ';
4332 for (next = p; isspace(*next); ++next)
4336 memmove(p+1, next, Ustrlen(next)+1);
4338 if (*next == '"' || *next == '\'' || *next == '$')
4343 if (current[0] == '#')
4346 /* begin lines are left aligned */
4347 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4349 if (!terse) puts("");
4354 /* router/acl/transport block names */
4355 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4357 if (!terse) puts("");
4358 printf("%*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 */