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 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
216 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
217 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
218 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
219 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
220 #ifdef EXPERIMENTAL_DCC
221 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
222 { "dccifd_address", opt_stringptr, &dccifd_address },
223 { "dccifd_options", opt_stringptr, &dccifd_options },
225 { "delay_warning", opt_timelist, &delay_warning },
226 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
227 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
228 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
229 { "delivery_date_remove", opt_bool, &delivery_date_remove },
230 #ifdef ENABLE_DISABLE_FSYNC
231 { "disable_fsync", opt_bool, &disable_fsync },
233 { "disable_ipv6", opt_bool, &disable_ipv6 },
235 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
237 #ifdef EXPERIMENTAL_DMARC
238 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
239 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
240 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
242 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
243 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
244 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
245 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
246 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
247 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
248 { "dns_retrans", opt_time, &dns_retrans },
249 { "dns_retry", opt_int, &dns_retry },
250 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
251 { "dns_use_edns0", opt_int, &dns_use_edns0 },
252 /* This option is now a no-op, retained for compability */
253 { "drop_cr", opt_bool, &drop_cr },
254 /*********************************************************/
255 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
256 { "dsn_from", opt_stringptr, &dsn_from },
257 { "envelope_to_remove", opt_bool, &envelope_to_remove },
258 { "errors_copy", opt_stringptr, &errors_copy },
259 { "errors_reply_to", opt_stringptr, &errors_reply_to },
260 #ifndef DISABLE_EVENT
261 { "event_action", opt_stringptr, &event_action },
263 { "exim_group", opt_gid, &exim_gid },
264 { "exim_path", opt_stringptr, &exim_path },
265 { "exim_user", opt_uid, &exim_uid },
266 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
267 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
268 { "finduser_retries", opt_int, &finduser_retries },
269 { "freeze_tell", opt_stringptr, &freeze_tell },
270 { "gecos_name", opt_stringptr, &gecos_name },
271 { "gecos_pattern", opt_stringptr, &gecos_pattern },
273 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
274 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
276 { "header_line_maxsize", opt_int, &header_line_maxsize },
277 { "header_maxsize", opt_int, &header_maxsize },
278 { "headers_charset", opt_stringptr, &headers_charset },
279 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
280 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
281 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
282 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
283 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
284 { "hold_domains", opt_stringptr, &hold_domains },
285 { "host_lookup", opt_stringptr, &host_lookup },
286 { "host_lookup_order", opt_stringptr, &host_lookup_order },
287 { "host_reject_connection", opt_stringptr, &host_reject_connection },
288 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
290 { "hosts_proxy", opt_stringptr, &hosts_proxy },
292 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
294 { "ibase_servers", opt_stringptr, &ibase_servers },
296 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
297 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
298 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
299 { "keep_environment", opt_stringptr, &keep_environment },
300 { "keep_malformed", opt_time, &keep_malformed },
302 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
303 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
304 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
305 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
306 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
307 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
308 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
309 { "ldap_start_tls", opt_bool, &eldap_start_tls },
310 { "ldap_version", opt_int, &eldap_version },
312 { "local_from_check", opt_bool, &local_from_check },
313 { "local_from_prefix", opt_stringptr, &local_from_prefix },
314 { "local_from_suffix", opt_stringptr, &local_from_suffix },
315 { "local_interfaces", opt_stringptr, &local_interfaces },
316 { "local_scan_timeout", opt_time, &local_scan_timeout },
317 { "local_sender_retain", opt_bool, &local_sender_retain },
318 { "localhost_number", opt_stringptr, &host_number_string },
319 { "log_file_path", opt_stringptr, &log_file_path },
320 { "log_selector", opt_stringptr, &log_selector_string },
321 { "log_timezone", opt_bool, &log_timezone },
322 { "lookup_open_max", opt_int, &lookup_open_max },
323 { "max_username_length", opt_int, &max_username_length },
324 { "message_body_newlines", opt_bool, &message_body_newlines },
325 { "message_body_visible", opt_mkint, &message_body_visible },
326 { "message_id_header_domain", opt_stringptr, &message_id_domain },
327 { "message_id_header_text", opt_stringptr, &message_id_text },
328 { "message_logs", opt_bool, &message_logs },
329 { "message_size_limit", opt_stringptr, &message_size_limit },
330 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
331 { "move_frozen_messages", opt_bool, &move_frozen_messages },
333 { "mua_wrapper", opt_bool, &mua_wrapper },
335 { "mysql_servers", opt_stringptr, &mysql_servers },
337 { "never_users", opt_uidlist, &never_users },
339 { "openssl_options", opt_stringptr, &openssl_options },
342 { "oracle_servers", opt_stringptr, &oracle_servers },
344 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
346 { "perl_at_start", opt_bool, &opt_perl_at_start },
347 { "perl_startup", opt_stringptr, &opt_perl_startup },
348 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
351 { "pgsql_servers", opt_stringptr, &pgsql_servers },
353 { "pid_file_path", opt_stringptr, &pid_file_path },
354 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
356 { "prdr_enable", opt_bool, &prdr_enable },
358 { "preserve_message_logs", opt_bool, &preserve_message_logs },
359 { "primary_hostname", opt_stringptr, &primary_hostname },
360 { "print_topbitchars", opt_bool, &print_topbitchars },
361 { "process_log_path", opt_stringptr, &process_log_path },
362 { "prod_requires_admin", opt_bool, &prod_requires_admin },
363 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
364 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
365 { "queue_domains", opt_stringptr, &queue_domains },
366 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
367 { "queue_only", opt_bool, &queue_only },
368 { "queue_only_file", opt_stringptr, &queue_only_file },
369 { "queue_only_load", opt_fixed, &queue_only_load },
370 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
371 { "queue_only_override", opt_bool, &queue_only_override },
372 { "queue_run_in_order", opt_bool, &queue_run_in_order },
373 { "queue_run_max", opt_stringptr, &queue_run_max },
374 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
375 { "receive_timeout", opt_time, &receive_timeout },
376 { "received_header_text", opt_stringptr, &received_header_text },
377 { "received_headers_max", opt_int, &received_headers_max },
378 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
379 { "recipients_max", opt_int, &recipients_max },
380 { "recipients_max_reject", opt_bool, &recipients_max_reject },
382 { "redis_servers", opt_stringptr, &redis_servers },
384 { "remote_max_parallel", opt_int, &remote_max_parallel },
385 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
386 { "retry_data_expire", opt_time, &retry_data_expire },
387 { "retry_interval_max", opt_time, &retry_interval_max },
388 { "return_path_remove", opt_bool, &return_path_remove },
389 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
390 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
391 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
392 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
393 { "slow_lookup_log", opt_int, &slow_lookup_log },
394 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
395 { "smtp_accept_max", opt_int, &smtp_accept_max },
396 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
397 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
398 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
399 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
400 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
401 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
402 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
403 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
404 { "smtp_banner", opt_stringptr, &smtp_banner },
405 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
406 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
407 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
408 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
409 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
410 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
411 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
412 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
413 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
414 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
415 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
416 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
417 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
418 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
420 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
422 #ifdef WITH_CONTENT_SCAN
423 { "spamd_address", opt_stringptr, &spamd_address },
425 #ifdef EXPERIMENTAL_SPF
426 { "spf_guess", opt_stringptr, &spf_guess },
428 { "split_spool_directory", opt_bool, &split_spool_directory },
429 { "spool_directory", opt_stringptr, &spool_directory },
431 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
433 #ifdef EXPERIMENTAL_SRS
434 { "srs_config", opt_stringptr, &srs_config },
435 { "srs_hashlength", opt_int, &srs_hashlength },
436 { "srs_hashmin", opt_int, &srs_hashmin },
437 { "srs_maxage", opt_int, &srs_maxage },
438 { "srs_secrets", opt_stringptr, &srs_secrets },
439 { "srs_usehash", opt_bool, &srs_usehash },
440 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
442 { "strict_acl_vars", opt_bool, &strict_acl_vars },
443 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
444 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
445 { "syslog_duplication", opt_bool, &syslog_duplication },
446 { "syslog_facility", opt_stringptr, &syslog_facility_str },
447 { "syslog_processname", opt_stringptr, &syslog_processname },
448 { "syslog_timestamp", opt_bool, &syslog_timestamp },
449 { "system_filter", opt_stringptr, &system_filter },
450 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
451 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
452 { "system_filter_group", opt_gid, &system_filter_gid },
453 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
454 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
455 { "system_filter_user", opt_uid, &system_filter_uid },
456 { "tcp_nodelay", opt_bool, &tcp_nodelay },
457 #ifdef USE_TCP_WRAPPERS
458 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
460 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
461 { "timezone", opt_stringptr, &timezone_string },
462 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
464 { "tls_certificate", opt_stringptr, &tls_certificate },
465 { "tls_crl", opt_stringptr, &tls_crl },
466 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
467 { "tls_dhparam", opt_stringptr, &tls_dhparam },
468 { "tls_eccurve", opt_stringptr, &tls_eccurve },
469 # ifndef DISABLE_OCSP
470 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
472 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
473 { "tls_privatekey", opt_stringptr, &tls_privatekey },
474 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
475 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
476 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
477 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
478 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
480 { "trusted_groups", opt_gidlist, &trusted_groups },
481 { "trusted_users", opt_uidlist, &trusted_users },
482 { "unknown_login", opt_stringptr, &unknown_login },
483 { "unknown_username", opt_stringptr, &unknown_username },
484 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
485 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
486 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
487 { "warn_message_file", opt_stringptr, &warn_message_file },
488 { "write_rejectlog", opt_bool, &write_rejectlog }
491 static int optionlist_config_size = nelem(optionlist_config);
495 /*************************************************
496 * Find the name of an option *
497 *************************************************/
499 /* This function is to aid debugging. Various functions take arguments that are
500 pointer variables in the options table or in option tables for various drivers.
501 For debugging output, it is useful to be able to find the name of the option
502 which is currently being processed. This function finds it, if it exists, by
503 searching the table(s).
505 Arguments: a value that is presumed to be in the table above
506 Returns: the option name, or an empty string
510 readconf_find_option(void *p)
514 transport_instance *t;
516 for (i = 0; i < optionlist_config_size; i++)
517 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
519 for (r = routers; r; r = r->next)
521 router_info *ri = r->info;
522 for (i = 0; i < *ri->options_count; i++)
524 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
525 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
526 return US ri->options[i].name;
530 for (t = transports; t; t = t->next)
532 transport_info *ti = t->info;
533 for (i = 0; i < *ti->options_count; i++)
535 optionlist * op = &ti->options[i];
536 if ((op->type & opt_mask) != opt_stringptr) continue;
537 if (p == ( op->type & opt_public
539 : (char *)t->options_block
541 + (long int)op->value)
552 /*************************************************
553 * Deal with an assignment to a macro *
554 *************************************************/
556 /* This function is called when a line that starts with an upper case letter is
557 encountered. The argument "line" should contain a complete logical line, and
558 start with the first letter of the macro name. The macro name and the
559 replacement text are extracted and stored. Redefinition of existing,
560 non-command line, macros is permitted using '==' instead of '='.
563 s points to the start of the logical line
569 read_macro_assignment(uschar *s)
575 macro_item *mlast = NULL;
577 while (isalnum(*s) || *s == '_')
579 if (namelen >= sizeof(name) - 1)
580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
581 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
582 name[namelen++] = *s++;
586 while (isspace(*s)) s++;
588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
595 while (isspace(*s)) s++;
597 /* If an existing macro of the same name was defined on the command line, we
598 just skip this definition. It's an error to attempt to redefine a macro without
599 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
600 It is also an error to define a macro whose name begins with the name of a
601 previously defined macro. Note: it is documented that the other way round
604 for (m = macros; m != NULL; m = m->next)
606 int len = Ustrlen(m->name);
608 if (Ustrcmp(m->name, name) == 0)
610 if (!m->command_line && !redef)
611 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
612 "defined (use \"==\" if you want to redefine it", name);
616 if (len < namelen && Ustrstr(name, m->name) != NULL)
617 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
618 "a macro because previously defined macro \"%s\" is a substring",
621 /* We cannot have this test, because it is documented that a substring
622 macro is permitted (there is even an example).
624 * if (len > namelen && Ustrstr(m->name, name) != NULL)
625 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
626 * "a macro because it is a substring of previously defined macro \"%s\"",
633 /* Check for an overriding command-line definition. */
635 if (m != NULL && m->command_line) return;
637 /* Redefinition must refer to an existing macro. */
642 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
646 /* We have a new definition. The macro_item structure includes a final vector
647 called "name" which is one byte long. Thus, adding "namelen" gives us enough
648 room to store the "name" string. */
652 m = store_get(sizeof(macro_item) + namelen);
653 if (macros == NULL) macros = m; else mlast->next = m;
654 Ustrncpy(m->name, name, namelen);
655 m->name[namelen] = 0;
657 m->command_line = FALSE;
660 /* Set the value of the new or redefined macro */
662 m->replacement = string_copy(s);
669 /*************************************************
670 * Read configuration line *
671 *************************************************/
673 /* A logical line of text is read from the configuration file into the big
674 buffer, taking account of macros, .includes, and continuations. The size of
675 big_buffer is increased if necessary. The count of configuration lines is
676 maintained. Physical input lines starting with # (ignoring leading white space,
677 and after macro replacement) and empty logical lines are always ignored.
678 Leading and trailing spaces are removed.
680 If we hit a line of the form "begin xxxx", the xxxx is placed in the
681 next_section vector, and the function returns NULL, indicating the end of a
682 configuration section. On end-of-file, NULL is returned with next_section
687 Returns: a pointer to the first non-blank in the line,
688 or NULL if eof or end of section is reached
692 get_config_line(void)
694 int startoffset = 0; /* To first non-blank char in logical line */
695 int len = 0; /* Of logical line so far */
701 /* Loop for handling continuation lines, skipping comments, and dealing with
706 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
708 if (config_file_stack != NULL) /* EOF inside .include */
710 (void)fclose(config_file);
711 config_file = config_file_stack->file;
712 config_filename = config_file_stack->filename;
713 config_lineno = config_file_stack->lineno;
714 config_file_stack = config_file_stack->next;
716 save_config_position(config_filename, config_lineno);
720 /* EOF at top level */
722 if (cstate_stack_ptr >= 0)
723 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
724 "Unexpected end of configuration file: .endif missing");
726 if (len != 0) break; /* EOF after continuation */
727 next_section[0] = 0; /* EOF at start of logical line */
732 newlen = len + Ustrlen(big_buffer + len);
734 if (config_lines && config_lineno == 1)
735 save_config_position(config_filename, config_lineno);
737 /* Handle pathologically long physical lines - yes, it did happen - by
738 extending big_buffer at this point. The code also copes with very long
741 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
744 big_buffer_size += BIG_BUFFER_SIZE;
745 newbuffer = store_malloc(big_buffer_size);
747 /* This use of strcpy is OK because we know that the string in the old
748 buffer is shorter than the new buffer. */
750 Ustrcpy(newbuffer, big_buffer);
751 store_free(big_buffer);
752 big_buffer = newbuffer;
753 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
755 newlen += Ustrlen(big_buffer + newlen);
758 /* Find the true start of the physical line - leading spaces are always
761 ss = big_buffer + len;
762 while (isspace(*ss)) ss++;
764 /* Process the physical line for macros. If this is the start of the logical
765 line, skip over initial text at the start of the line if it starts with an
766 upper case character followed by a sequence of name characters and an equals
767 sign, because that is the definition of a new macro, and we don't do
768 replacement therein. */
771 if (len == 0 && isupper(*s))
773 while (isalnum(*s) || *s == '_') s++;
774 while (isspace(*s)) s++;
775 if (*s != '=') s = ss; /* Not a macro definition */
778 /* For each defined macro, scan the line (from after XXX= if present),
779 replacing all occurrences of the macro. */
782 for (m = macros; m != NULL; m = m->next)
787 while ((p = Ustrstr(t, m->name)) != NULL)
790 int namelen = Ustrlen(m->name);
791 int replen = Ustrlen(m->replacement);
793 /* Expand the buffer if necessary */
795 while (newlen - namelen + replen + 1 > big_buffer_size)
797 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
798 uschar *newbuffer = store_malloc(newsize);
799 memcpy(newbuffer, big_buffer, newlen + 1);
800 p = newbuffer + (p - big_buffer);
801 s = newbuffer + (s - big_buffer);
802 ss = newbuffer + (ss - big_buffer);
803 t = newbuffer + (t - big_buffer);
804 big_buffer_size = newsize;
805 store_free(big_buffer);
806 big_buffer = newbuffer;
809 /* Shuffle the remaining characters up or down in the buffer before
810 copying in the replacement text. Don't rescan the replacement for this
814 moveby = replen - namelen;
817 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
820 Ustrncpy(p, m->replacement, replen);
826 /* An empty macro replacement at the start of a line could mean that ss no
827 longer points to the first non-blank character. */
829 while (isspace(*ss)) ss++;
831 /* Check for comment lines - these are physical lines. */
833 if (*ss == '#') continue;
835 /* Handle conditionals, which are also applied to physical lines. Conditions
836 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
837 expansion occured on the rest of the line. A preliminary test for the leading
838 '.' saves effort on most lines. */
844 /* Search the list of conditional directives */
846 for (i = 0; i < cond_list_size; i++)
849 cond_item *c = cond_list+i;
850 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
852 /* The following character must be white space or end of string */
854 n = ss[1 + c->namelen];
855 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
857 /* .ifdef and .ifndef push the current state onto the stack, then set
858 a new one from the table. Stack overflow is an error */
862 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
863 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
864 ".%s nested too deeply", c->name);
865 cstate_stack[++cstate_stack_ptr] = cstate;
866 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
869 /* For any of the others, stack underflow is an error. The next state
870 comes either from the stack (.endif) or from the table. */
874 if (cstate_stack_ptr < 0)
875 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
876 ".%s without matching .ifdef", c->name);
877 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
878 next_cstate[cstate][macro_found? c->action1 : c->action2];
881 /* Having dealt with a directive, break the loop */
886 /* If we have handled a conditional directive, continue with the next
887 physical line. Otherwise, fall through. */
889 if (i < cond_list_size) continue;
892 /* If the conditional state is not 0 (actively using these lines), ignore
895 if (cstate != 0) continue; /* Conditional skip */
897 /* Handle .include lines - these are also physical lines. */
899 if (Ustrncmp(ss, ".include", 8) == 0 &&
901 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
904 int include_if_exists = isspace(ss[8])? 0 : 10;
905 config_file_item *save;
908 ss += 9 + include_if_exists;
909 while (isspace(*ss)) ss++;
910 t = ss + Ustrlen(ss);
911 while (t > ss && isspace(t[-1])) t--;
912 if (*ss == '\"' && t[-1] == '\"')
920 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
921 "absolute path \"%s\"", ss);
923 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
926 save_config_position(config_filename, config_lineno);
927 save = store_get(sizeof(config_file_item));
928 save->next = config_file_stack;
929 config_file_stack = save;
930 save->file = config_file;
931 save->filename = config_filename;
932 save->lineno = config_lineno;
934 if (!(config_file = Ufopen(ss, "rb")))
935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
936 "configuration file %s", ss);
938 config_filename = string_copy(ss);
943 /* If this is the start of the logical line, remember where the non-blank
944 data starts. Otherwise shuffle down continuation lines to remove leading
948 startoffset = ss - big_buffer;
951 s = big_buffer + len;
954 memmove(s, ss, (newlen - len) - (ss - s) + 1);
959 /* Accept the new addition to the line. Remove trailing white space. */
962 while (len > 0 && isspace(big_buffer[len-1])) len--;
965 /* We are done if the line does not end in backslash and contains some data.
966 Empty logical lines are ignored. For continuations, remove the backslash and
967 go round the loop to read the continuation line. */
971 if (big_buffer[len-1] != '\\') break; /* End of logical line */
972 big_buffer[--len] = 0; /* Remove backslash */
974 } /* Loop for reading multiple physical lines */
976 /* We now have a logical line. Test for the end of a configuration section (or,
977 more accurately, for the start of the next section). Place the name of the next
978 section in next_section, and return NULL. If the name given is longer than
979 next_section, truncate it. It will be unrecognized later, because all the known
980 section names do fit. Leave space for pluralizing. */
982 s = big_buffer + startoffset; /* First non-space character */
987 if (strncmpic(s, US"begin ", 6) == 0)
990 while (isspace(*s)) s++;
991 if (big_buffer + len - s > sizeof(next_section) - 2)
992 s[sizeof(next_section) - 2] = 0;
993 Ustrcpy(next_section, s);
997 /* Return the first non-blank character. */
1004 /*************************************************
1006 *************************************************/
1008 /* The yield is the pointer to the next uschar. Names longer than the
1009 output space are silently truncated. This function is also used from acl.c when
1013 name where to put the name
1017 Returns: new input pointer
1021 readconf_readname(uschar *name, int len, uschar *s)
1024 while (isspace(*s)) s++;
1027 while (isalnum(*s) || *s == '_')
1029 if (p < len-1) name[p++] = *s;
1034 while (isspace(*s)) s++;
1041 /*************************************************
1042 * Read a time value *
1043 *************************************************/
1045 /* This function is also called from outside, to read argument
1046 time values. The format of a time value is:
1048 [<n>w][<n>d][<n>h][<n>m][<n>s]
1050 as long as at least one is present. If a format error is encountered,
1051 return a negative value. The value must be terminated by the given
1056 terminator required terminating character
1057 return_msec if TRUE, allow fractional seconds and return milliseconds
1059 Returns: the time value, or -1 on syntax error
1060 value is seconds if return_msec is FALSE
1061 value is milliseconds if return_msec is TRUE
1065 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1073 if (!isdigit(*s)) return -1;
1074 (void)sscanf(CCS s, "%d%n", &value, &count);
1079 case 'w': value *= 7;
1080 case 'd': value *= 24;
1081 case 'h': value *= 60;
1082 case 'm': value *= 60;
1087 if (!return_msec) return -1;
1088 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1090 if (*s++ != 's') return -1;
1091 yield += (int)(fraction * 1000.0);
1097 if (return_msec) value *= 1000;
1099 if (*s == terminator) return yield;
1101 /* Control never reaches here. */
1106 /*************************************************
1107 * Read a fixed point value *
1108 *************************************************/
1110 /* The value is returned *1000
1114 terminator required terminator
1116 Returns: the value, or -1 on error
1120 readconf_readfixed(const uschar *s, int terminator)
1124 if (!isdigit(*s)) return -1;
1125 (void)sscanf(CS s, "%d%n", &value, &count);
1127 yield = value * 1000;
1131 while (isdigit((*(++s))))
1133 yield += (*s - '0') * m;
1138 return (*s == terminator)? yield : (-1);
1143 /*************************************************
1144 * Find option in list *
1145 *************************************************/
1147 /* The lists are always in order, so binary chop can be used.
1150 name the option name to search for
1151 ol the first entry in the option list
1152 last one more than the offset of the last entry in the option list
1154 Returns: pointer to an option entry, or NULL if not found
1158 find_option(uschar *name, optionlist *ol, int last)
1161 while (last > first)
1163 int middle = (first + last)/2;
1164 int c = Ustrcmp(name, ol[middle].name);
1166 if (c == 0) return ol + middle;
1167 else if (c > 0) first = middle + 1;
1175 /*************************************************
1176 * Find a set flag in option list *
1177 *************************************************/
1179 /* Because some versions of Unix make no restrictions on the values of uids and
1180 gids (even negative ones), we cannot represent "unset" by a special value.
1181 There is therefore a separate boolean variable for each one indicating whether
1182 a value is set or not. This function returns a pointer to the boolean, given
1183 the original option name. It is a major disaster if the flag cannot be found.
1186 name the name of the uid or gid option
1187 oltop points to the start of the relevant option list
1188 last one more than the offset of the last item in the option list
1189 data_block NULL when reading main options => data values in the option
1190 list are absolute addresses; otherwise they are byte offsets
1191 in data_block (used for driver options)
1193 Returns: a pointer to the boolean flag.
1197 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1201 sprintf(CS name2, "*set_%.50s", name);
1202 ol = find_option(name2, oltop, last);
1203 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1204 "Exim internal error: missing set flag for %s", name);
1205 return (data_block == NULL)? (BOOL *)(ol->value) :
1206 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1212 /*************************************************
1213 * Output extra characters message and die *
1214 *************************************************/
1216 /* Called when an option line has junk on the end. Sometimes this is because
1217 the sysadmin thinks comments are permitted.
1220 s points to the extra characters
1221 t1..t3 strings to insert in the log message
1223 Returns: doesn't return; dies
1227 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1229 uschar *comment = US"";
1230 if (*s == '#') comment = US" (# is comment only at line start)";
1231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1232 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1237 /*************************************************
1238 * Read rewrite information *
1239 *************************************************/
1241 /* Each line of rewrite information contains:
1243 . A complete address in the form user@domain, possibly with
1244 leading * for each part; or alternatively, a regex.
1246 . A replacement string (which will be expanded).
1248 . An optional sequence of one-letter flags, indicating which
1249 headers etc. to apply this rule to.
1251 All this is decoded and placed into a control block. The OR of the flags is
1252 maintained in a common word.
1255 p points to the string that makes up the rule
1256 existflags points to the overall flag word
1257 isglobal TRUE if reading global rewrite rules
1259 Returns: the control block for the parsed rule.
1262 static rewrite_rule *
1263 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1265 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1268 next->key = string_dequote(&p);
1270 while (isspace(*p)) p++;
1272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1273 "missing rewrite replacement string");
1276 next->replacement = string_dequote(&p);
1278 while (*p != 0) switch (*p++)
1280 case ' ': case '\t': break;
1282 case 'q': next->flags |= rewrite_quit; break;
1283 case 'w': next->flags |= rewrite_whole; break;
1285 case 'h': next->flags |= rewrite_all_headers; break;
1286 case 's': next->flags |= rewrite_sender; break;
1287 case 'f': next->flags |= rewrite_from; break;
1288 case 't': next->flags |= rewrite_to; break;
1289 case 'c': next->flags |= rewrite_cc; break;
1290 case 'b': next->flags |= rewrite_bcc; break;
1291 case 'r': next->flags |= rewrite_replyto; break;
1293 case 'E': next->flags |= rewrite_all_envelope; break;
1294 case 'F': next->flags |= rewrite_envfrom; break;
1295 case 'T': next->flags |= rewrite_envto; break;
1297 case 'Q': next->flags |= rewrite_qualify; break;
1298 case 'R': next->flags |= rewrite_repeat; break;
1301 next->flags |= rewrite_smtp;
1302 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1303 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1304 "rewrite rule has the S flag but is not a regular expression");
1308 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1309 "unknown rewrite flag character '%c' "
1310 "(could be missing quotes round replacement item)", p[-1]);
1314 /* If no action flags are set, set all the "normal" rewrites. */
1316 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1317 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1319 /* Remember which exist, for optimization, and return the rule */
1321 *existflags |= next->flags;
1328 /*************************************************
1329 * Read global rewrite information *
1330 *************************************************/
1332 /* Each line is a single rewrite rule; it is parsed into a control block
1333 by readconf_one_rewrite(), and its flags are ORed into the global flag
1334 word rewrite_existflags. */
1337 readconf_rewrites(void)
1339 rewrite_rule **chain = &global_rewrite_rules;
1342 while ((p = get_config_line()) != NULL)
1344 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1346 chain = &(next->next);
1352 /*************************************************
1354 *************************************************/
1356 /* Strings are read into the normal store pool. As long we aren't too
1357 near the end of the current block, the string will just use what is necessary
1358 on the top of the stacking pool, because string_cat() uses the extension
1362 s the rest of the input line
1363 name the option name (for errors)
1365 Returns: pointer to the string
1369 read_string(const uschar *s, const uschar *name)
1374 if (*s != '\"') return string_copy(s);
1377 yield = string_dequote(&s);
1379 if (s == ss+1 || s[-1] != '\"')
1380 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1381 "missing quote at end of string value for %s", name);
1383 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1389 /*************************************************
1390 * Custom-handler options *
1391 *************************************************/
1393 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1396 smtp_receive_timeout_s = string_copy(str);
1399 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1400 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1401 if (smtp_receive_timeout < 0)
1402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1407 /*************************************************
1408 * Handle option line *
1409 *************************************************/
1411 /* This function is called from several places to process a line containing the
1412 setting of an option. The first argument is the line to be decoded; it has been
1413 checked not to be empty and not to start with '#'. Trailing newlines and white
1414 space have been removed. The second argument is a pointer to the list of
1415 variable names that are to be recognized, together with their types and
1416 locations, and the third argument gives the number of entries in the list.
1418 The fourth argument is a pointer to a data block. If it is NULL, then the data
1419 values in the options list are absolute addresses. Otherwise, they are byte
1420 offsets in the data block.
1422 String option data may continue onto several lines; this function reads further
1423 data from config_file if necessary.
1425 The yield of this function is normally zero. If a string continues onto
1426 multiple lines, then the data value is permitted to be followed by a comma
1427 or a semicolon (for use in drivers) and the yield is that character.
1430 buffer contains the configuration line to be handled
1431 oltop points to the start of the relevant option list
1432 last one more than the offset of the last item in the option list
1433 data_block NULL when reading main options => data values in the option
1434 list are absolute addresses; otherwise they are byte offsets
1435 in data_block when they have opt_public set; otherwise
1436 they are byte offsets in data_block->options_block.
1437 unknown_txt format string to use in panic message for unknown option;
1438 must contain %s for option name
1439 if given as NULL, don't panic on unknown option
1441 Returns: TRUE if an option was read successfully,
1442 FALSE false for an unknown option if unknown_txt == NULL,
1443 otherwise panic and die on an unknown option
1447 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1448 void *data_block, uschar *unknown_txt)
1452 int n, count, type, value;
1456 BOOL boolvalue = TRUE;
1457 BOOL freesptr = TRUE;
1458 optionlist *ol, *ol2;
1462 uschar *inttype = US"";
1465 uschar *saved_condition, *strtemp;
1466 uschar **str_target;
1470 /* There may be leading spaces; thereafter, we expect an option name starting
1473 while (isspace(*s)) s++;
1475 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1477 /* Read the name of the option, and skip any subsequent white space. If
1478 it turns out that what we read was "hide", set the flag indicating that
1479 this is a secure option, and loop to read the next word. */
1481 for (n = 0; n < 2; n++)
1483 while (isalnum(*s) || *s == '_')
1485 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1489 while (isspace(*s)) s++;
1490 if (Ustrcmp(name, "hide") != 0) break;
1491 issecure = opt_secure;
1495 /* Deal with "no_" or "not_" here for booleans */
1497 if (Ustrncmp(name, "no_", 3) == 0)
1503 if (Ustrncmp(name, "not_", 4) == 0)
1509 /* Search the list for the given name. A non-existent name, or an option that
1510 is set twice, is a disaster. */
1512 if (!(ol = find_option(name + offset, oltop, last)))
1514 if (unknown_txt == NULL) return FALSE;
1515 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1518 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1519 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1520 "\"%s\" option set for the second time", name);
1522 ol->type |= opt_set | issecure;
1523 type = ol->type & opt_mask;
1525 /* Types with data values must be followed by '='; the "no[t]_" prefix
1526 applies only to boolean values. */
1528 if (type < opt_bool || type > opt_bool_last)
1531 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1532 "negation prefix applied to a non-boolean option");
1534 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1535 "unexpected end of line (data missing) after %s", name);
1537 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1540 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1541 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1542 ultimately expands to one of those values. */
1544 else if (*s != 0 && (offset != 0 || *s != '='))
1545 extra_chars_error(s, US"boolean option ", name, US"");
1547 /* Skip white space after = */
1549 if (*s == '=') while (isspace((*(++s))));
1551 /* If there is a data block and the opt_public flag is not set, change
1552 the data block pointer to the private options block. */
1554 if (data_block != NULL && (ol->type & opt_public) == 0)
1555 data_block = (void *)(((driver_instance *)data_block)->options_block);
1557 /* Now get the data according to the type. */
1561 /* If a string value is not enclosed in quotes, it consists of
1562 the rest of the current line, verbatim. Otherwise, string escapes
1565 A transport is specified as a string, which is then looked up in the
1566 list of transports. A search type is specified as one of a number of
1569 A set or rewrite rules for a driver is specified as a string, which is
1570 then parsed into a suitable chain of control blocks.
1572 Uids and gids are specified as strings which are then looked up in the
1573 passwd file. Lists of uids and gids are similarly specified as colon-
1574 separated strings. */
1579 case opt_expand_uid:
1580 case opt_expand_gid:
1585 reset_point = sptr = read_string(s, name);
1587 /* Having read a string, we now have several different ways of using it,
1588 depending on the data type, so do another switch. If keeping the actual
1589 string is not required (because it is interpreted), freesptr is set TRUE,
1590 and at the end we reset the pool. */
1594 /* If this was a string, set the variable to point to the new string,
1595 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1596 rules, we still keep the string (for printing), and parse the rules into a
1597 control block and flags word. */
1600 if (data_block == NULL)
1601 str_target = (uschar **)(ol->value);
1603 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1604 if (ol->type & opt_rep_con)
1606 /* We already have a condition, we're conducting a crude hack to let
1607 multiple condition rules be chained together, despite storing them in
1609 saved_condition = *str_target;
1610 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1611 saved_condition, sptr);
1612 *str_target = string_copy_malloc(strtemp);
1613 /* TODO(pdp): there is a memory leak here and just below
1614 when we set 3 or more conditions; I still don't
1615 understand the store mechanism enough to know
1616 what's the safe way to free content from an earlier store.
1617 AFAICT, stores stack, so freeing an early stored item also stores
1618 all data alloc'd after it. If we knew conditions were adjacent,
1619 we could survive that, but we don't. So I *think* we need to take
1620 another bit from opt_type to indicate "malloced"; this seems like
1621 quite a hack, especially for this one case. It also means that
1622 we can't ever reclaim the store from the *first* condition.
1624 Because we only do this once, near process start-up, I'm prepared to
1625 let this slide for the time being, even though it rankles. */
1627 else if (ol->type & opt_rep_str)
1629 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1630 int sep_i = -(int)sep_o;
1631 const uschar * list = sptr;
1633 uschar * list_o = *str_target;
1635 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1636 list_o = string_append_listele(list_o, sep_o, s);
1638 *str_target = string_copy_malloc(list_o);
1648 if (data_block == NULL)
1649 *((uschar **)(ol->value)) = sptr;
1651 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1653 if (type == opt_rewrite)
1658 rewrite_rule **chain;
1661 sprintf(CS name2, "*%.50s_rules", name);
1662 ol2 = find_option(name2, oltop, last);
1663 sprintf(CS name2, "*%.50s_flags", name);
1664 ol3 = find_option(name2, oltop, last);
1666 if (ol2 == NULL || ol3 == NULL)
1667 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1668 "rewrite rules not available for driver");
1670 if (data_block == NULL)
1672 chain = (rewrite_rule **)(ol2->value);
1673 flagptr = (int *)(ol3->value);
1677 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1678 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1681 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1683 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1685 chain = &(next->next);
1688 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1689 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1690 "non-header rewrite - not allowed at transport time -");
1694 /* If it was an expanded uid, see if there is any expansion to be
1695 done by checking for the presence of a $ character. If there is, save it
1696 in the corresponding *expand_user option field. Otherwise, fall through
1697 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1700 case opt_expand_uid:
1701 sprintf(CS name2, "*expand_%.50s", name);
1702 ol2 = find_option(name2, oltop, last);
1705 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1707 if (data_block == NULL)
1708 *((uschar **)(ol2->value)) = ss;
1710 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1714 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1720 /* Look up a fixed uid, and also make use of the corresponding gid
1721 if a passwd entry is returned and the gid has not been set. */
1724 if (!route_finduser(sptr, &pw, &uid))
1725 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1726 if (data_block == NULL)
1727 *((uid_t *)(ol->value)) = uid;
1729 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1731 /* Set the flag indicating a fixed value is set */
1733 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1735 /* Handle matching gid if we have a passwd entry: done by finding the
1736 same name with terminating "user" changed to "group"; if not found,
1737 ignore. Also ignore if the value is already set. */
1739 if (pw == NULL) break;
1740 Ustrcpy(name+Ustrlen(name)-4, "group");
1741 ol2 = find_option(name, oltop, last);
1742 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1743 (ol2->type & opt_mask) == opt_expand_gid))
1745 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1748 if (data_block == NULL)
1749 *((gid_t *)(ol2->value)) = pw->pw_gid;
1751 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1757 /* If it was an expanded gid, see if there is any expansion to be
1758 done by checking for the presence of a $ character. If there is, save it
1759 in the corresponding *expand_user option field. Otherwise, fall through
1760 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1763 case opt_expand_gid:
1764 sprintf(CS name2, "*expand_%.50s", name);
1765 ol2 = find_option(name2, oltop, last);
1768 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1770 if (data_block == NULL)
1771 *((uschar **)(ol2->value)) = ss;
1773 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1777 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1783 /* Handle freestanding gid */
1786 if (!route_findgroup(sptr, &gid))
1787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1788 if (data_block == NULL)
1789 *((gid_t *)(ol->value)) = gid;
1791 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1792 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1795 /* If it was a uid list, look up each individual entry, and build
1796 a vector of uids, with a count in the first element. Put the vector
1797 in malloc store so we can free the string. (We are reading into
1798 permanent store already.) */
1806 const uschar *op = expand_string (sptr);
1809 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1810 name, expand_string_message);
1813 if (*p != 0) count++;
1814 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1815 list = store_malloc(count*sizeof(uid_t));
1816 list[ptr++] = (uid_t)(count - 1);
1818 if (data_block == NULL)
1819 *((uid_t **)(ol->value)) = list;
1821 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1827 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1828 if (!route_finduser(big_buffer, NULL, &uid))
1829 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1836 /* If it was a gid list, look up each individual entry, and build
1837 a vector of gids, with a count in the first element. Put the vector
1838 in malloc store so we can free the string. (We are reading into permanent
1847 const uschar *op = expand_string (sptr);
1850 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1851 name, expand_string_message);
1854 if (*p != 0) count++;
1855 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1856 list = store_malloc(count*sizeof(gid_t));
1857 list[ptr++] = (gid_t)(count - 1);
1859 if (data_block == NULL)
1860 *((gid_t **)(ol->value)) = list;
1862 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1868 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1869 if (!route_findgroup(big_buffer, &gid))
1870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1878 /* Release store if the value of the string doesn't need to be kept. */
1880 if (freesptr) store_reset(reset_point);
1883 /* Expanded boolean: if no characters follow, or if there are no dollar
1884 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1885 save the string for later expansion in the alternate place. */
1887 case opt_expand_bool:
1888 if (*s != 0 && Ustrchr(s, '$') != 0)
1890 sprintf(CS name2, "*expand_%.50s", name);
1891 ol2 = find_option(name2, oltop, last);
1894 reset_point = sptr = read_string(s, name);
1895 if (data_block == NULL)
1896 *((uschar **)(ol2->value)) = sptr;
1898 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1905 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1906 look for yes/not/true/false. Some booleans are stored in a single bit in
1907 a single int. There's a special fudge for verify settings; without a suffix
1908 they set both xx_sender and xx_recipient. The table points to the sender
1909 value; search subsequently for the recipient. There's another special case:
1910 opt_bool_set also notes when a boolean has been set. */
1914 case opt_bool_verify:
1918 s = readconf_readname(name2, 64, s);
1919 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1921 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1923 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1924 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1925 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1926 US"for boolean option ", name);
1929 /* Handle single-bit type. */
1931 if (type == opt_bit)
1933 int bit = 1 << ((ol->type >> 16) & 31);
1934 int *ptr = (data_block == NULL)?
1935 (int *)(ol->value) :
1936 (int *)((uschar *)data_block + (long int)ol->value);
1937 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1941 /* Handle full BOOL types */
1943 if (data_block == NULL)
1944 *((BOOL *)(ol->value)) = boolvalue;
1946 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1950 if (type == opt_bool_verify)
1952 sprintf(CS name2, "%.50s_recipient", name + offset);
1953 ol2 = find_option(name2, oltop, last);
1956 if (data_block == NULL)
1957 *((BOOL *)(ol2->value)) = boolvalue;
1959 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1963 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1965 else if (type == opt_bool_set)
1967 sprintf(CS name2, "*set_%.50s", name + offset);
1968 ol2 = find_option(name2, oltop, last);
1971 if (data_block == NULL)
1972 *((BOOL *)(ol2->value)) = TRUE;
1974 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1983 inttype = US"octal ";
1985 /* Integer: a simple(ish) case; allow octal and hex formats, and
1986 suffixes K, M and G. The different types affect output, not input. */
1995 lvalue = strtol(CS s, CSS &endptr, intbase);
1998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2001 if (errno != ERANGE)
2002 if (tolower(*endptr) == 'k')
2004 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2005 else lvalue *= 1024;
2008 else if (tolower(*endptr) == 'm')
2010 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2012 else lvalue *= 1024*1024;
2015 else if (tolower(*endptr) == 'g')
2017 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2019 else lvalue *= 1024*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, M
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)
2055 if (tolower(*endptr) == 'g')
2057 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2063 else if (tolower(*endptr) == 'm')
2065 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2071 else if (tolower(*endptr) == 'k')
2074 value = (value + 512)/1024;
2076 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2077 "absolute value of integer \"%s\" is too large (overflow)", s);
2079 while (isspace(*endptr)) endptr++;
2081 extra_chars_error(endptr, inttype, US"integer value for ", name);
2084 if (data_block == NULL)
2085 *((int *)(ol->value)) = value;
2087 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2090 /* Fixed-point number: held to 3 decimal places. */
2093 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2094 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2095 "fixed-point number expected for %s", name);
2097 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2098 "integer \"%s\" is too large (overflow)", s);
2102 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2103 "integer \"%s\" is too large (overflow)", s);
2105 if (s[count] == '.')
2108 while (isdigit(s[++count]))
2110 value += (s[count] - '0') * d;
2115 while (isspace(s[count])) count++;
2118 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2120 if (data_block == NULL)
2121 *((int *)(ol->value)) = value;
2123 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2126 /* There's a special routine to read time values. */
2129 value = readconf_readtime(s, 0, FALSE);
2131 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2133 if (data_block == NULL)
2134 *((int *)(ol->value)) = value;
2136 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2139 /* A time list is a list of colon-separated times, with the first
2140 element holding the size of the list and the second the number of
2146 int *list = (data_block == NULL)?
2147 (int *)(ol->value) :
2148 (int *)((uschar *)data_block + (long int)(ol->value));
2150 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2153 uschar *snext = Ustrchr(s, ':');
2157 while (ss > s && isspace(ss[-1])) ss--;
2160 value = readconf_readtime(s, terminator, FALSE);
2162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2164 if (count > 1 && value <= list[count])
2165 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2166 "time value out of order for %s", name);
2167 list[count+1] = value;
2168 if (snext == NULL) break;
2170 while (isspace(*s)) s++;
2173 if (count > list[0] - 2)
2174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2176 if (count > 0 && list[2] == 0) count = 0;
2183 void (*fn)() = ol->value;
2194 /*************************************************
2195 * Print a time value *
2196 *************************************************/
2199 Argument: a time value in seconds
2200 Returns: pointer to a fixed buffer containing the time as a string,
2201 in readconf_readtime() format
2205 readconf_printtime(int t)
2208 uschar *p = time_buffer;
2225 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2226 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2227 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2228 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2229 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2236 /*************************************************
2237 * Print an individual option value *
2238 *************************************************/
2240 /* This is used by the -bP option, so prints to the standard output.
2241 The entire options list is passed in as an argument, because some options come
2242 in pairs - typically uid/gid settings, which can either be explicit numerical
2243 values, or strings to be expanded later. If the numerical value is unset,
2244 search for "*expand_<name>" to see if there is a string equivalent.
2247 ol option entry, or NULL for an unknown option
2249 options_block NULL for main configuration options; otherwise points to
2250 a driver block; if the option doesn't have opt_public
2251 set, then options_block->options_block is where the item
2253 oltop points to the option list in which ol exists
2254 last one more than the offset of the last entry in optop
2255 no_labels do not show "foo = " at the start.
2261 print_ol(optionlist *ol, uschar *name, void *options_block,
2262 optionlist *oltop, int last, BOOL no_labels)
2275 printf("%s is not a known option\n", name);
2279 /* Non-admin callers cannot see options that have been flagged secure by the
2282 if (!admin_user && (ol->type & opt_secure) != 0)
2285 printf("%s\n", hidden);
2287 printf("%s = %s\n", name, hidden);
2291 /* Else show the value of the option */
2294 if (options_block != NULL)
2296 if ((ol->type & opt_public) == 0)
2297 options_block = (void *)(((driver_instance *)options_block)->options_block);
2298 value = (void *)((uschar *)options_block + (long int)value);
2301 switch(ol->type & opt_mask)
2304 case opt_rewrite: /* Show the text value */
2305 s = *((uschar **)value);
2306 if (!no_labels) printf("%s = ", name);
2307 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2311 if (!no_labels) printf("%s = ", name);
2312 printf("%d\n", *((int *)value));
2317 int x = *((int *)value);
2318 if (x != 0 && (x & 1023) == 0)
2322 if ((x & 1023) == 0)
2327 if (!no_labels) printf("%s = ", name);
2328 printf("%d%c\n", x, c);
2332 if (!no_labels) printf("%s = ", name);
2340 int x = *((int *)value);
2341 if (!no_labels) printf("%s = ", name);
2342 if (x == 0) printf("0\n");
2343 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2344 else printf("%dK\n", x);
2349 if (!no_labels) printf("%s = ", name);
2350 printf("%#o\n", *((int *)value));
2353 /* Can be negative only when "unset", in which case integer */
2357 int x = *((int *)value);
2360 if (x < 0) printf("%s =\n", name); else
2362 if (!no_labels) printf("%s = ", name);
2363 printf("%d.", x/1000);
2376 /* If the numerical value is unset, try for the string value */
2378 case opt_expand_uid:
2379 if (! *get_set_flag(name, oltop, last, options_block))
2381 sprintf(CS name2, "*expand_%.50s", name);
2382 ol2 = find_option(name2, oltop, last);
2385 void *value2 = ol2->value;
2386 if (options_block != NULL)
2387 value2 = (void *)((uschar *)options_block + (long int)value2);
2388 s = *((uschar **)value2);
2389 if (!no_labels) printf("%s = ", name);
2390 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2395 /* Else fall through */
2398 if (!no_labels) printf("%s = ", name);
2399 if (! *get_set_flag(name, oltop, last, options_block))
2403 pw = getpwuid(*((uid_t *)value));
2405 printf("%ld\n", (long int)(*((uid_t *)value)));
2406 else printf("%s\n", pw->pw_name);
2410 /* If the numerical value is unset, try for the string value */
2412 case opt_expand_gid:
2413 if (! *get_set_flag(name, oltop, last, options_block))
2415 sprintf(CS name2, "*expand_%.50s", name);
2416 ol2 = find_option(name2, oltop, last);
2417 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2419 void *value2 = ol2->value;
2420 if (options_block != NULL)
2421 value2 = (void *)((uschar *)options_block + (long int)value2);
2422 s = *((uschar **)value2);
2423 if (!no_labels) printf("%s = ", name);
2424 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2429 /* Else fall through */
2432 if (!no_labels) printf("%s = ", name);
2433 if (! *get_set_flag(name, oltop, last, options_block))
2437 gr = getgrgid(*((int *)value));
2439 printf("%ld\n", (long int)(*((int *)value)));
2440 else printf("%s\n", gr->gr_name);
2445 uidlist = *((uid_t **)value);
2446 if (!no_labels) printf("%s =", name);
2447 if (uidlist != NULL)
2451 if (no_labels) sep = '\0';
2452 for (i = 1; i <= (int)(uidlist[0]); i++)
2454 uschar *name = NULL;
2455 pw = getpwuid(uidlist[i]);
2456 if (pw != NULL) name = US pw->pw_name;
2457 if (sep != '\0') printf("%c", sep);
2458 if (name != NULL) printf("%s", name);
2459 else printf("%ld", (long int)(uidlist[i]));
2467 gidlist = *((gid_t **)value);
2468 if (!no_labels) printf("%s =", name);
2469 if (gidlist != NULL)
2473 if (no_labels) sep = '\0';
2474 for (i = 1; i <= (int)(gidlist[0]); i++)
2476 uschar *name = NULL;
2477 gr = getgrgid(gidlist[i]);
2478 if (gr != NULL) name = US gr->gr_name;
2479 if (sep != '\0') printf("%c", sep);
2480 if (name != NULL) printf("%s", name);
2481 else printf("%ld", (long int)(gidlist[i]));
2489 if (!no_labels) printf("%s = ", name);
2490 printf("%s\n", readconf_printtime(*((int *)value)));
2496 int *list = (int *)value;
2497 if (!no_labels) printf("%s = ", name);
2498 for (i = 0; i < list[1]; i++)
2499 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2505 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2509 case opt_expand_bool:
2510 sprintf(CS name2, "*expand_%.50s", name);
2511 ol2 = find_option(name2, oltop, last);
2512 if (ol2 != NULL && ol2->value != NULL)
2514 void *value2 = ol2->value;
2515 if (options_block != NULL)
2516 value2 = (void *)((uschar *)options_block + (long int)value2);
2517 s = *((uschar **)value2);
2520 if (!no_labels) printf("%s = ", name);
2521 printf("%s\n", string_printing(s));
2524 /* s == NULL => string not set; fall through */
2530 case opt_bool_verify:
2532 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2539 /*************************************************
2540 * Print value from main configuration *
2541 *************************************************/
2543 /* This function, called as a result of encountering the -bP option,
2544 causes the value of any main configuration variable to be output if the
2545 second argument is NULL. There are some special values:
2547 all print all main configuration options
2548 config_file print the name of the configuration file
2549 (configure_file will still work, for backward
2551 routers print the routers' configurations
2552 transports print the transports' configuration
2553 authenticators print the authenticators' configuration
2554 macros print the macros' configuration
2555 router_list print a list of router names
2556 transport_list print a list of transport names
2557 authenticator_list print a list of authentication mechanism names
2558 macro_list print a list of macro names
2559 +name print a named list item
2560 local_scan print the local_scan options
2561 config print the configuration as it is parsed
2562 environment print the used execution environment
2564 If the second argument is not NULL, it must be one of "router", "transport",
2565 "authenticator" or "macro" in which case the first argument identifies the
2566 driver whose options are to be printed.
2569 name option name if type == NULL; else driver name
2570 type NULL or driver type name, as described above
2571 no_labels avoid the "foo = " at the start of an item
2577 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2579 BOOL names_only = FALSE;
2581 optionlist *ol2 = NULL;
2582 driver_instance *d = NULL;
2593 static uschar *types[] = { US"address", US"domain", US"host",
2595 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2596 &hostlist_anchor, &localpartlist_anchor };
2598 for (i = 0; i < 4; i++)
2600 t = tree_search(*(anchors[i]), name+1);
2605 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2607 printf("%slist %s = %s\n", types[i], name+1,
2608 ((namedlist_block *)(t->data.ptr))->string);
2613 printf("no address, domain, host, or local part list called \"%s\" "
2614 "exists\n", name+1);
2619 if ( Ustrcmp(name, "configure_file") == 0
2620 || Ustrcmp(name, "config_file") == 0)
2622 printf("%s\n", CS config_main_filename);
2626 if (Ustrcmp(name, "all") == 0)
2628 for (ol = optionlist_config;
2629 ol < optionlist_config + optionlist_config_size; ol++)
2631 if ((ol->type & opt_hidden) == 0)
2632 print_ol(ol, US ol->name, NULL,
2633 optionlist_config, optionlist_config_size,
2639 if (Ustrcmp(name, "local_scan") == 0)
2641 #ifndef LOCAL_SCAN_HAS_OPTIONS
2642 printf("local_scan() options are not supported\n");
2644 for (ol = local_scan_options;
2645 ol < local_scan_options + local_scan_options_count; ol++)
2647 print_ol(ol, US ol->name, NULL, local_scan_options,
2648 local_scan_options_count, no_labels);
2654 if (Ustrcmp(name, "config") == 0)
2656 print_config(admin_user, no_labels);
2660 if (Ustrcmp(name, "routers") == 0)
2665 else if (Ustrcmp(name, "transports") == 0)
2667 type = US"transport";
2671 else if (Ustrcmp(name, "authenticators") == 0)
2673 type = US"authenticator";
2677 else if (Ustrcmp(name, "macros") == 0)
2683 else if (Ustrcmp(name, "router_list") == 0)
2690 else if (Ustrcmp(name, "transport_list") == 0)
2692 type = US"transport";
2697 else if (Ustrcmp(name, "authenticator_list") == 0)
2699 type = US"authenticator";
2704 else if (Ustrcmp(name, "macro_list") == 0)
2711 else if (Ustrcmp(name, "environment") == 0)
2716 for (p = USS environ; *p; p++) ;
2717 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2719 for (p = USS environ; *p; p++)
2722 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2731 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2732 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2737 /* Handle the options for a router or transport. Skip options that are flagged
2738 as hidden. Some of these are options with names starting with '*', used for
2739 internal alternative representations of other options (which the printing
2740 function will sort out). Others are synonyms kept for backward compatibility.
2743 if (Ustrcmp(type, "router") == 0)
2745 d = (driver_instance *)routers;
2746 ol2 = optionlist_routers;
2747 size = optionlist_routers_size;
2749 else if (Ustrcmp(type, "transport") == 0)
2751 d = (driver_instance *)transports;
2752 ol2 = optionlist_transports;
2753 size = optionlist_transports_size;
2755 else if (Ustrcmp(type, "authenticator") == 0)
2757 d = (driver_instance *)auths;
2758 ol2 = optionlist_auths;
2759 size = optionlist_auths_size;
2762 else if (Ustrcmp(type, "macro") == 0)
2764 /* People store passwords in macros and they were previously not available
2765 for printing. So we have an admin_users restriction. */
2768 fprintf(stderr, "exim: permission denied\n");
2771 for (m = macros; m != NULL; m = m->next)
2773 if (name == NULL || Ustrcmp(name, m->name) == 0)
2776 printf("%s\n", CS m->name);
2778 printf("%s=%s\n", CS m->name, CS m->replacement);
2784 printf("%s %s not found\n", type, name);
2790 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2794 /* Either search for a given driver, or print all of them */
2796 for (; d != NULL; d = d->next)
2799 printf("\n%s %s:\n", d->name, type);
2800 else if (Ustrcmp(d->name, name) != 0) continue;
2802 for (ol = ol2; ol < ol2 + size; ol++)
2804 if ((ol->type & opt_hidden) == 0)
2805 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2808 for (ol = d->info->options;
2809 ol < d->info->options + *(d->info->options_count); ol++)
2811 if ((ol->type & opt_hidden) == 0)
2812 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2814 if (name != NULL) return;
2816 if (name != NULL) printf("%s %s not found\n", type, name);
2821 /*************************************************
2822 * Read a named list item *
2823 *************************************************/
2825 /* This function reads a name and a list (i.e. string). The name is used to
2826 save the list in a tree, sorted by its name. Each entry also has a number,
2827 which can be used for caching tests, but if the string contains any expansion
2828 items other than $key, the number is set negative to inhibit caching. This
2829 mechanism is used for domain, host, and address lists that are referenced by
2833 anchorp points to the tree anchor
2834 numberp points to the current number for this tree
2835 max the maximum number permitted
2836 s the text of the option line, starting immediately after the name
2838 tname the name of the list type, for messages
2844 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2847 BOOL forcecache = FALSE;
2850 namedlist_block *nb = store_get(sizeof(namedlist_block));
2852 if (Ustrncmp(s, "_cache", 6) == 0)
2859 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2861 if (*numberp >= max)
2862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2865 while (isspace(*s)) s++;
2867 while (isalnum(*s) || *s == '_') s++;
2868 t = store_get(sizeof(tree_node) + s-ss);
2869 Ustrncpy(t->name, ss, s-ss);
2871 while (isspace(*s)) s++;
2873 if (!tree_insertnode(anchorp, t))
2874 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2875 "duplicate name \"%s\" for a named %s", t->name, tname);
2878 nb->number = *numberp;
2881 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2882 "missing '=' after \"%s\"", t->name);
2883 while (isspace(*s)) s++;
2884 nb->string = read_string(s, t->name);
2885 nb->cache_data = NULL;
2887 /* Check the string for any expansions; if any are found, mark this list
2888 uncacheable unless the user has explicited forced caching. */
2890 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2896 /*************************************************
2897 * Unpick data for a rate limit *
2898 *************************************************/
2900 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2904 s string, in the form t,b,f,l
2905 where t is the threshold (integer)
2906 b is the initial delay (time)
2907 f is the multiplicative factor (fixed point)
2908 k is the maximum time (time)
2909 threshold where to store threshold
2910 base where to store base in milliseconds
2911 factor where to store factor in milliseconds
2912 limit where to store limit
2914 Returns: nothing (panics on error)
2918 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2921 uschar bstring[16], lstring[16];
2923 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2924 factor, lstring) == 4)
2926 *base = readconf_readtime(bstring, 0, TRUE);
2927 *limit = readconf_readtime(lstring, 0, TRUE);
2928 if (*base >= 0 && *limit >= 0) return;
2930 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2936 /*************************************************
2937 * Drop privs for checking TLS config *
2938 *************************************************/
2940 /* We want to validate TLS options during readconf, but do not want to be
2941 root when we call into the TLS library, in case of library linkage errors
2942 which cause segfaults; before this check, those were always done as the Exim
2943 runtime user and it makes sense to continue with that.
2945 Assumes: tls_require_ciphers has been set, if it will be
2946 exim_user has been set, if it will be
2947 exim_group has been set, if it will be
2949 Returns: bool for "okay"; false will cause caller to immediately exit.
2954 tls_dropprivs_validate_require_cipher(BOOL nowarn)
2956 const uschar *errmsg;
2959 void (*oldsignal)(int);
2961 /* If TLS will never be used, no point checking ciphers */
2963 if ( !tls_advertise_hosts
2964 || !*tls_advertise_hosts
2965 || Ustrcmp(tls_advertise_hosts, ":") == 0
2968 else if (!nowarn && !tls_certificate)
2969 log_write(0, LOG_MAIN,
2970 "Warning: No server certificate defined; will use a selfsigned one.\n"
2971 " Suggested action: either install a certificate or change tls_advertise_hosts option");
2973 oldsignal = signal(SIGCHLD, SIG_DFL);
2976 if ((pid = fork()) < 0)
2977 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2981 /* in some modes, will have dropped privilege already */
2983 exim_setugid(exim_uid, exim_gid, FALSE,
2984 US"calling tls_validate_require_cipher");
2986 errmsg = tls_validate_require_cipher();
2989 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2990 "tls_require_ciphers invalid: %s", errmsg);
2997 rc = waitpid(pid, &status, 0);
2998 } while (rc < 0 && errno == EINTR);
3001 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3004 signal(SIGCHLD, oldsignal);
3008 #endif /* SUPPORT_TLS */
3013 /*************************************************/
3014 /* Create compile-time feature macros */
3016 readconf_features(void)
3018 /* Probably we could work out a static initialiser for wherever
3019 macros are stored, but this will do for now. Some names are awkward
3020 due to conflicts with other common macros. */
3022 #ifdef SUPPORT_CRYPTEQ
3023 read_macro_assignment(US"_HAVE_CRYPTEQ=y");
3026 read_macro_assignment(US"_HAVE_ICONV=y");
3029 read_macro_assignment(US"_HAVE_IPV6=y");
3031 #ifdef HAVE_SETCLASSRESOURCES
3032 read_macro_assignment(US"_HAVE_SETCLASSRESOURCES=y");
3035 read_macro_assignment(US"_HAVE_PAM=y");
3038 read_macro_assignment(US"_HAVE_PERL=y");
3040 #ifdef EXPAND_DLFUNC
3041 read_macro_assignment(US"_HAVE_DLFUNC=y");
3043 #ifdef USE_TCP_WRAPPERS
3044 read_macro_assignment(US"_HAVE_TCPWRAPPERS=y");
3047 read_macro_assignment(US"_HAVE_TLS=y");
3049 read_macro_assignment(US"_HAVE_GNUTLS=y");
3051 read_macro_assignment(US"_HAVE_OPENSSL=y");
3054 #ifdef SUPPORT_TRANSLATE_IP_ADDRESS
3055 read_macro_assignment(US"_HAVE_TRANSLATE_IP_ADDRESS=y");
3057 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
3058 read_macro_assignment(US"_HAVE_MOVE_FROZEN_MESSAGES=y");
3060 #ifdef WITH_CONTENT_SCAN
3061 read_macro_assignment(US"_HAVE_CONTENT_SCANNING=y");
3063 #ifndef DISABLE_DKIM
3064 read_macro_assignment(US"_HAVE_DKIM=y");
3066 #ifndef DISABLE_DNSSEC
3067 read_macro_assignment(US"_HAVE_DNSSEC=y");
3069 #ifndef DISABLE_EVENT
3070 read_macro_assignment(US"_HAVE_Event=y");
3073 read_macro_assignment(US"_HAVE_I18N=y");
3075 #ifndef DISABLE_OCSP
3076 read_macro_assignment(US"_HAVE_OCSP=y");
3078 #ifndef DISABLE_PRDR
3079 read_macro_assignment(US"_HAVE_PRDR=y");
3081 #ifdef SUPPORT_PROXY
3082 read_macro_assignment(US"_HAVE_PROXY=y");
3084 #ifdef SUPPORT_SOCKS
3085 read_macro_assignment(US"_HAVE_SOCKS=y");
3087 #ifdef EXPERIMENTAL_LMDB
3088 read_macro_assignment(US"_HAVE_LMDB=y");
3090 #ifdef EXPERIMENTAL_SPF
3091 read_macro_assignment(US"_HAVE_SPF=y");
3093 #ifdef EXPERIMENTAL_SRS
3094 read_macro_assignment(US"_HAVE_SRS=y");
3096 #ifdef EXPERIMENTAL_BRIGHTMAIL
3097 read_macro_assignment(US"_HAVE_BRIGHTMAIL=y");
3099 #ifdef EXPERIMENTAL_DANE
3100 read_macro_assignment(US"_HAVE_DANE=y");
3102 #ifdef EXPERIMENTAL_DCC
3103 read_macro_assignment(US"_HAVE_DCC=y");
3105 #ifdef EXPERIMENTAL_DMARC
3106 read_macro_assignment(US"_HAVE_DMARC=y");
3108 #ifdef EXPERIMENTAL_DSN_INFO
3109 read_macro_assignment(US"_HAVE_DSN_INFO=y");
3112 #ifdef LOOKUP_LSEARCH
3113 read_macro_assignment(US"_HAVE_LKUP_LSEARCH=y");
3116 read_macro_assignment(US"_HAVE_LKUP_CDB=y");
3119 read_macro_assignment(US"_HAVE_LKUP_DBM=y");
3122 read_macro_assignment(US"_HAVE_LKUP_DNSDB=y");
3124 #ifdef LOOKUP_DSEARCH
3125 read_macro_assignment(US"_HAVE_LKUP_DSEARCH=y");
3128 read_macro_assignment(US"_HAVE_LKUP_IBASE=y");
3131 read_macro_assignment(US"_HAVE_LKUP_LDAP=y");
3133 #ifdef EXPERIMENTAL_LMDB
3134 read_macro_assignment(US"_HAVE_LKUP_LMDB=y");
3137 read_macro_assignment(US"_HAVE_LKUP_MYSQL=y");
3140 read_macro_assignment(US"_HAVE_LKUP_NIS=y");
3142 #ifdef LOOKUP_NISPLUS
3143 read_macro_assignment(US"_HAVE_LKUP_NISPLUS=y");
3145 #ifdef LOOKUP_ORACLE
3146 read_macro_assignment(US"_HAVE_LKUP_ORACLE=y");
3148 #ifdef LOOKUP_PASSWD
3149 read_macro_assignment(US"_HAVE_LKUP_PASSWD=y");
3152 read_macro_assignment(US"_HAVE_LKUP_PGSQL=y");
3155 read_macro_assignment(US"_HAVE_LKUP_REDIS=y");
3157 #ifdef LOOKUP_SQLITE
3158 read_macro_assignment(US"_HAVE_LKUP_SQLITE=y");
3160 #ifdef LOOKUP_TESTDB
3161 read_macro_assignment(US"_HAVE_LKUP_TESTDB=y");
3163 #ifdef LOOKUP_WHOSON
3164 read_macro_assignment(US"_HAVE_LKUP_WHOSON=y");
3167 #ifdef AUTH_CRAM_MD5
3168 read_macro_assignment(US"_HAVE_AUTH_CRAM_MD5=y");
3170 #ifdef AUTH_CYRUS_SASL
3171 read_macro_assignment(US"_HAVE_AUTH_CYRUS_SASL=y");
3174 read_macro_assignment(US"_HAVE_AUTH_DOVECOT=y");
3177 read_macro_assignment(US"_HAVE_AUTH_GSASL=y");
3179 #ifdef AUTH_HEIMDAL_GSSAPI
3180 read_macro_assignment(US"_HAVE_AUTH_HEIMDAL_GSSAPI=y");
3182 #ifdef AUTH_PLAINTEXT
3183 read_macro_assignment(US"_HAVE_AUTH_PLAINTEXT=y");
3186 read_macro_assignment(US"_HAVE_AUTH_SPA=y");
3189 read_macro_assignment(US"_HAVE_AUTH_TLS=y");
3192 #ifdef ROUTER_ACCEPT
3193 read_macro_assignment(US"_HAVE_RTR_ACCEPT=y");
3195 #ifdef ROUTER_DNSLOOKUP
3196 read_macro_assignment(US"_HAVE_RTR_DNSLOOKUP=y");
3198 #ifdef ROUTER_IPLITERAL
3199 read_macro_assignment(US"_HAVE_RTR_IPLITERAL=y");
3201 #ifdef ROUTER_IPLOOKUP
3202 read_macro_assignment(US"_HAVE_RTR_IPLOOKUP=y");
3204 #ifdef ROUTER_MANUALROUTE
3205 read_macro_assignment(US"_HAVE_RTR_MANUALROUTE=y");
3207 #ifdef ROUTER_QUERYPROGRAM
3208 read_macro_assignment(US"_HAVE_RTR_QUERYPROGRAM=y");
3210 #ifdef ROUTER_REDIRECT
3211 read_macro_assignment(US"_HAVE_RTR_REDRCT=y");
3214 #ifdef TRANSPORT_APPENDFILE
3215 read_macro_assignment(US"_HAVE_TPT_APPENDFILE=y");
3216 # ifdef SUPPORT_MAILDIR
3217 read_macro_assignment(US"_HAVE_TPT_APPEND_MAILDR=y");
3219 # ifdef SUPPORT_MAILSTORE
3220 read_macro_assignment(US"_HAVE_TPT_APPEND_MAILSTORE=y");
3223 read_macro_assignment(US"_HAVE_TPT_APPEND_MBX=y");
3226 #ifdef TRANSPORT_AUTOREPLY
3227 read_macro_assignment(US"_HAVE_TPT_AUTOREPLY=y");
3229 #ifdef TRANSPORT_LMTP
3230 read_macro_assignment(US"_HAVE_TPT_LMTP=y");
3232 #ifdef TRANSPORT_PIPE
3233 read_macro_assignment(US"_HAVE_TPT_PIPE=y");
3235 #ifdef TRANSPORT_SMTP
3236 read_macro_assignment(US"_HAVE_TPT_SMTP=y");
3241 /*************************************************
3242 * Read main configuration options *
3243 *************************************************/
3245 /* This function is the first to be called for configuration reading. It
3246 opens the configuration file and reads general configuration settings until
3247 it reaches the end of the configuration section. The file is then left open so
3248 that the remaining configuration data can subsequently be read if needed for
3251 The configuration file must be owned either by root or exim, and be writeable
3252 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3253 in the config file, so the test is done on the compiled in values. A slight
3254 anomaly, to be carefully documented.
3256 The name of the configuration file is taken from a list that is included in the
3257 binary of Exim. It can be altered from the command line, but if that is done,
3258 root privilege is immediately withdrawn unless the caller is root or exim.
3259 The first file on the list that exists is used.
3261 For use on multiple systems that share file systems, first look for a
3262 configuration file whose name has the current node name on the end. If that is
3263 not found, try the generic name. For really contorted configurations, that run
3264 multiple Exims with different uid settings, first try adding the effective uid
3265 before the node name. These complications are going to waste resources on most
3266 systems. Therefore they are available only when requested by compile-time
3270 readconf_main(BOOL nowarn)
3273 struct stat statbuf;
3274 uschar *s, *filename;
3275 const uschar *list = config_main_filelist;
3277 /* First create compile-time feature macros */
3278 readconf_features();
3280 /* Loop through the possible file names */
3282 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
3286 /* Cut out all the fancy processing unless specifically wanted */
3288 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3289 uschar *suffix = filename + Ustrlen(filename);
3291 /* Try for the node-specific file if a node name exists */
3293 #ifdef CONFIGURE_FILE_USE_NODE
3295 if (uname(&uts) >= 0)
3297 #ifdef CONFIGURE_FILE_USE_EUID
3298 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3299 config_file = Ufopen(filename, "rb");
3300 if (config_file == NULL)
3301 #endif /* CONFIGURE_FILE_USE_EUID */
3303 sprintf(CS suffix, ".%.256s", uts.nodename);
3304 config_file = Ufopen(filename, "rb");
3307 #endif /* CONFIGURE_FILE_USE_NODE */
3309 /* Otherwise, try the generic name, possibly with the euid added */
3311 #ifdef CONFIGURE_FILE_USE_EUID
3312 if (config_file == NULL)
3314 sprintf(CS suffix, ".%ld", (long int)original_euid);
3315 config_file = Ufopen(filename, "rb");
3317 #endif /* CONFIGURE_FILE_USE_EUID */
3319 /* Finally, try the unadorned name */
3321 if (config_file == NULL)
3324 config_file = Ufopen(filename, "rb");
3326 #else /* if neither defined */
3328 /* This is the common case when the fancy processing is not included. */
3330 config_file = Ufopen(filename, "rb");
3333 /* If the file does not exist, continue to try any others. For any other
3334 error, break out (and die). */
3336 if (config_file != NULL || errno != ENOENT) break;
3339 /* Now, once we found and opened our configuration file, we change the directory
3340 to a safe place. Later we change to $spool_directory. */
3342 if (Uchdir("/") < 0)
3344 perror("exim: chdir `/': ");
3348 /* On success, save the name for verification; config_filename is used when
3349 logging configuration errors (it changes for .included files) whereas
3350 config_main_filename is the name shown by -bP. Failure to open a configuration
3351 file is a serious disaster. */
3353 if (config_file != NULL)
3356 config_filename = config_main_filename = string_copy(filename);
3358 p = Ustrrchr(filename, '/');
3359 config_main_directory = p ? string_copyn(filename, p - filename)
3360 : string_copy(US".");
3364 if (filename == NULL)
3365 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3366 "%s", config_main_filelist);
3368 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3369 "configuration file %s", filename));
3372 /* Check the status of the file we have opened, if we have retained root
3373 privileges and the file isn't /dev/null (which *should* be 0666). */
3375 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3377 if (fstat(fileno(config_file), &statbuf) != 0)
3378 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3381 if ((statbuf.st_uid != root_uid /* owner not root */
3382 #ifdef CONFIGURE_OWNER
3383 && statbuf.st_uid != config_uid /* owner not the special one */
3386 (statbuf.st_gid != root_gid /* group not root & */
3387 #ifdef CONFIGURE_GROUP
3388 && statbuf.st_gid != config_gid /* group not the special one */
3390 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3392 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3394 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3395 "wrong owner, group, or mode", big_buffer);
3398 /* Process the main configuration settings. They all begin with a lower case
3399 letter. If we see something starting with an upper case letter, it is taken as
3400 a macro definition. */
3402 while ((s = get_config_line()) != NULL)
3404 if (isupper(s[0])) read_macro_assignment(s);
3406 else if (Ustrncmp(s, "domainlist", 10) == 0)
3407 read_named_list(&domainlist_anchor, &domainlist_count,
3408 MAX_NAMED_LIST, s+10, US"domain list");
3410 else if (Ustrncmp(s, "hostlist", 8) == 0)
3411 read_named_list(&hostlist_anchor, &hostlist_count,
3412 MAX_NAMED_LIST, s+8, US"host list");
3414 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3415 read_named_list(&addresslist_anchor, &addresslist_count,
3416 MAX_NAMED_LIST, s+11, US"address list");
3418 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3419 read_named_list(&localpartlist_anchor, &localpartlist_count,
3420 MAX_NAMED_LIST, s+13, US"local part list");
3423 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3424 NULL, US"main option \"%s\" unknown");
3428 /* If local_sender_retain is set, local_from_check must be unset. */
3430 if (local_sender_retain && local_from_check)
3431 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3432 "local_sender_retain are set; this combination is not allowed");
3434 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3437 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3439 /* The max retry interval must not be greater than 24 hours. */
3441 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3443 /* remote_max_parallel must be > 0 */
3445 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3447 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3448 start of a new SMTP message. */
3450 freeze_tell_config = freeze_tell;
3452 /* The primary host name may be required for expansion of spool_directory
3453 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3454 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3455 canonize it. Some people like upper case letters in their host names, so we
3456 don't force the case. */
3458 if (primary_hostname == NULL)
3460 const uschar *hostname;
3462 if (uname(&uts) < 0)
3463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3464 hostname = US uts.nodename;
3466 if (Ustrchr(hostname, '.') == NULL)
3469 struct hostent *hostdata;
3472 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3473 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3474 MCL_DOMAIN, TRUE, NULL) != OK))
3483 #if HAVE_GETIPNODEBYNAME
3485 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3487 hostdata = gethostbyname2(CS hostname, af);
3490 hostdata = gethostbyname(CS hostname);
3493 if (hostdata != NULL)
3495 hostname = US hostdata->h_name;
3499 if (af == AF_INET) break;
3504 primary_hostname = string_copy(hostname);
3507 /* Set up default value for smtp_active_hostname */
3509 smtp_active_hostname = primary_hostname;
3511 /* If spool_directory wasn't set in the build-time configuration, it must have
3512 got set above. Of course, writing to the log may not work if log_file_path is
3513 not set, but it will at least get to syslog or somewhere, with any luck. */
3515 if (*spool_directory == 0)
3516 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3519 /* Expand the spool directory name; it may, for example, contain the primary
3520 host name. Same comment about failure. */
3522 s = expand_string(spool_directory);
3524 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3525 "\"%s\": %s", spool_directory, expand_string_message);
3526 spool_directory = s;
3528 /* Expand log_file_path, which must contain "%s" in any component that isn't
3529 the null string or "syslog". It is also allowed to contain one instance of %D
3530 or %M. However, it must NOT contain % followed by anything else. */
3532 if (*log_file_path != 0)
3534 const uschar *ss, *sss;
3535 int sep = ':'; /* Fixed for log file path */
3536 s = expand_string(log_file_path);
3538 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3539 "\"%s\": %s", log_file_path, expand_string_message);
3542 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3545 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3546 t = Ustrstr(sss, "%s");
3548 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3549 "contain \"%%s\"", sss);
3551 t = Ustrchr(sss, '%');
3554 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3555 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3556 "unexpected \"%%\" character", s);
3563 /* Interpret syslog_facility into an integer argument for 'ident' param to
3564 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3567 if (syslog_facility_str != NULL)
3570 uschar *s = syslog_facility_str;
3572 if ((Ustrlen(syslog_facility_str) >= 4) &&
3573 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3576 for (i = 0; i < syslog_list_size; i++)
3578 if (strcmpic(s, syslog_list[i].name) == 0)
3580 syslog_facility = syslog_list[i].value;
3585 if (i >= syslog_list_size)
3587 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3588 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3592 /* Expand pid_file_path */
3594 if (*pid_file_path != 0)
3596 s = expand_string(pid_file_path);
3598 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3599 "\"%s\": %s", pid_file_path, expand_string_message);
3603 /* Set default value of process_log_path */
3605 if (process_log_path == NULL || *process_log_path =='\0')
3606 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3608 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3611 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3613 /* Unpick the SMTP rate limiting options, if set */
3615 if (smtp_ratelimit_mail != NULL)
3617 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3618 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3621 if (smtp_ratelimit_rcpt != NULL)
3623 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3624 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3627 /* The qualify domains default to the primary host name */
3629 if (qualify_domain_sender == NULL)
3630 qualify_domain_sender = primary_hostname;
3631 if (qualify_domain_recipient == NULL)
3632 qualify_domain_recipient = qualify_domain_sender;
3634 /* Setting system_filter_user in the configuration sets the gid as well if a
3635 name is given, but a numerical value does not. */
3637 if (system_filter_uid_set && !system_filter_gid_set)
3639 struct passwd *pw = getpwuid(system_filter_uid);
3641 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3642 (long int)system_filter_uid);
3643 system_filter_gid = pw->pw_gid;
3644 system_filter_gid_set = TRUE;
3647 /* If the errors_reply_to field is set, check that it is syntactically valid
3648 and ensure it contains a domain. */
3650 if (errors_reply_to != NULL)
3653 int start, end, domain;
3654 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3655 &start, &end, &domain, FALSE);
3657 if (recipient == NULL)
3658 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3659 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3662 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3663 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3666 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3667 smtp_accept_max must also be set. */
3669 if (smtp_accept_max == 0 &&
3670 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3672 "smtp_accept_max must be set if smtp_accept_queue or "
3673 "smtp_accept_max_per_host is set");
3675 /* Set up the host number if anything is specified. It is an expanded string
3676 so that it can be computed from the host name, for example. We do this last
3677 so as to ensure that everything else is set up before the expansion. */
3679 if (host_number_string != NULL)
3683 uschar *s = expand_string(host_number_string);
3685 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3686 "failed to expand localhost_number \"%s\": %s",
3687 host_number_string, expand_string_message);
3688 n = Ustrtol(s, &end, 0);
3689 while (isspace(*end)) end++;
3691 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3692 "localhost_number value is not a number: %s", s);
3693 if (n > LOCALHOST_MAX)
3694 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3695 "localhost_number is greater than the maximum allowed value (%d)",
3701 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3703 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3704 tls_verify_certificates == NULL)
3705 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3706 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3707 (tls_verify_hosts != NULL)? "" : "try_");
3709 /* This also checks that the library linkage is working and we can call
3710 routines in it, so call even if tls_require_ciphers is unset */
3711 if (!tls_dropprivs_validate_require_cipher(nowarn))
3714 /* Magic number: at time of writing, 1024 has been the long-standing value
3715 used by so many clients, and what Exim used to use always, that it makes
3716 sense to just min-clamp this max-clamp at that. */
3717 if (tls_dh_max_bits < 1024)
3718 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3719 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3721 /* If openssl_options is set, validate it */
3722 if (openssl_options != NULL)
3725 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3726 "openssl_options is set but we're using GnuTLS");
3729 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3730 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3731 "openssl_options parse error: %s", openssl_options);
3734 #endif /*SUPPORT_TLS*/
3736 if (!nowarn && !keep_environment && environ && *environ)
3737 log_write(0, LOG_MAIN,
3738 "Warning: purging the environment.\n"
3739 " Suggested action: use keep_environment.");
3744 /*************************************************
3745 * Initialize one driver *
3746 *************************************************/
3748 /* This is called once the driver's generic options, if any, have been read.
3749 We can now find the driver, set up defaults for the private options, and
3750 unset any "set" bits in the private options table (which might have been
3751 set by another incarnation of the same driver).
3754 d pointer to driver instance block, with generic
3756 drivers_available vector of available drivers
3757 size_of_info size of each block in drivers_available
3758 class class of driver, for error message
3760 Returns: pointer to the driver info block
3763 static driver_info *
3764 init_driver(driver_instance *d, driver_info *drivers_available,
3765 int size_of_info, uschar *class)
3769 for (dd = drivers_available; dd->driver_name[0] != 0;
3770 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3772 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3775 int len = dd->options_len;
3777 d->options_block = store_get(len);
3778 memcpy(d->options_block, dd->options_block, len);
3779 for (i = 0; i < *(dd->options_count); i++)
3780 dd->options[i].type &= ~opt_set;
3785 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3786 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3788 return NULL; /* never obeyed */
3794 /*************************************************
3795 * Initialize driver list *
3796 *************************************************/
3798 /* This function is called for routers, transports, and authentication
3799 mechanisms. It reads the data from the current point in the configuration file
3800 up to the end of the section, and sets up a chain of instance blocks according
3801 to the file's contents. The file will already have been opened by a call to
3802 readconf_main, and must be left open for subsequent reading of further data.
3804 Any errors cause a panic crash. Note that the blocks with names driver_info and
3805 driver_instance must map the first portions of all the _info and _instance
3806 blocks for this shared code to work.
3809 class "router", "transport", or "authenticator"
3810 anchor &routers, &transports, &auths
3811 drivers_available available drivers
3812 size_of_info size of each info block
3813 instance_default points to default data for an instance
3814 instance_size size of instance block
3815 driver_optionlist generic option list
3816 driver_optionlist_count count of generic option list
3822 readconf_driver_init(
3824 driver_instance **anchor,
3825 driver_info *drivers_available,
3827 void *instance_default,
3829 optionlist *driver_optionlist,
3830 int driver_optionlist_count)
3832 driver_instance **p = anchor;
3833 driver_instance *d = NULL;
3836 while ((buffer = get_config_line()) != NULL)
3841 /* Read the first name on the line and test for the start of a new driver. A
3842 macro definition indicates the end of the previous driver. If this isn't the
3843 start of a new driver, the line will be re-read. */
3845 s = readconf_readname(name, sizeof(name), buffer);
3847 /* Handle macro definition, first finishing off the initialization of the
3848 previous driver, if any. */
3850 if (isupper(*name) && *s == '=')
3854 if (!d->driver_name)
3855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3856 "no driver defined for %s \"%s\"", class, d->name);
3860 read_macro_assignment(buffer);
3864 /* If the line starts with a name terminated by a colon, we are at the
3865 start of the definition of a new driver. The rest of the line must be
3872 /* Finish off initializing the previous driver. */
3876 if (!d->driver_name)
3877 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3878 "no driver defined for %s \"%s\"", class, d->name);
3882 /* Check that we haven't already got a driver of this name */
3884 for (d = *anchor; d; d = d->next)
3885 if (Ustrcmp(name, d->name) == 0)
3886 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3887 "there are two %ss called \"%s\"", class, name);
3889 /* Set up a new driver instance data block on the chain, with
3890 its default values installed. */
3892 d = store_get(instance_size);
3893 memcpy(d, instance_default, instance_size);
3896 d->name = string_copy(name);
3898 /* Clear out the "set" bits in the generic options */
3900 for (i = 0; i < driver_optionlist_count; i++)
3901 driver_optionlist[i].type &= ~opt_set;
3903 /* Check nothing more on this line, then do the next loop iteration. */
3905 while (isspace(*s)) s++;
3906 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3910 /* Not the start of a new driver. Give an error if we have not set up a
3911 current driver yet. */
3914 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3916 /* First look to see if this is a generic option; if it is "driver",
3917 initialize the driver. If is it not a generic option, we can look for a
3918 private option provided that the driver has been previously set up. */
3920 if (readconf_handle_option(buffer, driver_optionlist,
3921 driver_optionlist_count, d, NULL))
3923 if (!d->info && d->driver_name)
3924 init_driver(d, drivers_available, size_of_info, class);
3927 /* Handle private options - pass the generic block because some may
3928 live therein. A flag with each option indicates if it is in the public
3932 readconf_handle_option(buffer, d->info->options,
3933 *(d->info->options_count), d, US"option \"%s\" unknown");
3935 /* The option is not generic and the driver name has not yet been given. */
3937 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3938 "(\"driver\" must be specified before any private options)", name);
3941 /* Run the initialization function for the final driver. */
3945 if (!d->driver_name)
3946 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3947 "no driver defined for %s \"%s\"", class, d->name);
3954 /*************************************************
3955 * Check driver dependency *
3956 *************************************************/
3958 /* This function is passed a driver instance and a string. It checks whether
3959 any of the string options for the driver contains the given string as an
3963 d points to a driver instance block
3964 s the string to search for
3966 Returns: TRUE if a dependency is found
3970 readconf_depends(driver_instance *d, uschar *s)
3972 int count = *(d->info->options_count);
3976 for (ol = d->info->options; ol < d->info->options + count; ol++)
3978 void *options_block;
3980 int type = ol->type & opt_mask;
3981 if (type != opt_stringptr) continue;
3982 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3983 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3984 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3986 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3987 isalnum(ss[Ustrlen(s)])) continue;
3988 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3989 d->name, ol->name, s);
3994 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4001 /*************************************************
4002 * Decode an error type for retries *
4003 *************************************************/
4005 /* This function is global because it is also called from the main
4006 program when testing retry information. It decodes strings such as "quota_7d"
4007 into numerical error codes.
4010 pp points to start of text
4011 p points past end of text
4012 basic_errno points to an int to receive the main error number
4013 more_errno points to an int to receive the secondary error data
4015 Returns: NULL if decoded correctly; else points to error text
4019 readconf_retry_error(const uschar *pp, const uschar *p,
4020 int *basic_errno, int *more_errno)
4023 const uschar *q = pp;
4024 while (q < p && *q != '_') q++;
4027 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4029 *basic_errno = ERRNO_EXIMQUOTA;
4030 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4031 return US"bad time value";
4034 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4036 *basic_errno = ECONNREFUSED;
4039 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4040 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4041 else return US"A or MX expected after \"refused\"";
4045 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4047 *basic_errno = ETIMEDOUT;
4051 int xlen = p - q - 1;
4052 const uschar *x = q + 1;
4054 static uschar *extras[] =
4055 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4056 static int values[] =
4057 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4059 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
4060 if (strncmpic(x, extras[i], xlen) == 0)
4062 *more_errno = values[i];
4066 if (i >= sizeof(extras)/sizeof(uschar *))
4067 if (strncmpic(x, US"DNS", xlen) == 0)
4068 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4069 "available in retry rules (it has never worked) - treated as "
4072 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4076 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4077 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4078 strncmpic(pp, US"data_4", 6) == 0)
4081 int x = 255; /* means "any 4xx code" */
4082 if (p != pp + 8) bad = TRUE; else
4084 int a = pp[6], b = pp[7];
4088 if (isdigit(b)) x += b - '0';
4089 else if (b == 'x') x += 100;
4092 else if (a != 'x' || b != 'x') bad = TRUE;
4096 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4097 "x is literal and d is any digit", pp);
4099 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4100 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4101 *more_errno = x << 8;
4104 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4105 strncmpic(q+1, US"failed", p-q-1) == 0)
4106 *basic_errno = ERRNO_AUTHFAIL;
4108 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4109 *basic_errno = ERRNO_SMTPCLOSED;
4111 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4112 *basic_errno = ERRNO_TLSREQUIRED;
4114 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4115 *basic_errno = ERRNO_UNKNOWNHOST;
4117 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4118 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4126 /*************************************************
4127 * Read retry information *
4128 *************************************************/
4130 /* Each line of retry information contains:
4132 . A domain name pattern or an address pattern;
4134 . An error name, possibly with additional data, or *;
4136 . An optional sequence of retry items, each consisting of an identifying
4137 letter, a cutoff time, and optional parameters.
4139 All this is decoded and placed into a control block. */
4142 /* Subroutine to read an argument, preceded by a comma and terminated
4143 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4144 1 = fixed point number (returned *1000).
4147 paddr pointer to pointer to current character; updated
4148 type 0 => read a time; 1 => read a fixed point number
4150 Returns: time in seconds or fixed point number * 1000
4154 retry_arg(const uschar **paddr, int type)
4156 const uschar *p = *paddr;
4159 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4161 while (isspace(*p)) p++;
4163 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4165 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4171 case 0: return readconf_readtime(pp, *p, FALSE);
4172 case 1: return readconf_readfixed(pp, *p);
4174 return 0; /* Keep picky compilers happy */
4177 /* The function proper */
4180 readconf_retries(void)
4182 retry_config **chain = &retries;
4186 while ((p = get_config_line()))
4188 retry_rule **rchain;
4192 next = store_get(sizeof(retry_config));
4195 chain = &(next->next);
4196 next->basic_errno = next->more_errno = 0;
4197 next->senders = NULL;
4199 rchain = &(next->rules);
4201 next->pattern = string_dequote(&p);
4202 while (isspace(*p)) p++;
4204 while (mac_isgraph(*p)) p++;
4205 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4206 "missing error type in retry rule");
4208 /* Test error names for things we understand. */
4210 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4211 &next->more_errno)))
4212 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4214 /* There may be an optional address list of senders to be used as another
4215 constraint on the rule. This was added later, so the syntax is a bit of a
4216 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4219 while (isspace(*p)) p++;
4220 if (Ustrncmp(p, "senders", 7) == 0)
4223 while (isspace(*p)) p++;
4224 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4225 "\"=\" expected after \"senders\" in retry rule");
4226 while (isspace(*p)) p++;
4227 next->senders = string_dequote(&p);
4230 /* Now the retry rules. Keep the maximum timeout encountered. */
4232 while (isspace(*p)) p++;
4236 retry_rule *rule = store_get(sizeof(retry_rule));
4238 rchain = &(rule->next);
4240 rule->rule = toupper(*p++);
4241 rule->timeout = retry_arg(&p, 0);
4242 if (rule->timeout > retry_maximum_timeout)
4243 retry_maximum_timeout = rule->timeout;
4247 case 'F': /* Fixed interval */
4248 rule->p1 = retry_arg(&p, 0);
4251 case 'G': /* Geometrically increasing intervals */
4252 case 'H': /* Ditto, but with randomness */
4253 rule->p1 = retry_arg(&p, 0);
4254 rule->p2 = retry_arg(&p, 1);
4258 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4262 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4263 (rule->rule != 'F' && rule->p2 < 1000))
4264 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4265 "bad parameters for retry rule");
4267 while (isspace(*p)) p++;
4271 while (isspace(*p)) p++;
4274 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4281 /*************************************************
4282 * Initialize authenticators *
4283 *************************************************/
4285 /* Read the authenticators section of the configuration file.
4294 auth_instance *au, *bu;
4295 readconf_driver_init(US"authenticator",
4296 (driver_instance **)(&auths), /* chain anchor */
4297 (driver_info *)auths_available, /* available drivers */
4298 sizeof(auth_info), /* size of info block */
4299 &auth_defaults, /* default values for generic options */
4300 sizeof(auth_instance), /* size of instance block */
4301 optionlist_auths, /* generic options */
4302 optionlist_auths_size);
4304 for (au = auths; au; au = au->next)
4306 if (!au->public_name)
4307 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4308 "the %s authenticator", au->name);
4310 for (bu = au->next; bu; bu = bu->next)
4311 if (strcmpic(au->public_name, bu->public_name) == 0)
4312 if ((au->client && bu->client) || (au->server && bu->server))
4313 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4314 "(%s and %s) have the same public name (%s)",
4315 au->client ? US"client" : US"server", au->name, bu->name,
4323 /*************************************************
4324 * Read ACL information *
4325 *************************************************/
4327 /* If this run of Exim is not doing something that involves receiving a
4328 message, we can just skip over the ACL information. No need to parse it.
4330 First, we have a function for acl_read() to call back to get the next line. We
4331 need to remember the line we passed, because at the end it will contain the
4332 name of the next ACL. */
4334 static uschar *acl_line;
4339 acl_line = get_config_line();
4344 /* Now the main function:
4355 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4358 acl_line = get_config_line();
4360 while(acl_line != NULL)
4366 p = readconf_readname(name, sizeof(name), acl_line);
4367 if (isupper(*name) && *p == '=')
4369 read_macro_assignment(acl_line);
4370 acl_line = get_config_line();
4374 if (*p != ':' || name[0] == 0)
4375 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4377 node = store_get(sizeof(tree_node) + Ustrlen(name));
4378 Ustrcpy(node->name, name);
4379 if (!tree_insertnode(&acl_anchor, node))
4380 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4381 "there are two ACLs called \"%s\"", name);
4383 node->data.ptr = acl_read(acl_callback, &error);
4385 if (node->data.ptr == NULL && error != NULL)
4386 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4392 /*************************************************
4393 * Read configuration for local_scan() *
4394 *************************************************/
4396 /* This function is called after "begin local_scan" is encountered in the
4397 configuration file. If the local_scan() function allows for configuration
4398 options, we can process them. Otherwise, we expire in a panic.
4405 local_scan_init(void)
4407 #ifndef LOCAL_SCAN_HAS_OPTIONS
4408 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4409 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4413 while ((p = get_config_line()) != NULL)
4415 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4416 NULL, US"local_scan option \"%s\" unknown");
4423 /*************************************************
4424 * Read rest of configuration (after main) *
4425 *************************************************/
4427 /* This function reads the rest of the runtime configuration, after the main
4428 configuration. It is called only when actually needed. Each subsequent section
4429 of the configuration starts with a line of the form
4433 where the name is "routers", "transports", etc. A section is terminated by
4434 hitting the next "begin" line, and the next name is left in next_section.
4435 Because it may confuse people as to whether the names are singular or plural,
4436 we add "s" if it's missing. There is always enough room in next_section for
4437 this. This function is basically just a switch.
4443 static uschar *section_list[] = {
4457 while(next_section[0] != 0)
4461 int last = sizeof(section_list) / sizeof(uschar *);
4463 int n = Ustrlen(next_section);
4465 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4469 int c = strcmpic(next_section, section_list[mid]);
4471 if (c > 0) first = mid + 1; else last = mid;
4473 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4474 "\"%.*s\" is not a known configuration section name", n, next_section);
4475 mid = (last + first)/2;
4479 if (((had ^= bit) & bit) == 0)
4480 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4481 "\"%.*s\" section is repeated in the configuration file", n,
4486 case 0: readconf_acl(); break;
4487 case 1: auths_init(); break;
4488 case 2: local_scan_init(); break;
4489 case 3: readconf_retries(); break;
4490 case 4: readconf_rewrites(); break;
4491 case 5: route_init(); break;
4492 case 6: transport_init(); break;
4496 (void)fclose(config_file);
4499 /* Init the storage for the pre-parsed config lines */
4501 readconf_save_config(const uschar *s)
4503 save_config_line(string_sprintf("# Exim Configuration (%s)",
4504 running_in_test_harness ? US"X" : s));
4508 save_config_position(const uschar *file, int line)
4510 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4513 /* Append a pre-parsed logical line to the config lines store,
4514 this operates on a global (static) list that holds all the pre-parsed
4515 config lines, we do no further processing here, output formatting and
4516 honouring of <hide> or macros will be done during output */
4518 save_config_line(const uschar* line)
4520 static config_line_item *current;
4521 config_line_item *next;
4523 next = (config_line_item*) store_get(sizeof(config_line_item));
4524 next->line = string_copy(line);
4527 if (!config_lines) config_lines = next;
4528 else current->next = next;
4533 /* List the parsed config lines, care about nice formatting and
4534 hide the <hide> values unless we're the admin user */
4536 print_config(BOOL admin, BOOL terse)
4538 config_line_item *i;
4539 const int TS = terse ? 0 : 2;
4542 for (i = config_lines; i; i = i->next)
4547 /* skip over to the first non-space */
4548 for (current = i->line; *current && isspace(*current); ++current)
4551 if (*current == '\0')
4554 /* Collapse runs of spaces. We stop this if we encounter one of the
4555 * following characters: "'$, as this may indicate careful formatting */
4556 for (p = current; *p; ++p)
4559 if (!isspace(*p)) continue;
4560 if (*p != ' ') *p = ' ';
4562 for (next = p; isspace(*next); ++next)
4566 memmove(p+1, next, Ustrlen(next)+1);
4568 if (*next == '"' || *next == '\'' || *next == '$')
4573 if (current[0] == '#')
4576 /* begin lines are left aligned */
4577 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4579 if (!terse) puts("");
4584 /* router/acl/transport block names */
4585 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4587 if (!terse) puts("");
4588 printf("%*s%s\n", TS, "", current);
4592 /* hidden lines (all MACROS or lines prefixed with "hide") */
4594 && ( isupper(*current)
4595 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4599 if ((p = Ustrchr(current, '=')))
4602 printf("%*s%s= %s\n", indent, "", current, hidden);
4604 /* e.g.: hide split_spool_directory */
4606 printf("%*s\n", indent, hidden);
4610 /* rest is public */
4611 printf("%*s%s\n", indent, "", current);
4617 /* End of readconf.c */