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);
20 static void readconf_options_auths(void);
23 #define CSTATE_STACK_SIZE 10
25 const uschar *config_directory = NULL;
28 /* Structure for chain (stack) of .included files */
30 typedef struct config_file_item {
31 struct config_file_item *next;
32 const uschar *filename;
33 const uschar *directory;
38 /* Structure for chain of configuration lines (-bP config) */
40 typedef struct config_line_item {
41 struct config_line_item *next;
45 static config_line_item* config_lines;
47 /* Structure of table of conditional words and their state transitions */
49 typedef struct cond_item {
57 /* Structure of table of syslog facility names and values */
59 typedef struct syslog_fac_item {
65 static const char * const hidden = "<value not displayable>";
67 /* Static variables */
69 static config_file_item *config_file_stack = NULL; /* For includes */
71 static uschar *syslog_facility_str = NULL;
72 static uschar next_section[24];
73 static uschar time_buffer[24];
75 /* State variables for conditional loading (.ifdef / .else / .endif) */
77 static int cstate = 0;
78 static int cstate_stack_ptr = -1;
79 static int cstate_stack[CSTATE_STACK_SIZE];
81 /* Table of state transitions for handling conditional inclusions. There are
82 four possible state transitions:
86 .elifdef true (or .else)
89 .endif just causes the previous cstate to be popped off the stack */
91 static int next_cstate[3][4] =
93 /* State 0: reading from file, or reading until next .else or .endif */
95 /* State 1: condition failed, skipping until next .else or .endif */
97 /* State 2: skipping until .endif */
101 /* Table of conditionals and the states to set. For each name, there are four
102 values: the length of the name (to save computing it each time), the state to
103 set if a macro was found in the line, the state to set if a macro was not found
104 in the line, and a stack manipulation setting which is:
106 -1 pull state value off the stack
107 0 don't alter the stack
108 +1 push value onto stack, before setting new state
111 static cond_item cond_list[] = {
112 { US"ifdef", 5, 0, 1, 1 },
113 { US"ifndef", 6, 1, 0, 1 },
114 { US"elifdef", 7, 2, 3, 0 },
115 { US"elifndef", 8, 3, 2, 0 },
116 { US"else", 4, 2, 2, 0 },
117 { US"endif", 5, 0, 0, -1 }
120 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
122 /* Table of syslog facility names and their values */
124 static syslog_fac_item syslog_list[] = {
125 { US"mail", LOG_MAIL },
126 { US"user", LOG_USER },
127 { US"news", LOG_NEWS },
128 { US"uucp", LOG_UUCP },
129 { US"local0", LOG_LOCAL0 },
130 { US"local1", LOG_LOCAL1 },
131 { US"local2", LOG_LOCAL2 },
132 { US"local3", LOG_LOCAL3 },
133 { US"local4", LOG_LOCAL4 },
134 { US"local5", LOG_LOCAL5 },
135 { US"local6", LOG_LOCAL6 },
136 { US"local7", LOG_LOCAL7 },
137 { US"daemon", LOG_DAEMON }
140 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
145 /*************************************************
146 * Main configuration options *
147 *************************************************/
149 /* The list of options that can be set in the main configuration file. This
150 must be in alphabetic order because it is searched by binary chop. */
152 static optionlist optionlist_config[] = {
153 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
154 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
155 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
156 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
157 { "accept_8bitmime", opt_bool, &accept_8bitmime },
158 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
159 #ifdef WITH_CONTENT_SCAN
160 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
162 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
163 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
164 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
165 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
167 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
170 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
172 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
173 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
174 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
175 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
176 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
177 #ifdef WITH_CONTENT_SCAN
178 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
180 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
181 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
182 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
183 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
185 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
187 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
188 { "add_environment", opt_stringptr, &add_environment },
189 { "admin_groups", opt_gidlist, &admin_groups },
190 { "allow_domain_literals", opt_bool, &allow_domain_literals },
191 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
192 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
193 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
194 { "auto_thaw", opt_time, &auto_thaw },
195 #ifdef WITH_CONTENT_SCAN
196 { "av_scanner", opt_stringptr, &av_scanner },
198 { "bi_command", opt_stringptr, &bi_command },
199 #ifdef EXPERIMENTAL_BRIGHTMAIL
200 { "bmi_config_file", opt_stringptr, &bmi_config_file },
202 { "bounce_message_file", opt_stringptr, &bounce_message_file },
203 { "bounce_message_text", opt_stringptr, &bounce_message_text },
204 { "bounce_return_body", opt_bool, &bounce_return_body },
205 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
206 { "bounce_return_message", opt_bool, &bounce_return_message },
207 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
208 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
209 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
210 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
211 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
212 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
213 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
214 { "check_log_inodes", opt_int, &check_log_inodes },
215 { "check_log_space", opt_Kint, &check_log_space },
216 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
217 { "check_spool_inodes", opt_int, &check_spool_inodes },
218 { "check_spool_space", opt_Kint, &check_spool_space },
219 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
220 { "commandline_checks_require_admin", opt_bool,&commandline_checks_require_admin },
221 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
222 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
223 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
224 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
225 #ifdef EXPERIMENTAL_DCC
226 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
227 { "dccifd_address", opt_stringptr, &dccifd_address },
228 { "dccifd_options", opt_stringptr, &dccifd_options },
230 { "debug_store", opt_bool, &debug_store },
231 { "delay_warning", opt_timelist, &delay_warning },
232 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
233 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
234 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
235 { "delivery_date_remove", opt_bool, &delivery_date_remove },
236 #ifdef ENABLE_DISABLE_FSYNC
237 { "disable_fsync", opt_bool, &disable_fsync },
239 { "disable_ipv6", opt_bool, &disable_ipv6 },
241 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
243 #ifdef EXPERIMENTAL_DMARC
244 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
245 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
246 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
248 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
249 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
250 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
251 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
252 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
253 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
254 { "dns_retrans", opt_time, &dns_retrans },
255 { "dns_retry", opt_int, &dns_retry },
256 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
257 { "dns_use_edns0", opt_int, &dns_use_edns0 },
258 /* This option is now a no-op, retained for compatibility */
259 { "drop_cr", opt_bool, &drop_cr },
260 /*********************************************************/
261 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
262 { "dsn_from", opt_stringptr, &dsn_from },
263 { "envelope_to_remove", opt_bool, &envelope_to_remove },
264 { "errors_copy", opt_stringptr, &errors_copy },
265 { "errors_reply_to", opt_stringptr, &errors_reply_to },
266 #ifndef DISABLE_EVENT
267 { "event_action", opt_stringptr, &event_action },
269 { "exim_group", opt_gid, &exim_gid },
270 { "exim_path", opt_stringptr, &exim_path },
271 { "exim_user", opt_uid, &exim_uid },
272 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
273 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
274 { "finduser_retries", opt_int, &finduser_retries },
275 { "freeze_tell", opt_stringptr, &freeze_tell },
276 { "gecos_name", opt_stringptr, &gecos_name },
277 { "gecos_pattern", opt_stringptr, &gecos_pattern },
279 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
280 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
282 { "header_line_maxsize", opt_int, &header_line_maxsize },
283 { "header_maxsize", opt_int, &header_maxsize },
284 { "headers_charset", opt_stringptr, &headers_charset },
285 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
286 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
287 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
288 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
289 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
290 { "hold_domains", opt_stringptr, &hold_domains },
291 { "host_lookup", opt_stringptr, &host_lookup },
292 { "host_lookup_order", opt_stringptr, &host_lookup_order },
293 { "host_reject_connection", opt_stringptr, &host_reject_connection },
294 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
296 { "hosts_proxy", opt_stringptr, &hosts_proxy },
298 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
300 { "ibase_servers", opt_stringptr, &ibase_servers },
302 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
303 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
304 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
305 { "keep_environment", opt_stringptr, &keep_environment },
306 { "keep_malformed", opt_time, &keep_malformed },
308 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
309 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
310 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
311 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
312 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
313 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
314 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
315 { "ldap_start_tls", opt_bool, &eldap_start_tls },
316 { "ldap_version", opt_int, &eldap_version },
318 { "local_from_check", opt_bool, &local_from_check },
319 { "local_from_prefix", opt_stringptr, &local_from_prefix },
320 { "local_from_suffix", opt_stringptr, &local_from_suffix },
321 { "local_interfaces", opt_stringptr, &local_interfaces },
322 { "local_scan_timeout", opt_time, &local_scan_timeout },
323 { "local_sender_retain", opt_bool, &local_sender_retain },
324 { "localhost_number", opt_stringptr, &host_number_string },
325 { "log_file_path", opt_stringptr, &log_file_path },
326 { "log_selector", opt_stringptr, &log_selector_string },
327 { "log_timezone", opt_bool, &log_timezone },
328 { "lookup_open_max", opt_int, &lookup_open_max },
329 { "max_username_length", opt_int, &max_username_length },
330 { "message_body_newlines", opt_bool, &message_body_newlines },
331 { "message_body_visible", opt_mkint, &message_body_visible },
332 { "message_id_header_domain", opt_stringptr, &message_id_domain },
333 { "message_id_header_text", opt_stringptr, &message_id_text },
334 { "message_logs", opt_bool, &message_logs },
335 { "message_size_limit", opt_stringptr, &message_size_limit },
336 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
337 { "move_frozen_messages", opt_bool, &move_frozen_messages },
339 { "mua_wrapper", opt_bool, &mua_wrapper },
341 { "mysql_servers", opt_stringptr, &mysql_servers },
343 { "never_users", opt_uidlist, &never_users },
345 { "openssl_options", opt_stringptr, &openssl_options },
348 { "oracle_servers", opt_stringptr, &oracle_servers },
350 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
352 { "perl_at_start", opt_bool, &opt_perl_at_start },
353 { "perl_startup", opt_stringptr, &opt_perl_startup },
354 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
357 { "pgsql_servers", opt_stringptr, &pgsql_servers },
359 { "pid_file_path", opt_stringptr, &pid_file_path },
360 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
362 { "prdr_enable", opt_bool, &prdr_enable },
364 { "preserve_message_logs", opt_bool, &preserve_message_logs },
365 { "primary_hostname", opt_stringptr, &primary_hostname },
366 { "print_topbitchars", opt_bool, &print_topbitchars },
367 { "process_log_path", opt_stringptr, &process_log_path },
368 { "prod_requires_admin", opt_bool, &prod_requires_admin },
369 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
370 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
371 { "queue_domains", opt_stringptr, &queue_domains },
372 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
373 { "queue_only", opt_bool, &queue_only },
374 { "queue_only_file", opt_stringptr, &queue_only_file },
375 { "queue_only_load", opt_fixed, &queue_only_load },
376 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
377 { "queue_only_override", opt_bool, &queue_only_override },
378 { "queue_run_in_order", opt_bool, &queue_run_in_order },
379 { "queue_run_max", opt_stringptr, &queue_run_max },
380 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
381 { "receive_timeout", opt_time, &receive_timeout },
382 { "received_header_text", opt_stringptr, &received_header_text },
383 { "received_headers_max", opt_int, &received_headers_max },
384 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
385 { "recipients_max", opt_int, &recipients_max },
386 { "recipients_max_reject", opt_bool, &recipients_max_reject },
388 { "redis_servers", opt_stringptr, &redis_servers },
390 { "remote_max_parallel", opt_int, &remote_max_parallel },
391 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
392 { "retry_data_expire", opt_time, &retry_data_expire },
393 { "retry_interval_max", opt_time, &retry_interval_max },
394 { "return_path_remove", opt_bool, &return_path_remove },
395 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
396 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
397 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
398 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
399 { "slow_lookup_log", opt_int, &slow_lookup_log },
400 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
401 { "smtp_accept_max", opt_int, &smtp_accept_max },
402 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
403 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
404 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
405 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
406 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
407 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
408 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
409 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
410 { "smtp_banner", opt_stringptr, &smtp_banner },
411 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
412 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
413 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
414 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
415 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
416 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
417 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
418 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
419 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
420 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
421 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
422 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
423 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
424 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
426 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
428 #ifdef WITH_CONTENT_SCAN
429 { "spamd_address", opt_stringptr, &spamd_address },
431 #ifdef EXPERIMENTAL_SPF
432 { "spf_guess", opt_stringptr, &spf_guess },
434 { "split_spool_directory", opt_bool, &split_spool_directory },
435 { "spool_directory", opt_stringptr, &spool_directory },
436 { "spool_wireformat", opt_bool, &spool_wireformat },
438 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
440 #ifdef EXPERIMENTAL_SRS
441 { "srs_config", opt_stringptr, &srs_config },
442 { "srs_hashlength", opt_int, &srs_hashlength },
443 { "srs_hashmin", opt_int, &srs_hashmin },
444 { "srs_maxage", opt_int, &srs_maxage },
445 { "srs_secrets", opt_stringptr, &srs_secrets },
446 { "srs_usehash", opt_bool, &srs_usehash },
447 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
449 { "strict_acl_vars", opt_bool, &strict_acl_vars },
450 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
451 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
452 { "syslog_duplication", opt_bool, &syslog_duplication },
453 { "syslog_facility", opt_stringptr, &syslog_facility_str },
454 { "syslog_pid", opt_bool, &syslog_pid },
455 { "syslog_processname", opt_stringptr, &syslog_processname },
456 { "syslog_timestamp", opt_bool, &syslog_timestamp },
457 { "system_filter", opt_stringptr, &system_filter },
458 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
459 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
460 { "system_filter_group", opt_gid, &system_filter_gid },
461 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
462 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
463 { "system_filter_user", opt_uid, &system_filter_uid },
464 { "tcp_nodelay", opt_bool, &tcp_nodelay },
465 #ifdef USE_TCP_WRAPPERS
466 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
468 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
469 { "timezone", opt_stringptr, &timezone_string },
470 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
472 { "tls_certificate", opt_stringptr, &tls_certificate },
473 { "tls_crl", opt_stringptr, &tls_crl },
474 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
475 { "tls_dhparam", opt_stringptr, &tls_dhparam },
476 { "tls_eccurve", opt_stringptr, &tls_eccurve },
477 # ifndef DISABLE_OCSP
478 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
480 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
481 { "tls_privatekey", opt_stringptr, &tls_privatekey },
482 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
483 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
484 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
485 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
486 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
488 { "trusted_groups", opt_gidlist, &trusted_groups },
489 { "trusted_users", opt_uidlist, &trusted_users },
490 { "unknown_login", opt_stringptr, &unknown_login },
491 { "unknown_username", opt_stringptr, &unknown_username },
492 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
493 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
494 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
495 { "warn_message_file", opt_stringptr, &warn_message_file },
496 { "write_rejectlog", opt_bool, &write_rejectlog }
499 static int optionlist_config_size = nelem(optionlist_config);
503 /*************************************************
504 * Find the name of an option *
505 *************************************************/
507 /* This function is to aid debugging. Various functions take arguments that are
508 pointer variables in the options table or in option tables for various drivers.
509 For debugging output, it is useful to be able to find the name of the option
510 which is currently being processed. This function finds it, if it exists, by
511 searching the table(s).
513 Arguments: a value that is presumed to be in the table above
514 Returns: the option name, or an empty string
518 readconf_find_option(void *p)
522 transport_instance *t;
524 for (i = 0; i < nelem(optionlist_config); i++)
525 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
527 for (r = routers; r; r = r->next)
529 router_info *ri = r->info;
530 for (i = 0; i < *ri->options_count; i++)
532 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
533 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
534 return US ri->options[i].name;
538 for (t = transports; t; t = t->next)
540 transport_info *ti = t->info;
541 for (i = 0; i < *ti->options_count; i++)
543 optionlist * op = &ti->options[i];
544 if ((op->type & opt_mask) != opt_stringptr) continue;
545 if (p == ( op->type & opt_public
547 : (char *)t->options_block
549 + (long int)op->value)
560 /*************************************************
561 * Deal with an assignment to a macro *
562 *************************************************/
564 /* We have a new definition. The macro_item structure includes a final vector
565 called "name" which is one byte long. Thus, adding "namelen" gives us enough
566 room to store the "name" string.
567 If a builtin macro we place at head of list, else tail. This lets us lazy-create
571 macro_create(const uschar * name, const uschar * val,
572 BOOL command_line, BOOL builtin)
574 unsigned namelen = Ustrlen(name);
575 macro_item * m = store_get(sizeof(macro_item) + namelen);
577 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val) */
595 m->command_line = command_line;
596 m->namelen = namelen;
597 m->replacement = string_copy(val);
598 Ustrcpy(m->name, name);
603 /* This function is called when a line that starts with an upper case letter is
604 encountered. The argument "line" should contain a complete logical line, and
605 start with the first letter of the macro name. The macro name and the
606 replacement text are extracted and stored. Redefinition of existing,
607 non-command line, macros is permitted using '==' instead of '='.
610 s points to the start of the logical line
616 read_macro_assignment(uschar *s)
623 while (isalnum(*s) || *s == '_')
625 if (namelen >= sizeof(name) - 1)
626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
627 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
628 name[namelen++] = *s++;
632 while (isspace(*s)) s++;
634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
641 while (isspace(*s)) s++;
643 /* If an existing macro of the same name was defined on the command line, we
644 just skip this definition. It's an error to attempt to redefine a macro without
645 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
646 It is also an error to define a macro whose name begins with the name of a
647 previously defined macro. This is the requirement that make using a tree
648 for macros hard; we must check all macros for the substring. Perhaps a
649 sorted list, and a bsearch, would work?
650 Note: it is documented that the other way round works. */
652 for (m = macros; m; m = m->next)
654 if (Ustrcmp(m->name, name) == 0)
656 if (!m->command_line && !redef)
657 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
658 "defined (use \"==\" if you want to redefine it", name);
662 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
663 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
664 "a macro because previously defined macro \"%s\" is a substring",
667 /* We cannot have this test, because it is documented that a substring
668 macro is permitted (there is even an example).
670 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
671 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
672 * "a macro because it is a substring of previously defined macro \"%s\"",
677 /* Check for an overriding command-line definition. */
679 if (m && m->command_line) return;
681 /* Redefinition must refer to an existing macro. */
685 m->replacement = string_copy(s);
687 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
690 /* We have a new definition. */
692 (void) macro_create(name, s, FALSE, FALSE);
699 /*************************************************/
700 /* Create compile-time feature macros */
702 readconf_features(void)
704 /* Probably we could work out a static initialiser for wherever
705 macros are stored, but this will do for now. Some names are awkward
706 due to conflicts with other common macros. */
708 #ifdef SUPPORT_CRYPTEQ
709 macro_create(US"_HAVE_CRYPTEQ", US"y", FALSE, TRUE);
712 macro_create(US"_HAVE_ICONV", US"y", FALSE, TRUE);
715 macro_create(US"_HAVE_IPV6", US"y", FALSE, TRUE);
717 #ifdef HAVE_SETCLASSRESOURCES
718 macro_create(US"_HAVE_SETCLASSRESOURCES", US"y", FALSE, TRUE);
721 macro_create(US"_HAVE_PAM", US"y", FALSE, TRUE);
724 macro_create(US"_HAVE_PERL", US"y", FALSE, TRUE);
727 macro_create(US"_HAVE_DLFUNC", US"y", FALSE, TRUE);
729 #ifdef USE_TCP_WRAPPERS
730 macro_create(US"_HAVE_TCPWRAPPERS", US"y", FALSE, TRUE);
733 macro_create(US"_HAVE_TLS", US"y", FALSE, TRUE);
735 macro_create(US"_HAVE_GNUTLS", US"y", FALSE, TRUE);
737 macro_create(US"_HAVE_OPENSSL", US"y", FALSE, TRUE);
740 #ifdef SUPPORT_TRANSLATE_IP_ADDRESS
741 macro_create(US"_HAVE_TRANSLATE_IP_ADDRESS", US"y", FALSE, TRUE);
743 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
744 macro_create(US"_HAVE_MOVE_FROZEN_MESSAGES", US"y", FALSE, TRUE);
746 #ifdef WITH_CONTENT_SCAN
747 macro_create(US"_HAVE_CONTENT_SCANNING", US"y", FALSE, TRUE);
750 macro_create(US"_HAVE_DKIM", US"y", FALSE, TRUE);
752 #ifndef DISABLE_DNSSEC
753 macro_create(US"_HAVE_DNSSEC", US"y", FALSE, TRUE);
755 #ifndef DISABLE_EVENT
756 macro_create(US"_HAVE_EVENT", US"y", FALSE, TRUE);
759 macro_create(US"_HAVE_I18N", US"y", FALSE, TRUE);
762 macro_create(US"_HAVE_OCSP", US"y", FALSE, TRUE);
765 macro_create(US"_HAVE_PRDR", US"y", FALSE, TRUE);
768 macro_create(US"_HAVE_PROXY", US"y", FALSE, TRUE);
771 macro_create(US"_HAVE_SOCKS", US"y", FALSE, TRUE);
774 macro_create(US"_HAVE_TCP_FASTOPEN", US"y", FALSE, TRUE);
776 #ifdef EXPERIMENTAL_LMDB
777 macro_create(US"_HAVE_LMDB", US"y", FALSE, TRUE);
779 #ifdef EXPERIMENTAL_SPF
780 macro_create(US"_HAVE_SPF", US"y", FALSE, TRUE);
782 #ifdef EXPERIMENTAL_SRS
783 macro_create(US"_HAVE_SRS", US"y", FALSE, TRUE);
785 #ifdef EXPERIMENTAL_BRIGHTMAIL
786 macro_create(US"_HAVE_BRIGHTMAIL", US"y", FALSE, TRUE);
788 #ifdef EXPERIMENTAL_DANE
789 macro_create(US"_HAVE_DANE", US"y", FALSE, TRUE);
791 #ifdef EXPERIMENTAL_DCC
792 macro_create(US"_HAVE_DCC", US"y", FALSE, TRUE);
794 #ifdef EXPERIMENTAL_DMARC
795 macro_create(US"_HAVE_DMARC", US"y", FALSE, TRUE);
797 #ifdef EXPERIMENTAL_DSN_INFO
798 macro_create(US"_HAVE_DSN_INFO", US"y", FALSE, TRUE);
801 #ifdef LOOKUP_LSEARCH
802 macro_create(US"_HAVE_LOOKUP_LSEARCH", US"y", FALSE, TRUE);
805 macro_create(US"_HAVE_LOOKUP_CDB", US"y", FALSE, TRUE);
808 macro_create(US"_HAVE_LOOKUP_DBM", US"y", FALSE, TRUE);
811 macro_create(US"_HAVE_LOOKUP_DNSDB", US"y", FALSE, TRUE);
813 #ifdef LOOKUP_DSEARCH
814 macro_create(US"_HAVE_LOOKUP_DSEARCH", US"y", FALSE, TRUE);
817 macro_create(US"_HAVE_LOOKUP_IBASE", US"y", FALSE, TRUE);
820 macro_create(US"_HAVE_LOOKUP_LDAP", US"y", FALSE, TRUE);
822 #ifdef EXPERIMENTAL_LMDB
823 macro_create(US"_HAVE_LOOKUP_LMDB", US"y", FALSE, TRUE);
826 macro_create(US"_HAVE_LOOKUP_MYSQL", US"y", FALSE, TRUE);
829 macro_create(US"_HAVE_LOOKUP_NIS", US"y", FALSE, TRUE);
831 #ifdef LOOKUP_NISPLUS
832 macro_create(US"_HAVE_LOOKUP_NISPLUS", US"y", FALSE, TRUE);
835 macro_create(US"_HAVE_LOOKUP_ORACLE", US"y", FALSE, TRUE);
838 macro_create(US"_HAVE_LOOKUP_PASSWD", US"y", FALSE, TRUE);
841 macro_create(US"_HAVE_LOOKUP_PGSQL", US"y", FALSE, TRUE);
844 macro_create(US"_HAVE_LOOKUP_REDIS", US"y", FALSE, TRUE);
847 macro_create(US"_HAVE_LOOKUP_SQLITE", US"y", FALSE, TRUE);
850 macro_create(US"_HAVE_LOOKUP_TESTDB", US"y", FALSE, TRUE);
853 macro_create(US"_HAVE_LOOKUP_WHOSON", US"y", FALSE, TRUE);
856 #ifdef TRANSPORT_APPENDFILE
857 # ifdef SUPPORT_MAILDIR
858 macro_create(US"_HAVE_TRANSPORT_APPEND_MAILDIR", US"y", FALSE, TRUE);
860 # ifdef SUPPORT_MAILSTORE
861 macro_create(US"_HAVE_TRANSPORT_APPEND_MAILSTORE", US"y", FALSE, TRUE);
864 macro_create(US"_HAVE_TRANSPORT_APPEND_MBX", US"y", FALSE, TRUE);
871 readconf_options_from_list(optionlist * opts, unsigned nopt, const uschar * section, uschar * group)
876 /* The 'previously-defined-substring' rule for macros in config file
877 lines is done so for these builtin macros: we know that the table
878 we source from is in strict alpha order, hence the builtins portion
879 of the macros list is in reverse-alpha (we prepend them) - so longer
880 macros that have substrings are always discovered first during
883 for (i = 0; i < nopt; i++) if (*(s = US opts[i].name) && *s != '*')
885 macro_create(string_sprintf("_OPT_%T_%T_%T", section, group, s), US"y", FALSE, TRUE);
887 macro_create(string_sprintf("_OPT_%T_%T", section, s), US"y", FALSE, TRUE);
892 readconf_options(void)
894 readconf_options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
895 readconf_options_routers();
896 readconf_options_transports();
897 readconf_options_auths();
901 macros_create_builtin(void)
905 macros_builtin_created = TRUE;
909 /*************************************************
910 * Read configuration line *
911 *************************************************/
913 /* A logical line of text is read from the configuration file into the big
914 buffer, taking account of macros, .includes, and continuations. The size of
915 big_buffer is increased if necessary. The count of configuration lines is
916 maintained. Physical input lines starting with # (ignoring leading white space,
917 and after macro replacement) and empty logical lines are always ignored.
918 Leading and trailing spaces are removed.
920 If we hit a line of the form "begin xxxx", the xxxx is placed in the
921 next_section vector, and the function returns NULL, indicating the end of a
922 configuration section. On end-of-file, NULL is returned with next_section
927 Returns: a pointer to the first non-blank in the line,
928 or NULL if eof or end of section is reached
932 get_config_line(void)
934 int startoffset = 0; /* To first non-blank char in logical line */
935 int len = 0; /* Of logical line so far */
941 /* Loop for handling continuation lines, skipping comments, and dealing with
946 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
948 if (config_file_stack != NULL) /* EOF inside .include */
950 (void)fclose(config_file);
951 config_file = config_file_stack->file;
952 config_filename = config_file_stack->filename;
953 config_directory = config_file_stack->directory;
954 config_lineno = config_file_stack->lineno;
955 config_file_stack = config_file_stack->next;
957 save_config_position(config_filename, config_lineno);
961 /* EOF at top level */
963 if (cstate_stack_ptr >= 0)
964 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
965 "Unexpected end of configuration file: .endif missing");
967 if (len != 0) break; /* EOF after continuation */
968 next_section[0] = 0; /* EOF at start of logical line */
973 newlen = len + Ustrlen(big_buffer + len);
975 if (config_lines && config_lineno == 1)
976 save_config_position(config_filename, config_lineno);
978 /* Handle pathologically long physical lines - yes, it did happen - by
979 extending big_buffer at this point. The code also copes with very long
982 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
985 big_buffer_size += BIG_BUFFER_SIZE;
986 newbuffer = store_malloc(big_buffer_size);
988 /* This use of strcpy is OK because we know that the string in the old
989 buffer is shorter than the new buffer. */
991 Ustrcpy(newbuffer, big_buffer);
992 store_free(big_buffer);
993 big_buffer = newbuffer;
994 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
996 newlen += Ustrlen(big_buffer + newlen);
999 /* Find the true start of the physical line - leading spaces are always
1002 ss = big_buffer + len;
1003 while (isspace(*ss)) ss++;
1005 /* Process the physical line for macros. If this is the start of the logical
1006 line, skip over initial text at the start of the line if it starts with an
1007 upper case character followed by a sequence of name characters and an equals
1008 sign, because that is the definition of a new macro, and we don't do
1009 replacement therein. */
1012 if (len == 0 && isupper(*s))
1014 while (isalnum(*s) || *s == '_') s++;
1015 while (isspace(*s)) s++;
1016 if (*s != '=') s = ss; /* Not a macro definition */
1019 /* If the builtin macros are not yet defined, and the line contains an
1020 underscrore followed by an one of the three possible chars used by
1021 builtins, create them. */
1023 if (!macros_builtin_created)
1025 const uschar * t, * p;
1027 for (t = s; (p = CUstrchr(t, '_')); t = p+1)
1028 if (c = p[1], c == 'O' || c == 'D' || c == 'H')
1030 /* fprintf(stderr, "%s: builtins create triggered by '%s'\n", __FUNCTION__, s); */
1031 builtin_macros_create_trigger = string_copy(s);
1032 macros_create_builtin();
1037 /* For each defined macro, scan the line (from after XXX= if present),
1038 replacing all occurrences of the macro. */
1040 macro_found = FALSE;
1041 for (m = macros; m; m = m->next)
1046 while ((p = Ustrstr(t, m->name)) != NULL)
1049 int replen = Ustrlen(m->replacement);
1051 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, t) */
1052 /* Expand the buffer if necessary */
1054 while (newlen - m->namelen + replen + 1 > big_buffer_size)
1056 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
1057 uschar *newbuffer = store_malloc(newsize);
1058 memcpy(newbuffer, big_buffer, newlen + 1);
1059 p = newbuffer + (p - big_buffer);
1060 s = newbuffer + (s - big_buffer);
1061 ss = newbuffer + (ss - big_buffer);
1062 t = newbuffer + (t - big_buffer);
1063 big_buffer_size = newsize;
1064 store_free(big_buffer);
1065 big_buffer = newbuffer;
1068 /* Shuffle the remaining characters up or down in the buffer before
1069 copying in the replacement text. Don't rescan the replacement for this
1072 pp = p + m->namelen;
1073 if ((moveby = replen - m->namelen) != 0)
1075 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
1078 Ustrncpy(p, m->replacement, replen);
1084 /* An empty macro replacement at the start of a line could mean that ss no
1085 longer points to the first non-blank character. */
1087 while (isspace(*ss)) ss++;
1089 /* Check for comment lines - these are physical lines. */
1091 if (*ss == '#') continue;
1093 /* Handle conditionals, which are also applied to physical lines. Conditions
1094 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1095 expansion occured on the rest of the line. A preliminary test for the leading
1096 '.' saves effort on most lines. */
1102 /* Search the list of conditional directives */
1104 for (i = 0; i < cond_list_size; i++)
1107 cond_item *c = cond_list+i;
1108 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1110 /* The following character must be white space or end of string */
1112 n = ss[1 + c->namelen];
1113 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1115 /* .ifdef and .ifndef push the current state onto the stack, then set
1116 a new one from the table. Stack overflow is an error */
1120 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1121 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1122 ".%s nested too deeply", c->name);
1123 cstate_stack[++cstate_stack_ptr] = cstate;
1124 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1127 /* For any of the others, stack underflow is an error. The next state
1128 comes either from the stack (.endif) or from the table. */
1132 if (cstate_stack_ptr < 0)
1133 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1134 ".%s without matching .ifdef", c->name);
1135 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1136 next_cstate[cstate][macro_found? c->action1 : c->action2];
1139 /* Having dealt with a directive, break the loop */
1144 /* If we have handled a conditional directive, continue with the next
1145 physical line. Otherwise, fall through. */
1147 if (i < cond_list_size) continue;
1150 /* If the conditional state is not 0 (actively using these lines), ignore
1153 if (cstate != 0) continue; /* Conditional skip */
1155 /* Handle .include lines - these are also physical lines. */
1157 if (Ustrncmp(ss, ".include", 8) == 0 &&
1159 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1162 int include_if_exists = isspace(ss[8])? 0 : 10;
1163 config_file_item *save;
1164 struct stat statbuf;
1166 ss += 9 + include_if_exists;
1167 while (isspace(*ss)) ss++;
1168 t = ss + Ustrlen(ss);
1169 while (t > ss && isspace(t[-1])) t--;
1170 if (*ss == '\"' && t[-1] == '\"')
1177 /* We allow relative file names. For security reasons currently
1178 relative names not allowed with .include_if_exists. For .include_if_exists
1179 we need to check the permissions/ownership of the containing folder */
1181 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1182 "absolute path \"%s\"", ss);
1187 ss = string_append(NULL, &size, &offset, 3, config_directory, "/", ss);
1188 ss[offset] = '\0'; /* string_append() does not zero terminate the string! */
1191 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1194 save_config_position(config_filename, config_lineno);
1195 save = store_get(sizeof(config_file_item));
1196 save->next = config_file_stack;
1197 config_file_stack = save;
1198 save->file = config_file;
1199 save->filename = config_filename;
1200 save->directory = config_directory;
1201 save->lineno = config_lineno;
1203 if (!(config_file = Ufopen(ss, "rb")))
1204 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1205 "configuration file %s", ss);
1207 config_filename = string_copy(ss);
1208 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1213 /* If this is the start of the logical line, remember where the non-blank
1214 data starts. Otherwise shuffle down continuation lines to remove leading
1218 startoffset = ss - big_buffer;
1221 s = big_buffer + len;
1224 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1229 /* Accept the new addition to the line. Remove trailing white space. */
1232 while (len > 0 && isspace(big_buffer[len-1])) len--;
1233 big_buffer[len] = 0;
1235 /* We are done if the line does not end in backslash and contains some data.
1236 Empty logical lines are ignored. For continuations, remove the backslash and
1237 go round the loop to read the continuation line. */
1241 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1242 big_buffer[--len] = 0; /* Remove backslash */
1244 } /* Loop for reading multiple physical lines */
1246 /* We now have a logical line. Test for the end of a configuration section (or,
1247 more accurately, for the start of the next section). Place the name of the next
1248 section in next_section, and return NULL. If the name given is longer than
1249 next_section, truncate it. It will be unrecognized later, because all the known
1250 section names do fit. Leave space for pluralizing. */
1252 s = big_buffer + startoffset; /* First non-space character */
1255 save_config_line(s);
1257 if (strncmpic(s, US"begin ", 6) == 0)
1260 while (isspace(*s)) s++;
1261 if (big_buffer + len - s > sizeof(next_section) - 2)
1262 s[sizeof(next_section) - 2] = 0;
1263 Ustrcpy(next_section, s);
1267 /* Return the first non-blank character. */
1274 /*************************************************
1276 *************************************************/
1278 /* The yield is the pointer to the next uschar. Names longer than the
1279 output space are silently truncated. This function is also used from acl.c when
1283 name where to put the name
1287 Returns: new input pointer
1291 readconf_readname(uschar *name, int len, uschar *s)
1294 while (isspace(*s)) s++;
1297 while (isalnum(*s) || *s == '_')
1299 if (p < len-1) name[p++] = *s;
1304 while (isspace(*s)) s++;
1311 /*************************************************
1312 * Read a time value *
1313 *************************************************/
1315 /* This function is also called from outside, to read argument
1316 time values. The format of a time value is:
1318 [<n>w][<n>d][<n>h][<n>m][<n>s]
1320 as long as at least one is present. If a format error is encountered,
1321 return a negative value. The value must be terminated by the given
1326 terminator required terminating character
1327 return_msec if TRUE, allow fractional seconds and return milliseconds
1329 Returns: the time value, or -1 on syntax error
1330 value is seconds if return_msec is FALSE
1331 value is milliseconds if return_msec is TRUE
1335 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1343 if (!isdigit(*s)) return -1;
1344 (void)sscanf(CCS s, "%d%n", &value, &count);
1349 case 'w': value *= 7;
1350 case 'd': value *= 24;
1351 case 'h': value *= 60;
1352 case 'm': value *= 60;
1357 if (!return_msec) return -1;
1358 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1360 if (*s++ != 's') return -1;
1361 yield += (int)(fraction * 1000.0);
1367 if (return_msec) value *= 1000;
1369 if (*s == terminator) return yield;
1371 /* Control never reaches here. */
1376 /*************************************************
1377 * Read a fixed point value *
1378 *************************************************/
1380 /* The value is returned *1000
1384 terminator required terminator
1386 Returns: the value, or -1 on error
1390 readconf_readfixed(const uschar *s, int terminator)
1394 if (!isdigit(*s)) return -1;
1395 (void)sscanf(CS s, "%d%n", &value, &count);
1397 yield = value * 1000;
1401 while (isdigit((*(++s))))
1403 yield += (*s - '0') * m;
1408 return (*s == terminator)? yield : (-1);
1413 /*************************************************
1414 * Find option in list *
1415 *************************************************/
1417 /* The lists are always in order, so binary chop can be used.
1420 name the option name to search for
1421 ol the first entry in the option list
1422 last one more than the offset of the last entry in the option list
1424 Returns: pointer to an option entry, or NULL if not found
1428 find_option(uschar *name, optionlist *ol, int last)
1431 while (last > first)
1433 int middle = (first + last)/2;
1434 int c = Ustrcmp(name, ol[middle].name);
1436 if (c == 0) return ol + middle;
1437 else if (c > 0) first = middle + 1;
1445 /*************************************************
1446 * Find a set flag in option list *
1447 *************************************************/
1449 /* Because some versions of Unix make no restrictions on the values of uids and
1450 gids (even negative ones), we cannot represent "unset" by a special value.
1451 There is therefore a separate boolean variable for each one indicating whether
1452 a value is set or not. This function returns a pointer to the boolean, given
1453 the original option name. It is a major disaster if the flag cannot be found.
1456 name the name of the uid or gid option
1457 oltop points to the start of the relevant option list
1458 last one more than the offset of the last item in the option list
1459 data_block NULL when reading main options => data values in the option
1460 list are absolute addresses; otherwise they are byte offsets
1461 in data_block (used for driver options)
1463 Returns: a pointer to the boolean flag.
1467 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1471 sprintf(CS name2, "*set_%.50s", name);
1472 ol = find_option(name2, oltop, last);
1473 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1474 "Exim internal error: missing set flag for %s", name);
1475 return (data_block == NULL)? (BOOL *)(ol->value) :
1476 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1482 /*************************************************
1483 * Output extra characters message and die *
1484 *************************************************/
1486 /* Called when an option line has junk on the end. Sometimes this is because
1487 the sysadmin thinks comments are permitted.
1490 s points to the extra characters
1491 t1..t3 strings to insert in the log message
1493 Returns: doesn't return; dies
1497 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1499 uschar *comment = US"";
1500 if (*s == '#') comment = US" (# is comment only at line start)";
1501 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1502 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1507 /*************************************************
1508 * Read rewrite information *
1509 *************************************************/
1511 /* Each line of rewrite information contains:
1513 . A complete address in the form user@domain, possibly with
1514 leading * for each part; or alternatively, a regex.
1516 . A replacement string (which will be expanded).
1518 . An optional sequence of one-letter flags, indicating which
1519 headers etc. to apply this rule to.
1521 All this is decoded and placed into a control block. The OR of the flags is
1522 maintained in a common word.
1525 p points to the string that makes up the rule
1526 existflags points to the overall flag word
1527 isglobal TRUE if reading global rewrite rules
1529 Returns: the control block for the parsed rule.
1532 static rewrite_rule *
1533 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1535 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1538 next->key = string_dequote(&p);
1540 while (isspace(*p)) p++;
1542 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1543 "missing rewrite replacement string");
1546 next->replacement = string_dequote(&p);
1548 while (*p != 0) switch (*p++)
1550 case ' ': case '\t': break;
1552 case 'q': next->flags |= rewrite_quit; break;
1553 case 'w': next->flags |= rewrite_whole; break;
1555 case 'h': next->flags |= rewrite_all_headers; break;
1556 case 's': next->flags |= rewrite_sender; break;
1557 case 'f': next->flags |= rewrite_from; break;
1558 case 't': next->flags |= rewrite_to; break;
1559 case 'c': next->flags |= rewrite_cc; break;
1560 case 'b': next->flags |= rewrite_bcc; break;
1561 case 'r': next->flags |= rewrite_replyto; break;
1563 case 'E': next->flags |= rewrite_all_envelope; break;
1564 case 'F': next->flags |= rewrite_envfrom; break;
1565 case 'T': next->flags |= rewrite_envto; break;
1567 case 'Q': next->flags |= rewrite_qualify; break;
1568 case 'R': next->flags |= rewrite_repeat; break;
1571 next->flags |= rewrite_smtp;
1572 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1573 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1574 "rewrite rule has the S flag but is not a regular expression");
1578 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1579 "unknown rewrite flag character '%c' "
1580 "(could be missing quotes round replacement item)", p[-1]);
1584 /* If no action flags are set, set all the "normal" rewrites. */
1586 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1587 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1589 /* Remember which exist, for optimization, and return the rule */
1591 *existflags |= next->flags;
1598 /*************************************************
1599 * Read global rewrite information *
1600 *************************************************/
1602 /* Each line is a single rewrite rule; it is parsed into a control block
1603 by readconf_one_rewrite(), and its flags are ORed into the global flag
1604 word rewrite_existflags. */
1607 readconf_rewrites(void)
1609 rewrite_rule **chain = &global_rewrite_rules;
1612 while ((p = get_config_line()) != NULL)
1614 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1616 chain = &(next->next);
1622 /*************************************************
1624 *************************************************/
1626 /* Strings are read into the normal store pool. As long we aren't too
1627 near the end of the current block, the string will just use what is necessary
1628 on the top of the stacking pool, because string_cat() uses the extension
1632 s the rest of the input line
1633 name the option name (for errors)
1635 Returns: pointer to the string
1639 read_string(const uschar *s, const uschar *name)
1644 if (*s != '\"') return string_copy(s);
1647 yield = string_dequote(&s);
1649 if (s == ss+1 || s[-1] != '\"')
1650 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1651 "missing quote at end of string value for %s", name);
1653 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1659 /*************************************************
1660 * Custom-handler options *
1661 *************************************************/
1663 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1666 smtp_receive_timeout_s = string_copy(str);
1669 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1670 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1671 if (smtp_receive_timeout < 0)
1672 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1677 /*************************************************
1678 * Handle option line *
1679 *************************************************/
1681 /* This function is called from several places to process a line containing the
1682 setting of an option. The first argument is the line to be decoded; it has been
1683 checked not to be empty and not to start with '#'. Trailing newlines and white
1684 space have been removed. The second argument is a pointer to the list of
1685 variable names that are to be recognized, together with their types and
1686 locations, and the third argument gives the number of entries in the list.
1688 The fourth argument is a pointer to a data block. If it is NULL, then the data
1689 values in the options list are absolute addresses. Otherwise, they are byte
1690 offsets in the data block.
1692 String option data may continue onto several lines; this function reads further
1693 data from config_file if necessary.
1695 The yield of this function is normally zero. If a string continues onto
1696 multiple lines, then the data value is permitted to be followed by a comma
1697 or a semicolon (for use in drivers) and the yield is that character.
1700 buffer contains the configuration line to be handled
1701 oltop points to the start of the relevant option list
1702 last one more than the offset of the last item in the option list
1703 data_block NULL when reading main options => data values in the option
1704 list are absolute addresses; otherwise they are byte offsets
1705 in data_block when they have opt_public set; otherwise
1706 they are byte offsets in data_block->options_block.
1707 unknown_txt format string to use in panic message for unknown option;
1708 must contain %s for option name
1709 if given as NULL, don't panic on unknown option
1711 Returns: TRUE if an option was read successfully,
1712 FALSE false for an unknown option if unknown_txt == NULL,
1713 otherwise panic and die on an unknown option
1717 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1718 void *data_block, uschar *unknown_txt)
1722 int n, count, type, value;
1726 BOOL boolvalue = TRUE;
1727 BOOL freesptr = TRUE;
1728 optionlist *ol, *ol2;
1732 uschar *inttype = US"";
1735 uschar **str_target;
1739 /* There may be leading spaces; thereafter, we expect an option name starting
1742 while (isspace(*s)) s++;
1744 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1746 /* Read the name of the option, and skip any subsequent white space. If
1747 it turns out that what we read was "hide", set the flag indicating that
1748 this is a secure option, and loop to read the next word. */
1750 for (n = 0; n < 2; n++)
1752 while (isalnum(*s) || *s == '_')
1754 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1758 while (isspace(*s)) s++;
1759 if (Ustrcmp(name, "hide") != 0) break;
1760 issecure = opt_secure;
1764 /* Deal with "no_" or "not_" here for booleans */
1766 if (Ustrncmp(name, "no_", 3) == 0)
1772 if (Ustrncmp(name, "not_", 4) == 0)
1778 /* Search the list for the given name. A non-existent name, or an option that
1779 is set twice, is a disaster. */
1781 if (!(ol = find_option(name + offset, oltop, last)))
1783 if (unknown_txt == NULL) return FALSE;
1784 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1787 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1788 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1789 "\"%s\" option set for the second time", name);
1791 ol->type |= opt_set | issecure;
1792 type = ol->type & opt_mask;
1794 /* Types with data values must be followed by '='; the "no[t]_" prefix
1795 applies only to boolean values. */
1797 if (type < opt_bool || type > opt_bool_last)
1800 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1801 "negation prefix applied to a non-boolean option");
1803 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1804 "unexpected end of line (data missing) after %s", name);
1806 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1809 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1810 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1811 ultimately expands to one of those values. */
1813 else if (*s != 0 && (offset != 0 || *s != '='))
1814 extra_chars_error(s, US"boolean option ", name, US"");
1816 /* Skip white space after = */
1818 if (*s == '=') while (isspace((*(++s))));
1820 /* If there is a data block and the opt_public flag is not set, change
1821 the data block pointer to the private options block. */
1823 if (data_block != NULL && (ol->type & opt_public) == 0)
1824 data_block = (void *)(((driver_instance *)data_block)->options_block);
1826 /* Now get the data according to the type. */
1830 /* If a string value is not enclosed in quotes, it consists of
1831 the rest of the current line, verbatim. Otherwise, string escapes
1834 A transport is specified as a string, which is then looked up in the
1835 list of transports. A search type is specified as one of a number of
1838 A set or rewrite rules for a driver is specified as a string, which is
1839 then parsed into a suitable chain of control blocks.
1841 Uids and gids are specified as strings which are then looked up in the
1842 passwd file. Lists of uids and gids are similarly specified as colon-
1843 separated strings. */
1848 case opt_expand_uid:
1849 case opt_expand_gid:
1854 reset_point = sptr = read_string(s, name);
1856 /* Having read a string, we now have several different ways of using it,
1857 depending on the data type, so do another switch. If keeping the actual
1858 string is not required (because it is interpreted), freesptr is set TRUE,
1859 and at the end we reset the pool. */
1863 /* If this was a string, set the variable to point to the new string,
1864 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1865 rules, we still keep the string (for printing), and parse the rules into a
1866 control block and flags word. */
1869 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1871 if (ol->type & opt_rep_con)
1873 uschar * saved_condition;
1874 /* We already have a condition, we're conducting a crude hack to let
1875 multiple condition rules be chained together, despite storing them in
1877 *str_target = string_copy_malloc( (saved_condition = *str_target)
1878 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1879 saved_condition, sptr)
1881 /* TODO(pdp): there is a memory leak here and just below
1882 when we set 3 or more conditions; I still don't
1883 understand the store mechanism enough to know
1884 what's the safe way to free content from an earlier store.
1885 AFAICT, stores stack, so freeing an early stored item also stores
1886 all data alloc'd after it. If we knew conditions were adjacent,
1887 we could survive that, but we don't. So I *think* we need to take
1888 another bit from opt_type to indicate "malloced"; this seems like
1889 quite a hack, especially for this one case. It also means that
1890 we can't ever reclaim the store from the *first* condition.
1892 Because we only do this once, near process start-up, I'm prepared to
1893 let this slide for the time being, even though it rankles. */
1895 else if (ol->type & opt_rep_str)
1897 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1898 int sep_i = -(int)sep_o;
1899 const uschar * list = sptr;
1901 uschar * list_o = *str_target;
1903 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1904 list_o = string_append_listele(list_o, sep_o, s);
1906 *str_target = string_copy_malloc(list_o);
1917 *USS (US data_block + (long int)(ol->value)) = sptr;
1919 *USS (ol->value) = sptr;
1921 if (type == opt_rewrite)
1926 rewrite_rule **chain;
1929 sprintf(CS name2, "*%.50s_rules", name);
1930 ol2 = find_option(name2, oltop, last);
1931 sprintf(CS name2, "*%.50s_flags", name);
1932 ol3 = find_option(name2, oltop, last);
1934 if (ol2 == NULL || ol3 == NULL)
1935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1936 "rewrite rules not available for driver");
1938 if (data_block == NULL)
1940 chain = (rewrite_rule **)(ol2->value);
1941 flagptr = (int *)(ol3->value);
1945 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1946 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1949 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1951 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1953 chain = &(next->next);
1956 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1957 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1958 "non-header rewrite - not allowed at transport time -");
1962 /* If it was an expanded uid, see if there is any expansion to be
1963 done by checking for the presence of a $ character. If there is, save it
1964 in the corresponding *expand_user option field. Otherwise, fall through
1965 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1968 case opt_expand_uid:
1969 sprintf(CS name2, "*expand_%.50s", name);
1970 ol2 = find_option(name2, oltop, last);
1973 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1975 if (data_block == NULL)
1976 *((uschar **)(ol2->value)) = ss;
1978 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1982 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1988 /* Look up a fixed uid, and also make use of the corresponding gid
1989 if a passwd entry is returned and the gid has not been set. */
1992 if (!route_finduser(sptr, &pw, &uid))
1993 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1994 if (data_block == NULL)
1995 *((uid_t *)(ol->value)) = uid;
1997 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1999 /* Set the flag indicating a fixed value is set */
2001 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2003 /* Handle matching gid if we have a passwd entry: done by finding the
2004 same name with terminating "user" changed to "group"; if not found,
2005 ignore. Also ignore if the value is already set. */
2007 if (pw == NULL) break;
2008 Ustrcpy(name+Ustrlen(name)-4, "group");
2009 ol2 = find_option(name, oltop, last);
2010 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
2011 (ol2->type & opt_mask) == opt_expand_gid))
2013 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
2016 if (data_block == NULL)
2017 *((gid_t *)(ol2->value)) = pw->pw_gid;
2019 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
2025 /* If it was an expanded gid, see if there is any expansion to be
2026 done by checking for the presence of a $ character. If there is, save it
2027 in the corresponding *expand_user option field. Otherwise, fall through
2028 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
2031 case opt_expand_gid:
2032 sprintf(CS name2, "*expand_%.50s", name);
2033 ol2 = find_option(name2, oltop, last);
2036 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
2038 if (data_block == NULL)
2039 *((uschar **)(ol2->value)) = ss;
2041 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
2045 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2051 /* Handle freestanding gid */
2054 if (!route_findgroup(sptr, &gid))
2055 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2056 if (data_block == NULL)
2057 *((gid_t *)(ol->value)) = gid;
2059 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
2060 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2063 /* If it was a uid list, look up each individual entry, and build
2064 a vector of uids, with a count in the first element. Put the vector
2065 in malloc store so we can free the string. (We are reading into
2066 permanent store already.) */
2074 const uschar *op = expand_string (sptr);
2077 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2078 name, expand_string_message);
2081 if (*p != 0) count++;
2082 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2083 list = store_malloc(count*sizeof(uid_t));
2084 list[ptr++] = (uid_t)(count - 1);
2086 if (data_block == NULL)
2087 *((uid_t **)(ol->value)) = list;
2089 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2095 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2096 if (!route_finduser(big_buffer, NULL, &uid))
2097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2104 /* If it was a gid list, look up each individual entry, and build
2105 a vector of gids, with a count in the first element. Put the vector
2106 in malloc store so we can free the string. (We are reading into permanent
2115 const uschar *op = expand_string (sptr);
2118 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2119 name, expand_string_message);
2122 if (*p != 0) count++;
2123 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2124 list = store_malloc(count*sizeof(gid_t));
2125 list[ptr++] = (gid_t)(count - 1);
2127 if (data_block == NULL)
2128 *((gid_t **)(ol->value)) = list;
2130 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2136 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2137 if (!route_findgroup(big_buffer, &gid))
2138 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2146 /* Release store if the value of the string doesn't need to be kept. */
2148 if (freesptr) store_reset(reset_point);
2151 /* Expanded boolean: if no characters follow, or if there are no dollar
2152 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2153 save the string for later expansion in the alternate place. */
2155 case opt_expand_bool:
2156 if (*s != 0 && Ustrchr(s, '$') != 0)
2158 sprintf(CS name2, "*expand_%.50s", name);
2159 ol2 = find_option(name2, oltop, last);
2162 reset_point = sptr = read_string(s, name);
2163 if (data_block == NULL)
2164 *((uschar **)(ol2->value)) = sptr;
2166 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
2173 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2174 look for yes/not/true/false. Some booleans are stored in a single bit in
2175 a single int. There's a special fudge for verify settings; without a suffix
2176 they set both xx_sender and xx_recipient. The table points to the sender
2177 value; search subsequently for the recipient. There's another special case:
2178 opt_bool_set also notes when a boolean has been set. */
2182 case opt_bool_verify:
2186 s = readconf_readname(name2, 64, s);
2187 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2189 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2191 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2192 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2193 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2194 US"for boolean option ", name);
2197 /* Handle single-bit type. */
2199 if (type == opt_bit)
2201 int bit = 1 << ((ol->type >> 16) & 31);
2202 int *ptr = (data_block == NULL)?
2203 (int *)(ol->value) :
2204 (int *)((uschar *)data_block + (long int)ol->value);
2205 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2209 /* Handle full BOOL types */
2211 if (data_block == NULL)
2212 *((BOOL *)(ol->value)) = boolvalue;
2214 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
2218 if (type == opt_bool_verify)
2220 sprintf(CS name2, "%.50s_recipient", name + offset);
2221 ol2 = find_option(name2, oltop, last);
2224 if (data_block == NULL)
2225 *((BOOL *)(ol2->value)) = boolvalue;
2227 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
2231 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2233 else if (type == opt_bool_set)
2235 sprintf(CS name2, "*set_%.50s", name + offset);
2236 ol2 = find_option(name2, oltop, last);
2239 if (data_block == NULL)
2240 *((BOOL *)(ol2->value)) = TRUE;
2242 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
2251 inttype = US"octal ";
2253 /* Integer: a simple(ish) case; allow octal and hex formats, and
2254 suffixes K, M and G. The different types affect output, not input. */
2263 lvalue = strtol(CS s, CSS &endptr, intbase);
2266 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2269 if (errno != ERANGE)
2270 if (tolower(*endptr) == 'k')
2272 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2273 else lvalue *= 1024;
2276 else if (tolower(*endptr) == 'm')
2278 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2280 else lvalue *= 1024*1024;
2283 else if (tolower(*endptr) == 'g')
2285 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2287 else lvalue *= 1024*1024*1024;
2291 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2292 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2293 "absolute value of integer \"%s\" is too large (overflow)", s);
2295 while (isspace(*endptr)) endptr++;
2297 extra_chars_error(endptr, inttype, US"integer value for ", name);
2299 value = (int)lvalue;
2302 if (data_block == NULL)
2303 *((int *)(ol->value)) = value;
2305 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2308 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2310 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2316 value = strtol(CS s, CSS &endptr, intbase);
2319 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2322 if (errno != ERANGE)
2323 if (tolower(*endptr) == 'g')
2325 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2331 else if (tolower(*endptr) == 'm')
2333 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2339 else if (tolower(*endptr) == 'k')
2342 value = (value + 512)/1024;
2344 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2345 "absolute value of integer \"%s\" is too large (overflow)", s);
2347 while (isspace(*endptr)) endptr++;
2349 extra_chars_error(endptr, inttype, US"integer value for ", name);
2352 if (data_block == NULL)
2353 *((int *)(ol->value)) = value;
2355 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2358 /* Fixed-point number: held to 3 decimal places. */
2361 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2362 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2363 "fixed-point number expected for %s", name);
2365 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2366 "integer \"%s\" is too large (overflow)", s);
2370 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2371 "integer \"%s\" is too large (overflow)", s);
2373 /* We get a coverity error here for using count, as it derived
2374 from the tainted buffer pointed to by s, as parsed by sscanf().
2375 By the definition of sscanf we must be accessing between start
2376 and end of s (assuming it is nul-terminated...) so ignore the error. */
2377 /* coverity[tainted_data] */
2378 if (s[count] == '.')
2381 while (isdigit(s[++count]))
2383 value += (s[count] - '0') * d;
2388 while (isspace(s[count])) count++;
2391 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2393 if (data_block == NULL)
2394 *((int *)(ol->value)) = value;
2396 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2399 /* There's a special routine to read time values. */
2402 value = readconf_readtime(s, 0, FALSE);
2404 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2406 if (data_block == NULL)
2407 *((int *)(ol->value)) = value;
2409 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2412 /* A time list is a list of colon-separated times, with the first
2413 element holding the size of the list and the second the number of
2419 int *list = (data_block == NULL)?
2420 (int *)(ol->value) :
2421 (int *)((uschar *)data_block + (long int)(ol->value));
2423 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2426 uschar *snext = Ustrchr(s, ':');
2430 while (ss > s && isspace(ss[-1])) ss--;
2433 value = readconf_readtime(s, terminator, FALSE);
2435 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2437 if (count > 1 && value <= list[count])
2438 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2439 "time value out of order for %s", name);
2440 list[count+1] = value;
2441 if (snext == NULL) break;
2443 while (isspace(*s)) s++;
2446 if (count > list[0] - 2)
2447 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2449 if (count > 0 && list[2] == 0) count = 0;
2456 void (*fn)() = ol->value;
2467 /*************************************************
2468 * Print a time value *
2469 *************************************************/
2472 Argument: a time value in seconds
2473 Returns: pointer to a fixed buffer containing the time as a string,
2474 in readconf_readtime() format
2478 readconf_printtime(int t)
2481 uschar *p = time_buffer;
2498 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2499 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2500 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2501 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2502 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2509 /*************************************************
2510 * Print an individual option value *
2511 *************************************************/
2513 /* This is used by the -bP option, so prints to the standard output.
2514 The entire options list is passed in as an argument, because some options come
2515 in pairs - typically uid/gid settings, which can either be explicit numerical
2516 values, or strings to be expanded later. If the numerical value is unset,
2517 search for "*expand_<name>" to see if there is a string equivalent.
2520 ol option entry, or NULL for an unknown option
2522 options_block NULL for main configuration options; otherwise points to
2523 a driver block; if the option doesn't have opt_public
2524 set, then options_block->options_block is where the item
2526 oltop points to the option list in which ol exists
2527 last one more than the offset of the last entry in optop
2528 no_labels do not show "foo = " at the start.
2534 print_ol(optionlist *ol, uschar *name, void *options_block,
2535 optionlist *oltop, int last, BOOL no_labels)
2548 printf("%s is not a known option\n", name);
2552 /* Non-admin callers cannot see options that have been flagged secure by the
2555 if (!admin_user && (ol->type & opt_secure) != 0)
2558 printf("%s\n", hidden);
2560 printf("%s = %s\n", name, hidden);
2564 /* Else show the value of the option */
2567 if (options_block != NULL)
2569 if ((ol->type & opt_public) == 0)
2570 options_block = (void *)(((driver_instance *)options_block)->options_block);
2571 value = (void *)((uschar *)options_block + (long int)value);
2574 switch(ol->type & opt_mask)
2577 case opt_rewrite: /* Show the text value */
2578 s = *((uschar **)value);
2579 if (!no_labels) printf("%s = ", name);
2580 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2584 if (!no_labels) printf("%s = ", name);
2585 printf("%d\n", *((int *)value));
2590 int x = *((int *)value);
2591 if (x != 0 && (x & 1023) == 0)
2595 if ((x & 1023) == 0)
2600 if (!no_labels) printf("%s = ", name);
2601 printf("%d%c\n", x, c);
2605 if (!no_labels) printf("%s = ", name);
2613 int x = *((int *)value);
2614 if (!no_labels) printf("%s = ", name);
2615 if (x == 0) printf("0\n");
2616 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2617 else printf("%dK\n", x);
2622 if (!no_labels) printf("%s = ", name);
2623 printf("%#o\n", *((int *)value));
2626 /* Can be negative only when "unset", in which case integer */
2630 int x = *((int *)value);
2633 if (x < 0) printf("%s =\n", name); else
2635 if (!no_labels) printf("%s = ", name);
2636 printf("%d.", x/1000);
2649 /* If the numerical value is unset, try for the string value */
2651 case opt_expand_uid:
2652 if (! *get_set_flag(name, oltop, last, options_block))
2654 sprintf(CS name2, "*expand_%.50s", name);
2655 ol2 = find_option(name2, oltop, last);
2658 void *value2 = ol2->value;
2659 if (options_block != NULL)
2660 value2 = (void *)((uschar *)options_block + (long int)value2);
2661 s = *((uschar **)value2);
2662 if (!no_labels) printf("%s = ", name);
2663 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2668 /* Else fall through */
2671 if (!no_labels) printf("%s = ", name);
2672 if (! *get_set_flag(name, oltop, last, options_block))
2676 pw = getpwuid(*((uid_t *)value));
2678 printf("%ld\n", (long int)(*((uid_t *)value)));
2679 else printf("%s\n", pw->pw_name);
2683 /* If the numerical value is unset, try for the string value */
2685 case opt_expand_gid:
2686 if (! *get_set_flag(name, oltop, last, options_block))
2688 sprintf(CS name2, "*expand_%.50s", name);
2689 ol2 = find_option(name2, oltop, last);
2690 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2692 void *value2 = ol2->value;
2693 if (options_block != NULL)
2694 value2 = (void *)((uschar *)options_block + (long int)value2);
2695 s = *((uschar **)value2);
2696 if (!no_labels) printf("%s = ", name);
2697 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2702 /* Else fall through */
2705 if (!no_labels) printf("%s = ", name);
2706 if (! *get_set_flag(name, oltop, last, options_block))
2710 gr = getgrgid(*((int *)value));
2712 printf("%ld\n", (long int)(*((int *)value)));
2713 else printf("%s\n", gr->gr_name);
2718 uidlist = *((uid_t **)value);
2719 if (!no_labels) printf("%s =", name);
2720 if (uidlist != NULL)
2724 if (no_labels) sep = '\0';
2725 for (i = 1; i <= (int)(uidlist[0]); i++)
2727 uschar *name = NULL;
2728 pw = getpwuid(uidlist[i]);
2729 if (pw != NULL) name = US pw->pw_name;
2730 if (sep != '\0') printf("%c", sep);
2731 if (name != NULL) printf("%s", name);
2732 else printf("%ld", (long int)(uidlist[i]));
2740 gidlist = *((gid_t **)value);
2741 if (!no_labels) printf("%s =", name);
2742 if (gidlist != NULL)
2746 if (no_labels) sep = '\0';
2747 for (i = 1; i <= (int)(gidlist[0]); i++)
2749 uschar *name = NULL;
2750 gr = getgrgid(gidlist[i]);
2751 if (gr != NULL) name = US gr->gr_name;
2752 if (sep != '\0') printf("%c", sep);
2753 if (name != NULL) printf("%s", name);
2754 else printf("%ld", (long int)(gidlist[i]));
2762 if (!no_labels) printf("%s = ", name);
2763 printf("%s\n", readconf_printtime(*((int *)value)));
2769 int *list = (int *)value;
2770 if (!no_labels) printf("%s = ", name);
2771 for (i = 0; i < list[1]; i++)
2772 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2778 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2782 case opt_expand_bool:
2783 sprintf(CS name2, "*expand_%.50s", name);
2784 ol2 = find_option(name2, oltop, last);
2785 if (ol2 != NULL && ol2->value != NULL)
2787 void *value2 = ol2->value;
2788 if (options_block != NULL)
2789 value2 = (void *)((uschar *)options_block + (long int)value2);
2790 s = *((uschar **)value2);
2793 if (!no_labels) printf("%s = ", name);
2794 printf("%s\n", string_printing(s));
2797 /* s == NULL => string not set; fall through */
2803 case opt_bool_verify:
2805 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2812 /*************************************************
2813 * Print value from main configuration *
2814 *************************************************/
2816 /* This function, called as a result of encountering the -bP option,
2817 causes the value of any main configuration variable to be output if the
2818 second argument is NULL. There are some special values:
2820 all print all main configuration options
2821 config_file print the name of the configuration file
2822 (configure_file will still work, for backward
2824 routers print the routers' configurations
2825 transports print the transports' configuration
2826 authenticators print the authenticators' configuration
2827 macros print the macros' configuration
2828 router_list print a list of router names
2829 transport_list print a list of transport names
2830 authenticator_list print a list of authentication mechanism names
2831 macro_list print a list of macro names
2832 +name print a named list item
2833 local_scan print the local_scan options
2834 config print the configuration as it is parsed
2835 environment print the used execution environment
2837 If the second argument is not NULL, it must be one of "router", "transport",
2838 "authenticator" or "macro" in which case the first argument identifies the
2839 driver whose options are to be printed.
2842 name option name if type == NULL; else driver name
2843 type NULL or driver type name, as described above
2844 no_labels avoid the "foo = " at the start of an item
2850 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2852 BOOL names_only = FALSE;
2854 optionlist *ol2 = NULL;
2855 driver_instance *d = NULL;
2866 static uschar *types[] = { US"address", US"domain", US"host",
2868 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2869 &hostlist_anchor, &localpartlist_anchor };
2871 for (i = 0; i < 4; i++)
2873 t = tree_search(*(anchors[i]), name+1);
2878 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2880 printf("%slist %s = %s\n", types[i], name+1,
2881 ((namedlist_block *)(t->data.ptr))->string);
2886 printf("no address, domain, host, or local part list called \"%s\" "
2887 "exists\n", name+1);
2892 if ( Ustrcmp(name, "configure_file") == 0
2893 || Ustrcmp(name, "config_file") == 0)
2895 printf("%s\n", CS config_main_filename);
2899 if (Ustrcmp(name, "all") == 0)
2901 for (ol = optionlist_config;
2902 ol < optionlist_config + nelem(optionlist_config); ol++)
2904 if ((ol->type & opt_hidden) == 0)
2905 print_ol(ol, US ol->name, NULL,
2906 optionlist_config, nelem(optionlist_config),
2912 if (Ustrcmp(name, "local_scan") == 0)
2914 #ifndef LOCAL_SCAN_HAS_OPTIONS
2915 printf("local_scan() options are not supported\n");
2917 for (ol = local_scan_options;
2918 ol < local_scan_options + local_scan_options_count; ol++)
2920 print_ol(ol, US ol->name, NULL, local_scan_options,
2921 local_scan_options_count, no_labels);
2927 if (Ustrcmp(name, "config") == 0)
2929 print_config(admin_user, no_labels);
2933 if (Ustrcmp(name, "routers") == 0)
2938 else if (Ustrcmp(name, "transports") == 0)
2940 type = US"transport";
2944 else if (Ustrcmp(name, "authenticators") == 0)
2946 type = US"authenticator";
2950 else if (Ustrcmp(name, "macros") == 0)
2956 else if (Ustrcmp(name, "router_list") == 0)
2963 else if (Ustrcmp(name, "transport_list") == 0)
2965 type = US"transport";
2970 else if (Ustrcmp(name, "authenticator_list") == 0)
2972 type = US"authenticator";
2977 else if (Ustrcmp(name, "macro_list") == 0)
2984 else if (Ustrcmp(name, "environment") == 0)
2989 for (p = USS environ; *p; p++) ;
2990 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2992 for (p = USS environ; *p; p++)
2995 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
3004 print_ol(find_option(name, optionlist_config, nelem(optionlist_config)),
3005 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
3010 /* Handle the options for a router or transport. Skip options that are flagged
3011 as hidden. Some of these are options with names starting with '*', used for
3012 internal alternative representations of other options (which the printing
3013 function will sort out). Others are synonyms kept for backward compatibility.
3016 if (Ustrcmp(type, "router") == 0)
3018 d = (driver_instance *)routers;
3019 ol2 = optionlist_routers;
3020 size = optionlist_routers_size;
3022 else if (Ustrcmp(type, "transport") == 0)
3024 d = (driver_instance *)transports;
3025 ol2 = optionlist_transports;
3026 size = optionlist_transports_size;
3028 else if (Ustrcmp(type, "authenticator") == 0)
3030 d = (driver_instance *)auths;
3031 ol2 = optionlist_auths;
3032 size = optionlist_auths_size;
3035 else if (Ustrcmp(type, "macro") == 0)
3037 /* People store passwords in macros and they were previously not available
3038 for printing. So we have an admin_users restriction. */
3041 fprintf(stderr, "exim: permission denied\n");
3044 if (!macros_builtin_created) macros_create_builtin();
3045 for (m = macros; m; m = m->next)
3046 if (!name || Ustrcmp(name, m->name) == 0)
3049 printf("%s\n", CS m->name);
3051 printf("%s=%s\n", CS m->name, CS m->replacement);
3056 printf("%s %s not found\n", type, name);
3062 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
3066 /* Either search for a given driver, or print all of them */
3068 for (; d != NULL; d = d->next)
3071 printf("\n%s %s:\n", d->name, type);
3072 else if (Ustrcmp(d->name, name) != 0) continue;
3074 for (ol = ol2; ol < ol2 + size; ol++)
3076 if ((ol->type & opt_hidden) == 0)
3077 print_ol(ol, US ol->name, d, ol2, size, no_labels);
3080 for (ol = d->info->options;
3081 ol < d->info->options + *(d->info->options_count); ol++)
3083 if ((ol->type & opt_hidden) == 0)
3084 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
3086 if (name != NULL) return;
3088 if (name != NULL) printf("%s %s not found\n", type, name);
3093 /*************************************************
3094 * Read a named list item *
3095 *************************************************/
3097 /* This function reads a name and a list (i.e. string). The name is used to
3098 save the list in a tree, sorted by its name. Each entry also has a number,
3099 which can be used for caching tests, but if the string contains any expansion
3100 items other than $key, the number is set negative to inhibit caching. This
3101 mechanism is used for domain, host, and address lists that are referenced by
3105 anchorp points to the tree anchor
3106 numberp points to the current number for this tree
3107 max the maximum number permitted
3108 s the text of the option line, starting immediately after the name
3110 tname the name of the list type, for messages
3116 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3119 BOOL forcecache = FALSE;
3122 namedlist_block *nb = store_get(sizeof(namedlist_block));
3124 if (Ustrncmp(s, "_cache", 6) == 0)
3131 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3133 if (*numberp >= max)
3134 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3137 while (isspace(*s)) s++;
3139 while (isalnum(*s) || *s == '_') s++;
3140 t = store_get(sizeof(tree_node) + s-ss);
3141 Ustrncpy(t->name, ss, s-ss);
3143 while (isspace(*s)) s++;
3145 if (!tree_insertnode(anchorp, t))
3146 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3147 "duplicate name \"%s\" for a named %s", t->name, tname);
3150 nb->number = *numberp;
3153 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3154 "missing '=' after \"%s\"", t->name);
3155 while (isspace(*s)) s++;
3156 nb->string = read_string(s, t->name);
3157 nb->cache_data = NULL;
3159 /* Check the string for any expansions; if any are found, mark this list
3160 uncacheable unless the user has explicited forced caching. */
3162 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3168 /*************************************************
3169 * Unpick data for a rate limit *
3170 *************************************************/
3172 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3176 s string, in the form t,b,f,l
3177 where t is the threshold (integer)
3178 b is the initial delay (time)
3179 f is the multiplicative factor (fixed point)
3180 k is the maximum time (time)
3181 threshold where to store threshold
3182 base where to store base in milliseconds
3183 factor where to store factor in milliseconds
3184 limit where to store limit
3186 Returns: nothing (panics on error)
3190 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3193 uschar bstring[16], lstring[16];
3195 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3196 factor, lstring) == 4)
3198 *base = readconf_readtime(bstring, 0, TRUE);
3199 *limit = readconf_readtime(lstring, 0, TRUE);
3200 if (*base >= 0 && *limit >= 0) return;
3202 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3208 /*************************************************
3209 * Drop privs for checking TLS config *
3210 *************************************************/
3212 /* We want to validate TLS options during readconf, but do not want to be
3213 root when we call into the TLS library, in case of library linkage errors
3214 which cause segfaults; before this check, those were always done as the Exim
3215 runtime user and it makes sense to continue with that.
3217 Assumes: tls_require_ciphers has been set, if it will be
3218 exim_user has been set, if it will be
3219 exim_group has been set, if it will be
3221 Returns: bool for "okay"; false will cause caller to immediately exit.
3226 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3228 const uschar *errmsg;
3231 void (*oldsignal)(int);
3233 /* If TLS will never be used, no point checking ciphers */
3235 if ( !tls_advertise_hosts
3236 || !*tls_advertise_hosts
3237 || Ustrcmp(tls_advertise_hosts, ":") == 0
3240 else if (!nowarn && !tls_certificate)
3241 log_write(0, LOG_MAIN,
3242 "Warning: No server certificate defined; will use a selfsigned one.\n"
3243 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3245 oldsignal = signal(SIGCHLD, SIG_DFL);
3248 if ((pid = fork()) < 0)
3249 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3253 /* in some modes, will have dropped privilege already */
3255 exim_setugid(exim_uid, exim_gid, FALSE,
3256 US"calling tls_validate_require_cipher");
3258 if ((errmsg = tls_validate_require_cipher()))
3259 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3260 "tls_require_ciphers invalid: %s", errmsg);
3266 rc = waitpid(pid, &status, 0);
3267 } while (rc < 0 && errno == EINTR);
3270 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3273 signal(SIGCHLD, oldsignal);
3277 #endif /* SUPPORT_TLS */
3282 /*************************************************
3283 * Read main configuration options *
3284 *************************************************/
3286 /* This function is the first to be called for configuration reading. It
3287 opens the configuration file and reads general configuration settings until
3288 it reaches the end of the configuration section. The file is then left open so
3289 that the remaining configuration data can subsequently be read if needed for
3292 The configuration file must be owned either by root or exim, and be writeable
3293 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3294 in the config file, so the test is done on the compiled in values. A slight
3295 anomaly, to be carefully documented.
3297 The name of the configuration file is taken from a list that is included in the
3298 binary of Exim. It can be altered from the command line, but if that is done,
3299 root privilege is immediately withdrawn unless the caller is root or exim.
3300 The first file on the list that exists is used.
3302 For use on multiple systems that share file systems, first look for a
3303 configuration file whose name has the current node name on the end. If that is
3304 not found, try the generic name. For really contorted configurations, that run
3305 multiple Exims with different uid settings, first try adding the effective uid
3306 before the node name. These complications are going to waste resources on most
3307 systems. Therefore they are available only when requested by compile-time
3311 readconf_main(BOOL nowarn)
3314 struct stat statbuf;
3315 uschar *s, *filename;
3316 const uschar *list = config_main_filelist;
3318 /* Loop through the possible file names */
3320 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3323 /* Cut out all the fancy processing unless specifically wanted */
3325 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3326 uschar *suffix = filename + Ustrlen(filename);
3328 /* Try for the node-specific file if a node name exists */
3330 #ifdef CONFIGURE_FILE_USE_NODE
3332 if (uname(&uts) >= 0)
3334 #ifdef CONFIGURE_FILE_USE_EUID
3335 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3336 config_file = Ufopen(filename, "rb");
3337 if (config_file == NULL)
3338 #endif /* CONFIGURE_FILE_USE_EUID */
3340 sprintf(CS suffix, ".%.256s", uts.nodename);
3341 config_file = Ufopen(filename, "rb");
3344 #endif /* CONFIGURE_FILE_USE_NODE */
3346 /* Otherwise, try the generic name, possibly with the euid added */
3348 #ifdef CONFIGURE_FILE_USE_EUID
3349 if (config_file == NULL)
3351 sprintf(CS suffix, ".%ld", (long int)original_euid);
3352 config_file = Ufopen(filename, "rb");
3354 #endif /* CONFIGURE_FILE_USE_EUID */
3356 /* Finally, try the unadorned name */
3358 if (config_file == NULL)
3361 config_file = Ufopen(filename, "rb");
3363 #else /* if neither defined */
3365 /* This is the common case when the fancy processing is not included. */
3367 config_file = Ufopen(filename, "rb");
3370 /* If the file does not exist, continue to try any others. For any other
3371 error, break out (and die). */
3373 if (config_file != NULL || errno != ENOENT) break;
3376 /* On success, save the name for verification; config_filename is used when
3377 logging configuration errors (it changes for .included files) whereas
3378 config_main_filename is the name shown by -bP. Failure to open a configuration
3379 file is a serious disaster. */
3383 uschar *last_slash = Ustrrchr(filename, '/');
3384 config_filename = config_main_filename = string_copy(filename);
3386 /* The config_main_directory we need for the $config_dir expansion.
3387 config_main_filename we need for $config_file expansion.
3388 And config_dir is the directory of the current configuration, used for
3389 relative .includes. We do need to know it's name, as we change our working
3392 if (filename[0] == '/')
3393 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3396 /* relative configuration file name: working dir + / + basename(filename) */
3398 uschar buf[PATH_MAX];
3402 if (os_getcwd(buf, PATH_MAX) == NULL)
3404 perror("exim: getcwd");
3407 config_main_directory = string_cat(NULL, &size, &offset, buf);
3409 /* If the dir does not end with a "/", append one */
3410 if (config_main_directory[offset-1] != '/')
3411 config_main_directory = string_catn(config_main_directory, &size, &offset, US"/", 1);
3413 /* If the config file contains a "/", extract the directory part */
3415 config_main_directory = string_catn(config_main_directory, &size, &offset, filename, last_slash - filename);
3417 config_main_directory[offset] = '\0';
3419 config_directory = config_main_directory;
3423 if (filename == NULL)
3424 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3425 "%s", config_main_filelist);
3427 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3428 "configuration file %s", filename));
3431 /* Now, once we found and opened our configuration file, we change the directory
3432 to a safe place. Later we change to $spool_directory. */
3434 if (Uchdir("/") < 0)
3436 perror("exim: chdir `/': ");
3440 /* Check the status of the file we have opened, if we have retained root
3441 privileges and the file isn't /dev/null (which *should* be 0666). */
3443 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3445 if (fstat(fileno(config_file), &statbuf) != 0)
3446 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3449 if ((statbuf.st_uid != root_uid /* owner not root */
3450 #ifdef CONFIGURE_OWNER
3451 && statbuf.st_uid != config_uid /* owner not the special one */
3454 (statbuf.st_gid != root_gid /* group not root & */
3455 #ifdef CONFIGURE_GROUP
3456 && statbuf.st_gid != config_gid /* group not the special one */
3458 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3460 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3462 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3463 "wrong owner, group, or mode", big_buffer);
3466 /* Process the main configuration settings. They all begin with a lower case
3467 letter. If we see something starting with an upper case letter, it is taken as
3468 a macro definition. */
3470 while ((s = get_config_line()) != NULL)
3472 if (isupper(s[0])) read_macro_assignment(s);
3474 else if (Ustrncmp(s, "domainlist", 10) == 0)
3475 read_named_list(&domainlist_anchor, &domainlist_count,
3476 MAX_NAMED_LIST, s+10, US"domain list");
3478 else if (Ustrncmp(s, "hostlist", 8) == 0)
3479 read_named_list(&hostlist_anchor, &hostlist_count,
3480 MAX_NAMED_LIST, s+8, US"host list");
3482 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3483 read_named_list(&addresslist_anchor, &addresslist_count,
3484 MAX_NAMED_LIST, s+11, US"address list");
3486 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3487 read_named_list(&localpartlist_anchor, &localpartlist_count,
3488 MAX_NAMED_LIST, s+13, US"local part list");
3491 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3492 NULL, US"main option \"%s\" unknown");
3496 /* If local_sender_retain is set, local_from_check must be unset. */
3498 if (local_sender_retain && local_from_check)
3499 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3500 "local_sender_retain are set; this combination is not allowed");
3502 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3505 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3507 /* The max retry interval must not be greater than 24 hours. */
3509 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3511 /* remote_max_parallel must be > 0 */
3513 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3515 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3516 start of a new SMTP message. */
3518 freeze_tell_config = freeze_tell;
3520 /* The primary host name may be required for expansion of spool_directory
3521 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3522 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3523 canonize it. Some people like upper case letters in their host names, so we
3524 don't force the case. */
3526 if (primary_hostname == NULL)
3528 const uschar *hostname;
3530 if (uname(&uts) < 0)
3531 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3532 hostname = US uts.nodename;
3534 if (Ustrchr(hostname, '.') == NULL)
3537 struct hostent *hostdata;
3540 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3541 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3542 MCL_DOMAIN, TRUE, NULL) != OK))
3551 #if HAVE_GETIPNODEBYNAME
3553 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3555 hostdata = gethostbyname2(CS hostname, af);
3558 hostdata = gethostbyname(CS hostname);
3561 if (hostdata != NULL)
3563 hostname = US hostdata->h_name;
3567 if (af == AF_INET) break;
3572 primary_hostname = string_copy(hostname);
3575 /* Set up default value for smtp_active_hostname */
3577 smtp_active_hostname = primary_hostname;
3579 /* If spool_directory wasn't set in the build-time configuration, it must have
3580 got set above. Of course, writing to the log may not work if log_file_path is
3581 not set, but it will at least get to syslog or somewhere, with any luck. */
3583 if (*spool_directory == 0)
3584 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3587 /* Expand the spool directory name; it may, for example, contain the primary
3588 host name. Same comment about failure. */
3590 s = expand_string(spool_directory);
3592 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3593 "\"%s\": %s", spool_directory, expand_string_message);
3594 spool_directory = s;
3596 /* Expand log_file_path, which must contain "%s" in any component that isn't
3597 the null string or "syslog". It is also allowed to contain one instance of %D
3598 or %M. However, it must NOT contain % followed by anything else. */
3600 if (*log_file_path != 0)
3602 const uschar *ss, *sss;
3603 int sep = ':'; /* Fixed for log file path */
3604 s = expand_string(log_file_path);
3606 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3607 "\"%s\": %s", log_file_path, expand_string_message);
3610 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3613 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3614 t = Ustrstr(sss, "%s");
3616 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3617 "contain \"%%s\"", sss);
3619 t = Ustrchr(sss, '%');
3622 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3623 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3624 "unexpected \"%%\" character", s);
3631 /* Interpret syslog_facility into an integer argument for 'ident' param to
3632 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3635 if (syslog_facility_str != NULL)
3638 uschar *s = syslog_facility_str;
3640 if ((Ustrlen(syslog_facility_str) >= 4) &&
3641 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3644 for (i = 0; i < syslog_list_size; i++)
3646 if (strcmpic(s, syslog_list[i].name) == 0)
3648 syslog_facility = syslog_list[i].value;
3653 if (i >= syslog_list_size)
3655 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3656 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3660 /* Expand pid_file_path */
3662 if (*pid_file_path != 0)
3664 s = expand_string(pid_file_path);
3666 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3667 "\"%s\": %s", pid_file_path, expand_string_message);
3671 /* Set default value of process_log_path */
3673 if (process_log_path == NULL || *process_log_path =='\0')
3674 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3676 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3679 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3681 /* Unpick the SMTP rate limiting options, if set */
3683 if (smtp_ratelimit_mail != NULL)
3685 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3686 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3689 if (smtp_ratelimit_rcpt != NULL)
3691 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3692 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3695 /* The qualify domains default to the primary host name */
3697 if (qualify_domain_sender == NULL)
3698 qualify_domain_sender = primary_hostname;
3699 if (qualify_domain_recipient == NULL)
3700 qualify_domain_recipient = qualify_domain_sender;
3702 /* Setting system_filter_user in the configuration sets the gid as well if a
3703 name is given, but a numerical value does not. */
3705 if (system_filter_uid_set && !system_filter_gid_set)
3707 struct passwd *pw = getpwuid(system_filter_uid);
3709 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3710 (long int)system_filter_uid);
3711 system_filter_gid = pw->pw_gid;
3712 system_filter_gid_set = TRUE;
3715 /* If the errors_reply_to field is set, check that it is syntactically valid
3716 and ensure it contains a domain. */
3718 if (errors_reply_to != NULL)
3721 int start, end, domain;
3722 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3723 &start, &end, &domain, FALSE);
3725 if (recipient == NULL)
3726 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3727 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3730 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3731 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3734 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3735 smtp_accept_max must also be set. */
3737 if (smtp_accept_max == 0 &&
3738 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3739 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3740 "smtp_accept_max must be set if smtp_accept_queue or "
3741 "smtp_accept_max_per_host is set");
3743 /* Set up the host number if anything is specified. It is an expanded string
3744 so that it can be computed from the host name, for example. We do this last
3745 so as to ensure that everything else is set up before the expansion. */
3747 if (host_number_string != NULL)
3751 uschar *s = expand_string(host_number_string);
3753 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3754 "failed to expand localhost_number \"%s\": %s",
3755 host_number_string, expand_string_message);
3756 n = Ustrtol(s, &end, 0);
3757 while (isspace(*end)) end++;
3759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3760 "localhost_number value is not a number: %s", s);
3761 if (n > LOCALHOST_MAX)
3762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3763 "localhost_number is greater than the maximum allowed value (%d)",
3769 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3771 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3772 tls_verify_certificates == NULL)
3773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3774 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3775 (tls_verify_hosts != NULL)? "" : "try_");
3777 /* This also checks that the library linkage is working and we can call
3778 routines in it, so call even if tls_require_ciphers is unset */
3779 if (!tls_dropprivs_validate_require_cipher(nowarn))
3782 /* Magic number: at time of writing, 1024 has been the long-standing value
3783 used by so many clients, and what Exim used to use always, that it makes
3784 sense to just min-clamp this max-clamp at that. */
3785 if (tls_dh_max_bits < 1024)
3786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3787 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3789 /* If openssl_options is set, validate it */
3790 if (openssl_options)
3793 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3794 "openssl_options is set but we're using GnuTLS");
3797 if (!tls_openssl_options_parse(openssl_options, &dummy))
3798 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3799 "openssl_options parse error: %s", openssl_options);
3802 #endif /*SUPPORT_TLS*/
3804 if (!nowarn && !keep_environment && environ && *environ)
3805 log_write(0, LOG_MAIN,
3806 "Warning: purging the environment.\n"
3807 " Suggested action: use keep_environment.");
3812 /*************************************************
3813 * Initialize one driver *
3814 *************************************************/
3816 /* This is called once the driver's generic options, if any, have been read.
3817 We can now find the driver, set up defaults for the private options, and
3818 unset any "set" bits in the private options table (which might have been
3819 set by another incarnation of the same driver).
3822 d pointer to driver instance block, with generic
3824 drivers_available vector of available drivers
3825 size_of_info size of each block in drivers_available
3826 class class of driver, for error message
3828 Returns: pointer to the driver info block
3831 static driver_info *
3832 init_driver(driver_instance *d, driver_info *drivers_available,
3833 int size_of_info, uschar *class)
3837 for (dd = drivers_available; dd->driver_name[0] != 0;
3838 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3840 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3843 int len = dd->options_len;
3845 d->options_block = store_get(len);
3846 memcpy(d->options_block, dd->options_block, len);
3847 for (i = 0; i < *(dd->options_count); i++)
3848 dd->options[i].type &= ~opt_set;
3853 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3854 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3856 return NULL; /* never obeyed */
3862 /*************************************************
3863 * Initialize driver list *
3864 *************************************************/
3866 /* This function is called for routers, transports, and authentication
3867 mechanisms. It reads the data from the current point in the configuration file
3868 up to the end of the section, and sets up a chain of instance blocks according
3869 to the file's contents. The file will already have been opened by a call to
3870 readconf_main, and must be left open for subsequent reading of further data.
3872 Any errors cause a panic crash. Note that the blocks with names driver_info and
3873 driver_instance must map the first portions of all the _info and _instance
3874 blocks for this shared code to work.
3877 class "router", "transport", or "authenticator"
3878 anchor &routers, &transports, &auths
3879 drivers_available available drivers
3880 size_of_info size of each info block
3881 instance_default points to default data for an instance
3882 instance_size size of instance block
3883 driver_optionlist generic option list
3884 driver_optionlist_count count of generic option list
3890 readconf_driver_init(
3892 driver_instance **anchor,
3893 driver_info *drivers_available,
3895 void *instance_default,
3897 optionlist *driver_optionlist,
3898 int driver_optionlist_count)
3900 driver_instance **p = anchor;
3901 driver_instance *d = NULL;
3904 while ((buffer = get_config_line()) != NULL)
3909 /* Read the first name on the line and test for the start of a new driver. A
3910 macro definition indicates the end of the previous driver. If this isn't the
3911 start of a new driver, the line will be re-read. */
3913 s = readconf_readname(name, sizeof(name), buffer);
3915 /* Handle macro definition, first finishing off the initialization of the
3916 previous driver, if any. */
3918 if (isupper(*name) && *s == '=')
3922 if (!d->driver_name)
3923 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3924 "no driver defined for %s \"%s\"", class, d->name);
3928 read_macro_assignment(buffer);
3932 /* If the line starts with a name terminated by a colon, we are at the
3933 start of the definition of a new driver. The rest of the line must be
3940 /* Finish off initializing the previous driver. */
3944 if (!d->driver_name)
3945 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3946 "no driver defined for %s \"%s\"", class, d->name);
3950 /* Check that we haven't already got a driver of this name */
3952 for (d = *anchor; d; d = d->next)
3953 if (Ustrcmp(name, d->name) == 0)
3954 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3955 "there are two %ss called \"%s\"", class, name);
3957 /* Set up a new driver instance data block on the chain, with
3958 its default values installed. */
3960 d = store_get(instance_size);
3961 memcpy(d, instance_default, instance_size);
3964 d->name = string_copy(name);
3966 /* Clear out the "set" bits in the generic options */
3968 for (i = 0; i < driver_optionlist_count; i++)
3969 driver_optionlist[i].type &= ~opt_set;
3971 /* Check nothing more on this line, then do the next loop iteration. */
3973 while (isspace(*s)) s++;
3974 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3978 /* Not the start of a new driver. Give an error if we have not set up a
3979 current driver yet. */
3982 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3984 /* First look to see if this is a generic option; if it is "driver",
3985 initialize the driver. If is it not a generic option, we can look for a
3986 private option provided that the driver has been previously set up. */
3988 if (readconf_handle_option(buffer, driver_optionlist,
3989 driver_optionlist_count, d, NULL))
3991 if (!d->info && d->driver_name)
3992 init_driver(d, drivers_available, size_of_info, class);
3995 /* Handle private options - pass the generic block because some may
3996 live therein. A flag with each option indicates if it is in the public
4000 readconf_handle_option(buffer, d->info->options,
4001 *(d->info->options_count), d, US"option \"%s\" unknown");
4003 /* The option is not generic and the driver name has not yet been given. */
4005 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
4006 "(\"driver\" must be specified before any private options)", name);
4009 /* Run the initialization function for the final driver. */
4013 if (!d->driver_name)
4014 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
4015 "no driver defined for %s \"%s\"", class, d->name);
4022 /*************************************************
4023 * Check driver dependency *
4024 *************************************************/
4026 /* This function is passed a driver instance and a string. It checks whether
4027 any of the string options for the driver contains the given string as an
4031 d points to a driver instance block
4032 s the string to search for
4034 Returns: TRUE if a dependency is found
4038 readconf_depends(driver_instance *d, uschar *s)
4040 int count = *(d->info->options_count);
4044 for (ol = d->info->options; ol < d->info->options + count; ol++)
4046 void *options_block;
4048 int type = ol->type & opt_mask;
4049 if (type != opt_stringptr) continue;
4050 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
4051 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
4052 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
4054 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
4055 isalnum(ss[Ustrlen(s)])) continue;
4056 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
4057 d->name, ol->name, s);
4062 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4069 /*************************************************
4070 * Decode an error type for retries *
4071 *************************************************/
4073 /* This function is global because it is also called from the main
4074 program when testing retry information. It decodes strings such as "quota_7d"
4075 into numerical error codes.
4078 pp points to start of text
4079 p points past end of text
4080 basic_errno points to an int to receive the main error number
4081 more_errno points to an int to receive the secondary error data
4083 Returns: NULL if decoded correctly; else points to error text
4087 readconf_retry_error(const uschar *pp, const uschar *p,
4088 int *basic_errno, int *more_errno)
4091 const uschar *q = pp;
4092 while (q < p && *q != '_') q++;
4095 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4097 *basic_errno = ERRNO_EXIMQUOTA;
4098 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4099 return US"bad time value";
4102 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4104 *basic_errno = ECONNREFUSED;
4107 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4108 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4109 else return US"A or MX expected after \"refused\"";
4113 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4115 *basic_errno = ETIMEDOUT;
4119 int xlen = p - q - 1;
4120 const uschar *x = q + 1;
4122 static uschar *extras[] =
4123 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4124 static int values[] =
4125 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4127 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
4128 if (strncmpic(x, extras[i], xlen) == 0)
4130 *more_errno = values[i];
4134 if (i >= sizeof(extras)/sizeof(uschar *))
4135 if (strncmpic(x, US"DNS", xlen) == 0)
4136 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4137 "available in retry rules (it has never worked) - treated as "
4140 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4144 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4145 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4146 strncmpic(pp, US"data_4", 6) == 0)
4149 int x = 255; /* means "any 4xx code" */
4150 if (p != pp + 8) bad = TRUE; else
4152 int a = pp[6], b = pp[7];
4156 if (isdigit(b)) x += b - '0';
4157 else if (b == 'x') x += 100;
4160 else if (a != 'x' || b != 'x') bad = TRUE;
4164 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4165 "x is literal and d is any digit", pp);
4167 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4168 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4169 *more_errno = x << 8;
4172 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4173 strncmpic(q+1, US"failed", p-q-1) == 0)
4174 *basic_errno = ERRNO_AUTHFAIL;
4176 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4177 *basic_errno = ERRNO_SMTPCLOSED;
4179 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4180 *basic_errno = ERRNO_TLSREQUIRED;
4182 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4183 *basic_errno = ERRNO_UNKNOWNHOST;
4185 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4186 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4194 /*************************************************
4195 * Read retry information *
4196 *************************************************/
4198 /* Each line of retry information contains:
4200 . A domain name pattern or an address pattern;
4202 . An error name, possibly with additional data, or *;
4204 . An optional sequence of retry items, each consisting of an identifying
4205 letter, a cutoff time, and optional parameters.
4207 All this is decoded and placed into a control block. */
4210 /* Subroutine to read an argument, preceded by a comma and terminated
4211 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4212 1 = fixed point number (returned *1000).
4215 paddr pointer to pointer to current character; updated
4216 type 0 => read a time; 1 => read a fixed point number
4218 Returns: time in seconds or fixed point number * 1000
4222 retry_arg(const uschar **paddr, int type)
4224 const uschar *p = *paddr;
4227 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4229 while (isspace(*p)) p++;
4231 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4233 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4234 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4239 case 0: return readconf_readtime(pp, *p, FALSE);
4240 case 1: return readconf_readfixed(pp, *p);
4242 return 0; /* Keep picky compilers happy */
4245 /* The function proper */
4248 readconf_retries(void)
4250 retry_config **chain = &retries;
4254 while ((p = get_config_line()))
4256 retry_rule **rchain;
4260 next = store_get(sizeof(retry_config));
4263 chain = &(next->next);
4264 next->basic_errno = next->more_errno = 0;
4265 next->senders = NULL;
4267 rchain = &(next->rules);
4269 next->pattern = string_dequote(&p);
4270 while (isspace(*p)) p++;
4272 while (mac_isgraph(*p)) p++;
4273 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4274 "missing error type in retry rule");
4276 /* Test error names for things we understand. */
4278 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4279 &next->more_errno)))
4280 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4282 /* There may be an optional address list of senders to be used as another
4283 constraint on the rule. This was added later, so the syntax is a bit of a
4284 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4287 while (isspace(*p)) p++;
4288 if (Ustrncmp(p, "senders", 7) == 0)
4291 while (isspace(*p)) p++;
4292 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4293 "\"=\" expected after \"senders\" in retry rule");
4294 while (isspace(*p)) p++;
4295 next->senders = string_dequote(&p);
4298 /* Now the retry rules. Keep the maximum timeout encountered. */
4300 while (isspace(*p)) p++;
4304 retry_rule *rule = store_get(sizeof(retry_rule));
4306 rchain = &(rule->next);
4308 rule->rule = toupper(*p++);
4309 rule->timeout = retry_arg(&p, 0);
4310 if (rule->timeout > retry_maximum_timeout)
4311 retry_maximum_timeout = rule->timeout;
4315 case 'F': /* Fixed interval */
4316 rule->p1 = retry_arg(&p, 0);
4319 case 'G': /* Geometrically increasing intervals */
4320 case 'H': /* Ditto, but with randomness */
4321 rule->p1 = retry_arg(&p, 0);
4322 rule->p2 = retry_arg(&p, 1);
4326 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4330 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4331 (rule->rule != 'F' && rule->p2 < 1000))
4332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4333 "bad parameters for retry rule");
4335 while (isspace(*p)) p++;
4339 while (isspace(*p)) p++;
4342 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4349 /*************************************************
4350 * Initialize authenticators *
4351 *************************************************/
4354 readconf_options_auths(void)
4356 struct auth_info * ai;
4358 readconf_options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
4360 for (ai = auths_available; ai->driver_name[0]; ai++)
4362 macro_create(string_sprintf("_DRIVER_AUTHENTICATOR_%T", ai->driver_name), US"y", FALSE, TRUE);
4363 readconf_options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
4368 /* Read the authenticators section of the configuration file.
4377 auth_instance *au, *bu;
4379 readconf_driver_init(US"authenticator",
4380 (driver_instance **)(&auths), /* chain anchor */
4381 (driver_info *)auths_available, /* available drivers */
4382 sizeof(auth_info), /* size of info block */
4383 &auth_defaults, /* default values for generic options */
4384 sizeof(auth_instance), /* size of instance block */
4385 optionlist_auths, /* generic options */
4386 optionlist_auths_size);
4388 for (au = auths; au; au = au->next)
4390 if (!au->public_name)
4391 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4392 "the %s authenticator", au->name);
4394 for (bu = au->next; bu; bu = bu->next)
4395 if (strcmpic(au->public_name, bu->public_name) == 0)
4396 if ((au->client && bu->client) || (au->server && bu->server))
4397 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4398 "(%s and %s) have the same public name (%s)",
4399 au->client ? US"client" : US"server", au->name, bu->name,
4407 /*************************************************
4408 * Read ACL information *
4409 *************************************************/
4411 /* If this run of Exim is not doing something that involves receiving a
4412 message, we can just skip over the ACL information. No need to parse it.
4414 First, we have a function for acl_read() to call back to get the next line. We
4415 need to remember the line we passed, because at the end it will contain the
4416 name of the next ACL. */
4418 static uschar *acl_line;
4423 acl_line = get_config_line();
4428 /* Now the main function:
4439 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4442 acl_line = get_config_line();
4444 while(acl_line != NULL)
4450 p = readconf_readname(name, sizeof(name), acl_line);
4451 if (isupper(*name) && *p == '=')
4453 read_macro_assignment(acl_line);
4454 acl_line = get_config_line();
4458 if (*p != ':' || name[0] == 0)
4459 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4461 node = store_get(sizeof(tree_node) + Ustrlen(name));
4462 Ustrcpy(node->name, name);
4463 if (!tree_insertnode(&acl_anchor, node))
4464 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4465 "there are two ACLs called \"%s\"", name);
4467 node->data.ptr = acl_read(acl_callback, &error);
4469 if (node->data.ptr == NULL && error != NULL)
4470 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4476 /*************************************************
4477 * Read configuration for local_scan() *
4478 *************************************************/
4480 /* This function is called after "begin local_scan" is encountered in the
4481 configuration file. If the local_scan() function allows for configuration
4482 options, we can process them. Otherwise, we expire in a panic.
4489 local_scan_init(void)
4491 #ifndef LOCAL_SCAN_HAS_OPTIONS
4492 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4493 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4497 while ((p = get_config_line()) != NULL)
4499 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4500 NULL, US"local_scan option \"%s\" unknown");
4507 /*************************************************
4508 * Read rest of configuration (after main) *
4509 *************************************************/
4511 /* This function reads the rest of the runtime configuration, after the main
4512 configuration. It is called only when actually needed. Each subsequent section
4513 of the configuration starts with a line of the form
4517 where the name is "routers", "transports", etc. A section is terminated by
4518 hitting the next "begin" line, and the next name is left in next_section.
4519 Because it may confuse people as to whether the names are singular or plural,
4520 we add "s" if it's missing. There is always enough room in next_section for
4521 this. This function is basically just a switch.
4527 static uschar *section_list[] = {
4541 while(next_section[0] != 0)
4545 int last = sizeof(section_list) / sizeof(uschar *);
4547 int n = Ustrlen(next_section);
4549 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4553 int c = strcmpic(next_section, section_list[mid]);
4555 if (c > 0) first = mid + 1; else last = mid;
4557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4558 "\"%.*s\" is not a known configuration section name", n, next_section);
4559 mid = (last + first)/2;
4563 if (((had ^= bit) & bit) == 0)
4564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4565 "\"%.*s\" section is repeated in the configuration file", n,
4570 case 0: readconf_acl(); break;
4571 case 1: auths_init(); break;
4572 case 2: local_scan_init(); break;
4573 case 3: readconf_retries(); break;
4574 case 4: readconf_rewrites(); break;
4575 case 5: route_init(); break;
4576 case 6: transport_init(); break;
4580 (void)fclose(config_file);
4583 /* Init the storage for the pre-parsed config lines */
4585 readconf_save_config(const uschar *s)
4587 save_config_line(string_sprintf("# Exim Configuration (%s)",
4588 running_in_test_harness ? US"X" : s));
4592 save_config_position(const uschar *file, int line)
4594 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4597 /* Append a pre-parsed logical line to the config lines store,
4598 this operates on a global (static) list that holds all the pre-parsed
4599 config lines, we do no further processing here, output formatting and
4600 honouring of <hide> or macros will be done during output */
4602 save_config_line(const uschar* line)
4604 static config_line_item *current;
4605 config_line_item *next;
4607 next = (config_line_item*) store_get(sizeof(config_line_item));
4608 next->line = string_copy(line);
4611 if (!config_lines) config_lines = next;
4612 else current->next = next;
4617 /* List the parsed config lines, care about nice formatting and
4618 hide the <hide> values unless we're the admin user */
4620 print_config(BOOL admin, BOOL terse)
4622 config_line_item *i;
4623 const int TS = terse ? 0 : 2;
4626 for (i = config_lines; i; i = i->next)
4631 /* skip over to the first non-space */
4632 for (current = i->line; *current && isspace(*current); ++current)
4635 if (*current == '\0')
4638 /* Collapse runs of spaces. We stop this if we encounter one of the
4639 * following characters: "'$, as this may indicate careful formatting */
4640 for (p = current; *p; ++p)
4643 if (!isspace(*p)) continue;
4644 if (*p != ' ') *p = ' ';
4646 for (next = p; isspace(*next); ++next)
4650 memmove(p+1, next, Ustrlen(next)+1);
4652 if (*next == '"' || *next == '\'' || *next == '$')
4657 if (current[0] == '#')
4660 /* begin lines are left aligned */
4661 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4663 if (!terse) puts("");
4668 /* router/acl/transport block names */
4669 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4671 if (!terse) puts("");
4672 printf("%*s%s\n", TS, "", current);
4676 /* hidden lines (all MACROS or lines prefixed with "hide") */
4678 && ( isupper(*current)
4679 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4683 if ((p = Ustrchr(current, '=')))
4686 printf("%*s%s= %s\n", indent, "", current, hidden);
4688 /* e.g.: hide split_spool_directory */
4690 printf("%*s\n", indent, hidden);
4694 /* rest is public */
4695 printf("%*s%s\n", indent, "", current);
4701 /* End of readconf.c */