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 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
221 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
222 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
223 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
224 #ifdef EXPERIMENTAL_DCC
225 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
226 { "dccifd_address", opt_stringptr, &dccifd_address },
227 { "dccifd_options", opt_stringptr, &dccifd_options },
229 { "debug_store", opt_bool, &debug_store },
230 { "delay_warning", opt_timelist, &delay_warning },
231 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
232 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
233 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
234 { "delivery_date_remove", opt_bool, &delivery_date_remove },
235 #ifdef ENABLE_DISABLE_FSYNC
236 { "disable_fsync", opt_bool, &disable_fsync },
238 { "disable_ipv6", opt_bool, &disable_ipv6 },
240 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
242 #ifdef EXPERIMENTAL_DMARC
243 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
244 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
245 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
247 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
248 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
249 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
250 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
251 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
252 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
253 { "dns_retrans", opt_time, &dns_retrans },
254 { "dns_retry", opt_int, &dns_retry },
255 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
256 { "dns_use_edns0", opt_int, &dns_use_edns0 },
257 /* This option is now a no-op, retained for compatibility */
258 { "drop_cr", opt_bool, &drop_cr },
259 /*********************************************************/
260 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
261 { "dsn_from", opt_stringptr, &dsn_from },
262 { "envelope_to_remove", opt_bool, &envelope_to_remove },
263 { "errors_copy", opt_stringptr, &errors_copy },
264 { "errors_reply_to", opt_stringptr, &errors_reply_to },
265 #ifndef DISABLE_EVENT
266 { "event_action", opt_stringptr, &event_action },
268 { "exim_group", opt_gid, &exim_gid },
269 { "exim_path", opt_stringptr, &exim_path },
270 { "exim_user", opt_uid, &exim_uid },
271 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
272 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
273 { "finduser_retries", opt_int, &finduser_retries },
274 { "freeze_tell", opt_stringptr, &freeze_tell },
275 { "gecos_name", opt_stringptr, &gecos_name },
276 { "gecos_pattern", opt_stringptr, &gecos_pattern },
278 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
279 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
281 { "header_line_maxsize", opt_int, &header_line_maxsize },
282 { "header_maxsize", opt_int, &header_maxsize },
283 { "headers_charset", opt_stringptr, &headers_charset },
284 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
285 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
286 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
287 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
288 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
289 { "hold_domains", opt_stringptr, &hold_domains },
290 { "host_lookup", opt_stringptr, &host_lookup },
291 { "host_lookup_order", opt_stringptr, &host_lookup_order },
292 { "host_reject_connection", opt_stringptr, &host_reject_connection },
293 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
295 { "hosts_proxy", opt_stringptr, &hosts_proxy },
297 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
299 { "ibase_servers", opt_stringptr, &ibase_servers },
301 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
302 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
303 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
304 { "keep_environment", opt_stringptr, &keep_environment },
305 { "keep_malformed", opt_time, &keep_malformed },
307 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
308 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
309 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
310 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
311 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
312 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
313 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
314 { "ldap_start_tls", opt_bool, &eldap_start_tls },
315 { "ldap_version", opt_int, &eldap_version },
317 { "local_from_check", opt_bool, &local_from_check },
318 { "local_from_prefix", opt_stringptr, &local_from_prefix },
319 { "local_from_suffix", opt_stringptr, &local_from_suffix },
320 { "local_interfaces", opt_stringptr, &local_interfaces },
321 { "local_scan_timeout", opt_time, &local_scan_timeout },
322 { "local_sender_retain", opt_bool, &local_sender_retain },
323 { "localhost_number", opt_stringptr, &host_number_string },
324 { "log_file_path", opt_stringptr, &log_file_path },
325 { "log_selector", opt_stringptr, &log_selector_string },
326 { "log_timezone", opt_bool, &log_timezone },
327 { "lookup_open_max", opt_int, &lookup_open_max },
328 { "max_username_length", opt_int, &max_username_length },
329 { "message_body_newlines", opt_bool, &message_body_newlines },
330 { "message_body_visible", opt_mkint, &message_body_visible },
331 { "message_id_header_domain", opt_stringptr, &message_id_domain },
332 { "message_id_header_text", opt_stringptr, &message_id_text },
333 { "message_logs", opt_bool, &message_logs },
334 { "message_size_limit", opt_stringptr, &message_size_limit },
335 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
336 { "move_frozen_messages", opt_bool, &move_frozen_messages },
338 { "mua_wrapper", opt_bool, &mua_wrapper },
340 { "mysql_servers", opt_stringptr, &mysql_servers },
342 { "never_users", opt_uidlist, &never_users },
344 { "openssl_options", opt_stringptr, &openssl_options },
347 { "oracle_servers", opt_stringptr, &oracle_servers },
349 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
351 { "perl_at_start", opt_bool, &opt_perl_at_start },
352 { "perl_startup", opt_stringptr, &opt_perl_startup },
353 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
356 { "pgsql_servers", opt_stringptr, &pgsql_servers },
358 { "pid_file_path", opt_stringptr, &pid_file_path },
359 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
361 { "prdr_enable", opt_bool, &prdr_enable },
363 { "preserve_message_logs", opt_bool, &preserve_message_logs },
364 { "primary_hostname", opt_stringptr, &primary_hostname },
365 { "print_topbitchars", opt_bool, &print_topbitchars },
366 { "process_log_path", opt_stringptr, &process_log_path },
367 { "prod_requires_admin", opt_bool, &prod_requires_admin },
368 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
369 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
370 { "queue_domains", opt_stringptr, &queue_domains },
371 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
372 { "queue_only", opt_bool, &queue_only },
373 { "queue_only_file", opt_stringptr, &queue_only_file },
374 { "queue_only_load", opt_fixed, &queue_only_load },
375 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
376 { "queue_only_override", opt_bool, &queue_only_override },
377 { "queue_run_in_order", opt_bool, &queue_run_in_order },
378 { "queue_run_max", opt_stringptr, &queue_run_max },
379 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
380 { "receive_timeout", opt_time, &receive_timeout },
381 { "received_header_text", opt_stringptr, &received_header_text },
382 { "received_headers_max", opt_int, &received_headers_max },
383 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
384 { "recipients_max", opt_int, &recipients_max },
385 { "recipients_max_reject", opt_bool, &recipients_max_reject },
387 { "redis_servers", opt_stringptr, &redis_servers },
389 { "remote_max_parallel", opt_int, &remote_max_parallel },
390 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
391 { "retry_data_expire", opt_time, &retry_data_expire },
392 { "retry_interval_max", opt_time, &retry_interval_max },
393 { "return_path_remove", opt_bool, &return_path_remove },
394 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
395 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
396 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
397 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
398 { "slow_lookup_log", opt_int, &slow_lookup_log },
399 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
400 { "smtp_accept_max", opt_int, &smtp_accept_max },
401 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
402 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
403 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
404 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
405 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
406 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
407 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
408 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
409 { "smtp_banner", opt_stringptr, &smtp_banner },
410 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
411 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
412 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
413 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
414 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
415 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
416 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
417 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
418 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
419 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
420 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
421 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
422 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
423 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
425 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
427 #ifdef WITH_CONTENT_SCAN
428 { "spamd_address", opt_stringptr, &spamd_address },
430 #ifdef EXPERIMENTAL_SPF
431 { "spf_guess", opt_stringptr, &spf_guess },
433 { "split_spool_directory", opt_bool, &split_spool_directory },
434 { "spool_directory", opt_stringptr, &spool_directory },
436 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
438 #ifdef EXPERIMENTAL_SRS
439 { "srs_config", opt_stringptr, &srs_config },
440 { "srs_hashlength", opt_int, &srs_hashlength },
441 { "srs_hashmin", opt_int, &srs_hashmin },
442 { "srs_maxage", opt_int, &srs_maxage },
443 { "srs_secrets", opt_stringptr, &srs_secrets },
444 { "srs_usehash", opt_bool, &srs_usehash },
445 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
447 { "strict_acl_vars", opt_bool, &strict_acl_vars },
448 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
449 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
450 { "syslog_duplication", opt_bool, &syslog_duplication },
451 { "syslog_facility", opt_stringptr, &syslog_facility_str },
452 { "syslog_pid", opt_bool, &syslog_pid },
453 { "syslog_processname", opt_stringptr, &syslog_processname },
454 { "syslog_timestamp", opt_bool, &syslog_timestamp },
455 { "system_filter", opt_stringptr, &system_filter },
456 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
457 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
458 { "system_filter_group", opt_gid, &system_filter_gid },
459 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
460 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
461 { "system_filter_user", opt_uid, &system_filter_uid },
462 { "tcp_nodelay", opt_bool, &tcp_nodelay },
463 #ifdef USE_TCP_WRAPPERS
464 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
466 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
467 { "timezone", opt_stringptr, &timezone_string },
468 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
470 { "tls_certificate", opt_stringptr, &tls_certificate },
471 { "tls_crl", opt_stringptr, &tls_crl },
472 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
473 { "tls_dhparam", opt_stringptr, &tls_dhparam },
474 { "tls_eccurve", opt_stringptr, &tls_eccurve },
475 # ifndef DISABLE_OCSP
476 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
478 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
479 { "tls_privatekey", opt_stringptr, &tls_privatekey },
480 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
481 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
482 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
483 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
484 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
486 { "trusted_groups", opt_gidlist, &trusted_groups },
487 { "trusted_users", opt_uidlist, &trusted_users },
488 { "unknown_login", opt_stringptr, &unknown_login },
489 { "unknown_username", opt_stringptr, &unknown_username },
490 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
491 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
492 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
493 { "warn_message_file", opt_stringptr, &warn_message_file },
494 { "write_rejectlog", opt_bool, &write_rejectlog }
497 static int optionlist_config_size = nelem(optionlist_config);
501 /*************************************************
502 * Find the name of an option *
503 *************************************************/
505 /* This function is to aid debugging. Various functions take arguments that are
506 pointer variables in the options table or in option tables for various drivers.
507 For debugging output, it is useful to be able to find the name of the option
508 which is currently being processed. This function finds it, if it exists, by
509 searching the table(s).
511 Arguments: a value that is presumed to be in the table above
512 Returns: the option name, or an empty string
516 readconf_find_option(void *p)
520 transport_instance *t;
522 for (i = 0; i < nelem(optionlist_config); i++)
523 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
525 for (r = routers; r; r = r->next)
527 router_info *ri = r->info;
528 for (i = 0; i < *ri->options_count; i++)
530 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
531 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
532 return US ri->options[i].name;
536 for (t = transports; t; t = t->next)
538 transport_info *ti = t->info;
539 for (i = 0; i < *ti->options_count; i++)
541 optionlist * op = &ti->options[i];
542 if ((op->type & opt_mask) != opt_stringptr) continue;
543 if (p == ( op->type & opt_public
545 : (char *)t->options_block
547 + (long int)op->value)
558 /*************************************************
559 * Deal with an assignment to a macro *
560 *************************************************/
562 /* We have a new definition. The macro_item structure includes a final vector
563 called "name" which is one byte long. Thus, adding "namelen" gives us enough
564 room to store the "name" string.
565 If a builtin macro we place at head of list, else tail. This lets us lazy-create
569 macro_create(const uschar * name, const uschar * val,
570 BOOL command_line, BOOL builtin)
572 unsigned namelen = Ustrlen(name);
573 macro_item * m = store_get(sizeof(macro_item) + namelen);
575 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val) */
593 m->command_line = command_line;
594 m->namelen = namelen;
595 m->replacement = string_copy(val);
596 Ustrcpy(m->name, name);
601 /* This function is called when a line that starts with an upper case letter is
602 encountered. The argument "line" should contain a complete logical line, and
603 start with the first letter of the macro name. The macro name and the
604 replacement text are extracted and stored. Redefinition of existing,
605 non-command line, macros is permitted using '==' instead of '='.
608 s points to the start of the logical line
614 read_macro_assignment(uschar *s)
621 while (isalnum(*s) || *s == '_')
623 if (namelen >= sizeof(name) - 1)
624 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
625 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
626 name[namelen++] = *s++;
630 while (isspace(*s)) s++;
632 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
639 while (isspace(*s)) s++;
641 /* If an existing macro of the same name was defined on the command line, we
642 just skip this definition. It's an error to attempt to redefine a macro without
643 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
644 It is also an error to define a macro whose name begins with the name of a
645 previously defined macro. This is the requirement that make using a tree
646 for macros hard; we must check all macros for the substring. Perhaps a
647 sorted list, and a bsearch, would work?
648 Note: it is documented that the other way round works. */
650 for (m = macros; m; m = m->next)
652 if (Ustrcmp(m->name, name) == 0)
654 if (!m->command_line && !redef)
655 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
656 "defined (use \"==\" if you want to redefine it", name);
660 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
661 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
662 "a macro because previously defined macro \"%s\" is a substring",
665 /* We cannot have this test, because it is documented that a substring
666 macro is permitted (there is even an example).
668 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
669 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
670 * "a macro because it is a substring of previously defined macro \"%s\"",
675 /* Check for an overriding command-line definition. */
677 if (m && m->command_line) return;
679 /* Redefinition must refer to an existing macro. */
683 m->replacement = string_copy(s);
685 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
688 /* We have a new definition. */
690 (void) macro_create(name, s, FALSE, FALSE);
697 /*************************************************/
698 /* Create compile-time feature macros */
700 readconf_features(void)
702 /* Probably we could work out a static initialiser for wherever
703 macros are stored, but this will do for now. Some names are awkward
704 due to conflicts with other common macros. */
706 #ifdef SUPPORT_CRYPTEQ
707 macro_create(US"_HAVE_CRYPTEQ", US"y", FALSE, TRUE);
710 macro_create(US"_HAVE_ICONV", US"y", FALSE, TRUE);
713 macro_create(US"_HAVE_IPV6", US"y", FALSE, TRUE);
715 #ifdef HAVE_SETCLASSRESOURCES
716 macro_create(US"_HAVE_SETCLASSRESOURCES", US"y", FALSE, TRUE);
719 macro_create(US"_HAVE_PAM", US"y", FALSE, TRUE);
722 macro_create(US"_HAVE_PERL", US"y", FALSE, TRUE);
725 macro_create(US"_HAVE_DLFUNC", US"y", FALSE, TRUE);
727 #ifdef USE_TCP_WRAPPERS
728 macro_create(US"_HAVE_TCPWRAPPERS", US"y", FALSE, TRUE);
731 macro_create(US"_HAVE_TLS", US"y", FALSE, TRUE);
733 macro_create(US"_HAVE_GNUTLS", US"y", FALSE, TRUE);
735 macro_create(US"_HAVE_OPENSSL", US"y", FALSE, TRUE);
738 #ifdef SUPPORT_TRANSLATE_IP_ADDRESS
739 macro_create(US"_HAVE_TRANSLATE_IP_ADDRESS", US"y", FALSE, TRUE);
741 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
742 macro_create(US"_HAVE_MOVE_FROZEN_MESSAGES", US"y", FALSE, TRUE);
744 #ifdef WITH_CONTENT_SCAN
745 macro_create(US"_HAVE_CONTENT_SCANNING", US"y", FALSE, TRUE);
748 macro_create(US"_HAVE_DKIM", US"y", FALSE, TRUE);
750 #ifndef DISABLE_DNSSEC
751 macro_create(US"_HAVE_DNSSEC", US"y", FALSE, TRUE);
753 #ifndef DISABLE_EVENT
754 macro_create(US"_HAVE_EVENT", US"y", FALSE, TRUE);
757 macro_create(US"_HAVE_I18N", US"y", FALSE, TRUE);
760 macro_create(US"_HAVE_OCSP", US"y", FALSE, TRUE);
763 macro_create(US"_HAVE_PRDR", US"y", FALSE, TRUE);
766 macro_create(US"_HAVE_PROXY", US"y", FALSE, TRUE);
769 macro_create(US"_HAVE_SOCKS", US"y", FALSE, TRUE);
772 macro_create(US"_HAVE_TCP_FASTOPEN", US"y", FALSE, TRUE);
774 #ifdef EXPERIMENTAL_LMDB
775 macro_create(US"_HAVE_LMDB", US"y", FALSE, TRUE);
777 #ifdef EXPERIMENTAL_SPF
778 macro_create(US"_HAVE_SPF", US"y", FALSE, TRUE);
780 #ifdef EXPERIMENTAL_SRS
781 macro_create(US"_HAVE_SRS", US"y", FALSE, TRUE);
783 #ifdef EXPERIMENTAL_BRIGHTMAIL
784 macro_create(US"_HAVE_BRIGHTMAIL", US"y", FALSE, TRUE);
786 #ifdef EXPERIMENTAL_DANE
787 macro_create(US"_HAVE_DANE", US"y", FALSE, TRUE);
789 #ifdef EXPERIMENTAL_DCC
790 macro_create(US"_HAVE_DCC", US"y", FALSE, TRUE);
792 #ifdef EXPERIMENTAL_DMARC
793 macro_create(US"_HAVE_DMARC", US"y", FALSE, TRUE);
795 #ifdef EXPERIMENTAL_DSN_INFO
796 macro_create(US"_HAVE_DSN_INFO", US"y", FALSE, TRUE);
799 #ifdef LOOKUP_LSEARCH
800 macro_create(US"_HAVE_LOOKUP_LSEARCH", US"y", FALSE, TRUE);
803 macro_create(US"_HAVE_LOOKUP_CDB", US"y", FALSE, TRUE);
806 macro_create(US"_HAVE_LOOKUP_DBM", US"y", FALSE, TRUE);
809 macro_create(US"_HAVE_LOOKUP_DNSDB", US"y", FALSE, TRUE);
811 #ifdef LOOKUP_DSEARCH
812 macro_create(US"_HAVE_LOOKUP_DSEARCH", US"y", FALSE, TRUE);
815 macro_create(US"_HAVE_LOOKUP_IBASE", US"y", FALSE, TRUE);
818 macro_create(US"_HAVE_LOOKUP_LDAP", US"y", FALSE, TRUE);
820 #ifdef EXPERIMENTAL_LMDB
821 macro_create(US"_HAVE_LOOKUP_LMDB", US"y", FALSE, TRUE);
824 macro_create(US"_HAVE_LOOKUP_MYSQL", US"y", FALSE, TRUE);
827 macro_create(US"_HAVE_LOOKUP_NIS", US"y", FALSE, TRUE);
829 #ifdef LOOKUP_NISPLUS
830 macro_create(US"_HAVE_LOOKUP_NISPLUS", US"y", FALSE, TRUE);
833 macro_create(US"_HAVE_LOOKUP_ORACLE", US"y", FALSE, TRUE);
836 macro_create(US"_HAVE_LOOKUP_PASSWD", US"y", FALSE, TRUE);
839 macro_create(US"_HAVE_LOOKUP_PGSQL", US"y", FALSE, TRUE);
842 macro_create(US"_HAVE_LOOKUP_REDIS", US"y", FALSE, TRUE);
845 macro_create(US"_HAVE_LOOKUP_SQLITE", US"y", FALSE, TRUE);
848 macro_create(US"_HAVE_LOOKUP_TESTDB", US"y", FALSE, TRUE);
851 macro_create(US"_HAVE_LOOKUP_WHOSON", US"y", FALSE, TRUE);
854 #ifdef TRANSPORT_APPENDFILE
855 # ifdef SUPPORT_MAILDIR
856 macro_create(US"_HAVE_TRANSPORT_APPEND_MAILDIR", US"y", FALSE, TRUE);
858 # ifdef SUPPORT_MAILSTORE
859 macro_create(US"_HAVE_TRANSPORT_APPEND_MAILSTORE", US"y", FALSE, TRUE);
862 macro_create(US"_HAVE_TRANSPORT_APPEND_MBX", US"y", FALSE, TRUE);
869 readconf_options_from_list(optionlist * opts, unsigned nopt, const uschar * section, uschar * group)
874 /* The 'previously-defined-substring' rule for macros in config file
875 lines is done so for these builtin macros: we know that the table
876 we source from is in strict alpha order, hence the builtins portion
877 of the macros list is in reverse-alpha (we prepend them) - so longer
878 macros that have substrings are always discovered first during
881 for (i = 0; i < nopt; i++) if (*(s = US opts[i].name) && *s != '*')
883 macro_create(string_sprintf("_OPT_%T_%T_%T", section, group, s), US"y", FALSE, TRUE);
885 macro_create(string_sprintf("_OPT_%T_%T", section, s), US"y", FALSE, TRUE);
890 readconf_options(void)
892 readconf_options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN", NULL);
893 readconf_options_routers();
894 readconf_options_transports();
895 readconf_options_auths();
899 macros_create_builtin(void)
903 macros_builtin_created = TRUE;
907 /*************************************************
908 * Read configuration line *
909 *************************************************/
911 /* A logical line of text is read from the configuration file into the big
912 buffer, taking account of macros, .includes, and continuations. The size of
913 big_buffer is increased if necessary. The count of configuration lines is
914 maintained. Physical input lines starting with # (ignoring leading white space,
915 and after macro replacement) and empty logical lines are always ignored.
916 Leading and trailing spaces are removed.
918 If we hit a line of the form "begin xxxx", the xxxx is placed in the
919 next_section vector, and the function returns NULL, indicating the end of a
920 configuration section. On end-of-file, NULL is returned with next_section
925 Returns: a pointer to the first non-blank in the line,
926 or NULL if eof or end of section is reached
930 get_config_line(void)
932 int startoffset = 0; /* To first non-blank char in logical line */
933 int len = 0; /* Of logical line so far */
939 /* Loop for handling continuation lines, skipping comments, and dealing with
944 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
946 if (config_file_stack != NULL) /* EOF inside .include */
948 (void)fclose(config_file);
949 config_file = config_file_stack->file;
950 config_filename = config_file_stack->filename;
951 config_directory = config_file_stack->directory;
952 config_lineno = config_file_stack->lineno;
953 config_file_stack = config_file_stack->next;
955 save_config_position(config_filename, config_lineno);
959 /* EOF at top level */
961 if (cstate_stack_ptr >= 0)
962 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
963 "Unexpected end of configuration file: .endif missing");
965 if (len != 0) break; /* EOF after continuation */
966 next_section[0] = 0; /* EOF at start of logical line */
971 newlen = len + Ustrlen(big_buffer + len);
973 if (config_lines && config_lineno == 1)
974 save_config_position(config_filename, config_lineno);
976 /* Handle pathologically long physical lines - yes, it did happen - by
977 extending big_buffer at this point. The code also copes with very long
980 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
983 big_buffer_size += BIG_BUFFER_SIZE;
984 newbuffer = store_malloc(big_buffer_size);
986 /* This use of strcpy is OK because we know that the string in the old
987 buffer is shorter than the new buffer. */
989 Ustrcpy(newbuffer, big_buffer);
990 store_free(big_buffer);
991 big_buffer = newbuffer;
992 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
994 newlen += Ustrlen(big_buffer + newlen);
997 /* Find the true start of the physical line - leading spaces are always
1000 ss = big_buffer + len;
1001 while (isspace(*ss)) ss++;
1003 /* Process the physical line for macros. If this is the start of the logical
1004 line, skip over initial text at the start of the line if it starts with an
1005 upper case character followed by a sequence of name characters and an equals
1006 sign, because that is the definition of a new macro, and we don't do
1007 replacement therein. */
1010 if (len == 0 && isupper(*s))
1012 while (isalnum(*s) || *s == '_') s++;
1013 while (isspace(*s)) s++;
1014 if (*s != '=') s = ss; /* Not a macro definition */
1017 /* If the builtin macros are not yet defined, and the line contains an
1018 underscrore followed by an one of the three possible chars used by
1019 builtins, create them. */
1021 if (!macros_builtin_created)
1023 const uschar * t, * p;
1025 for (t = s; (p = CUstrchr(t, '_')); t = p+1)
1026 if (c = p[1], c == 'O' || c == 'D' || c == 'H')
1028 /* fprintf(stderr, "%s: builtins create triggered by '%s'\n", __FUNCTION__, s); */
1029 macros_create_builtin();
1034 /* For each defined macro, scan the line (from after XXX= if present),
1035 replacing all occurrences of the macro. */
1037 macro_found = FALSE;
1038 for (m = macros; m; m = m->next)
1043 while ((p = Ustrstr(t, m->name)) != NULL)
1046 int replen = Ustrlen(m->replacement);
1048 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, t) */
1049 /* Expand the buffer if necessary */
1051 while (newlen - m->namelen + replen + 1 > big_buffer_size)
1053 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
1054 uschar *newbuffer = store_malloc(newsize);
1055 memcpy(newbuffer, big_buffer, newlen + 1);
1056 p = newbuffer + (p - big_buffer);
1057 s = newbuffer + (s - big_buffer);
1058 ss = newbuffer + (ss - big_buffer);
1059 t = newbuffer + (t - big_buffer);
1060 big_buffer_size = newsize;
1061 store_free(big_buffer);
1062 big_buffer = newbuffer;
1065 /* Shuffle the remaining characters up or down in the buffer before
1066 copying in the replacement text. Don't rescan the replacement for this
1069 pp = p + m->namelen;
1070 if ((moveby = replen - m->namelen) != 0)
1072 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
1075 Ustrncpy(p, m->replacement, replen);
1081 /* An empty macro replacement at the start of a line could mean that ss no
1082 longer points to the first non-blank character. */
1084 while (isspace(*ss)) ss++;
1086 /* Check for comment lines - these are physical lines. */
1088 if (*ss == '#') continue;
1090 /* Handle conditionals, which are also applied to physical lines. Conditions
1091 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1092 expansion occured on the rest of the line. A preliminary test for the leading
1093 '.' saves effort on most lines. */
1099 /* Search the list of conditional directives */
1101 for (i = 0; i < cond_list_size; i++)
1104 cond_item *c = cond_list+i;
1105 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1107 /* The following character must be white space or end of string */
1109 n = ss[1 + c->namelen];
1110 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1112 /* .ifdef and .ifndef push the current state onto the stack, then set
1113 a new one from the table. Stack overflow is an error */
1117 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1118 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1119 ".%s nested too deeply", c->name);
1120 cstate_stack[++cstate_stack_ptr] = cstate;
1121 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1124 /* For any of the others, stack underflow is an error. The next state
1125 comes either from the stack (.endif) or from the table. */
1129 if (cstate_stack_ptr < 0)
1130 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1131 ".%s without matching .ifdef", c->name);
1132 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1133 next_cstate[cstate][macro_found? c->action1 : c->action2];
1136 /* Having dealt with a directive, break the loop */
1141 /* If we have handled a conditional directive, continue with the next
1142 physical line. Otherwise, fall through. */
1144 if (i < cond_list_size) continue;
1147 /* If the conditional state is not 0 (actively using these lines), ignore
1150 if (cstate != 0) continue; /* Conditional skip */
1152 /* Handle .include lines - these are also physical lines. */
1154 if (Ustrncmp(ss, ".include", 8) == 0 &&
1156 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1159 int include_if_exists = isspace(ss[8])? 0 : 10;
1160 config_file_item *save;
1161 struct stat statbuf;
1163 ss += 9 + include_if_exists;
1164 while (isspace(*ss)) ss++;
1165 t = ss + Ustrlen(ss);
1166 while (t > ss && isspace(t[-1])) t--;
1167 if (*ss == '\"' && t[-1] == '\"')
1174 /* We allow relative file names. For security reasons currently
1175 relative names not allowed with .include_if_exists. For .include_if_exists
1176 we need to check the permissions/ownership of the containing folder */
1178 if (include_if_exists) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1179 "absolute path \"%s\"", ss);
1184 ss = string_append(NULL, &size, &offset, 3, config_directory, "/", ss);
1185 ss[offset] = '\0'; /* string_append() does not zero terminate the string! */
1188 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1191 save_config_position(config_filename, config_lineno);
1192 save = store_get(sizeof(config_file_item));
1193 save->next = config_file_stack;
1194 config_file_stack = save;
1195 save->file = config_file;
1196 save->filename = config_filename;
1197 save->directory = config_directory;
1198 save->lineno = config_lineno;
1200 if (!(config_file = Ufopen(ss, "rb")))
1201 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1202 "configuration file %s", ss);
1204 config_filename = string_copy(ss);
1205 config_directory = string_copyn(ss, CUstrrchr(ss, '/') - ss);
1210 /* If this is the start of the logical line, remember where the non-blank
1211 data starts. Otherwise shuffle down continuation lines to remove leading
1215 startoffset = ss - big_buffer;
1218 s = big_buffer + len;
1221 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1226 /* Accept the new addition to the line. Remove trailing white space. */
1229 while (len > 0 && isspace(big_buffer[len-1])) len--;
1230 big_buffer[len] = 0;
1232 /* We are done if the line does not end in backslash and contains some data.
1233 Empty logical lines are ignored. For continuations, remove the backslash and
1234 go round the loop to read the continuation line. */
1238 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1239 big_buffer[--len] = 0; /* Remove backslash */
1241 } /* Loop for reading multiple physical lines */
1243 /* We now have a logical line. Test for the end of a configuration section (or,
1244 more accurately, for the start of the next section). Place the name of the next
1245 section in next_section, and return NULL. If the name given is longer than
1246 next_section, truncate it. It will be unrecognized later, because all the known
1247 section names do fit. Leave space for pluralizing. */
1249 s = big_buffer + startoffset; /* First non-space character */
1252 save_config_line(s);
1254 if (strncmpic(s, US"begin ", 6) == 0)
1257 while (isspace(*s)) s++;
1258 if (big_buffer + len - s > sizeof(next_section) - 2)
1259 s[sizeof(next_section) - 2] = 0;
1260 Ustrcpy(next_section, s);
1264 /* Return the first non-blank character. */
1271 /*************************************************
1273 *************************************************/
1275 /* The yield is the pointer to the next uschar. Names longer than the
1276 output space are silently truncated. This function is also used from acl.c when
1280 name where to put the name
1284 Returns: new input pointer
1288 readconf_readname(uschar *name, int len, uschar *s)
1291 while (isspace(*s)) s++;
1294 while (isalnum(*s) || *s == '_')
1296 if (p < len-1) name[p++] = *s;
1301 while (isspace(*s)) s++;
1308 /*************************************************
1309 * Read a time value *
1310 *************************************************/
1312 /* This function is also called from outside, to read argument
1313 time values. The format of a time value is:
1315 [<n>w][<n>d][<n>h][<n>m][<n>s]
1317 as long as at least one is present. If a format error is encountered,
1318 return a negative value. The value must be terminated by the given
1323 terminator required terminating character
1324 return_msec if TRUE, allow fractional seconds and return milliseconds
1326 Returns: the time value, or -1 on syntax error
1327 value is seconds if return_msec is FALSE
1328 value is milliseconds if return_msec is TRUE
1332 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1340 if (!isdigit(*s)) return -1;
1341 (void)sscanf(CCS s, "%d%n", &value, &count);
1346 case 'w': value *= 7;
1347 case 'd': value *= 24;
1348 case 'h': value *= 60;
1349 case 'm': value *= 60;
1354 if (!return_msec) return -1;
1355 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1357 if (*s++ != 's') return -1;
1358 yield += (int)(fraction * 1000.0);
1364 if (return_msec) value *= 1000;
1366 if (*s == terminator) return yield;
1368 /* Control never reaches here. */
1373 /*************************************************
1374 * Read a fixed point value *
1375 *************************************************/
1377 /* The value is returned *1000
1381 terminator required terminator
1383 Returns: the value, or -1 on error
1387 readconf_readfixed(const uschar *s, int terminator)
1391 if (!isdigit(*s)) return -1;
1392 (void)sscanf(CS s, "%d%n", &value, &count);
1394 yield = value * 1000;
1398 while (isdigit((*(++s))))
1400 yield += (*s - '0') * m;
1405 return (*s == terminator)? yield : (-1);
1410 /*************************************************
1411 * Find option in list *
1412 *************************************************/
1414 /* The lists are always in order, so binary chop can be used.
1417 name the option name to search for
1418 ol the first entry in the option list
1419 last one more than the offset of the last entry in the option list
1421 Returns: pointer to an option entry, or NULL if not found
1425 find_option(uschar *name, optionlist *ol, int last)
1428 while (last > first)
1430 int middle = (first + last)/2;
1431 int c = Ustrcmp(name, ol[middle].name);
1433 if (c == 0) return ol + middle;
1434 else if (c > 0) first = middle + 1;
1442 /*************************************************
1443 * Find a set flag in option list *
1444 *************************************************/
1446 /* Because some versions of Unix make no restrictions on the values of uids and
1447 gids (even negative ones), we cannot represent "unset" by a special value.
1448 There is therefore a separate boolean variable for each one indicating whether
1449 a value is set or not. This function returns a pointer to the boolean, given
1450 the original option name. It is a major disaster if the flag cannot be found.
1453 name the name of the uid or gid option
1454 oltop points to the start of the relevant option list
1455 last one more than the offset of the last item in the option list
1456 data_block NULL when reading main options => data values in the option
1457 list are absolute addresses; otherwise they are byte offsets
1458 in data_block (used for driver options)
1460 Returns: a pointer to the boolean flag.
1464 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1468 sprintf(CS name2, "*set_%.50s", name);
1469 ol = find_option(name2, oltop, last);
1470 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1471 "Exim internal error: missing set flag for %s", name);
1472 return (data_block == NULL)? (BOOL *)(ol->value) :
1473 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1479 /*************************************************
1480 * Output extra characters message and die *
1481 *************************************************/
1483 /* Called when an option line has junk on the end. Sometimes this is because
1484 the sysadmin thinks comments are permitted.
1487 s points to the extra characters
1488 t1..t3 strings to insert in the log message
1490 Returns: doesn't return; dies
1494 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1496 uschar *comment = US"";
1497 if (*s == '#') comment = US" (# is comment only at line start)";
1498 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1499 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1504 /*************************************************
1505 * Read rewrite information *
1506 *************************************************/
1508 /* Each line of rewrite information contains:
1510 . A complete address in the form user@domain, possibly with
1511 leading * for each part; or alternatively, a regex.
1513 . A replacement string (which will be expanded).
1515 . An optional sequence of one-letter flags, indicating which
1516 headers etc. to apply this rule to.
1518 All this is decoded and placed into a control block. The OR of the flags is
1519 maintained in a common word.
1522 p points to the string that makes up the rule
1523 existflags points to the overall flag word
1524 isglobal TRUE if reading global rewrite rules
1526 Returns: the control block for the parsed rule.
1529 static rewrite_rule *
1530 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1532 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1535 next->key = string_dequote(&p);
1537 while (isspace(*p)) p++;
1539 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1540 "missing rewrite replacement string");
1543 next->replacement = string_dequote(&p);
1545 while (*p != 0) switch (*p++)
1547 case ' ': case '\t': break;
1549 case 'q': next->flags |= rewrite_quit; break;
1550 case 'w': next->flags |= rewrite_whole; break;
1552 case 'h': next->flags |= rewrite_all_headers; break;
1553 case 's': next->flags |= rewrite_sender; break;
1554 case 'f': next->flags |= rewrite_from; break;
1555 case 't': next->flags |= rewrite_to; break;
1556 case 'c': next->flags |= rewrite_cc; break;
1557 case 'b': next->flags |= rewrite_bcc; break;
1558 case 'r': next->flags |= rewrite_replyto; break;
1560 case 'E': next->flags |= rewrite_all_envelope; break;
1561 case 'F': next->flags |= rewrite_envfrom; break;
1562 case 'T': next->flags |= rewrite_envto; break;
1564 case 'Q': next->flags |= rewrite_qualify; break;
1565 case 'R': next->flags |= rewrite_repeat; break;
1568 next->flags |= rewrite_smtp;
1569 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1570 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1571 "rewrite rule has the S flag but is not a regular expression");
1575 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1576 "unknown rewrite flag character '%c' "
1577 "(could be missing quotes round replacement item)", p[-1]);
1581 /* If no action flags are set, set all the "normal" rewrites. */
1583 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1584 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1586 /* Remember which exist, for optimization, and return the rule */
1588 *existflags |= next->flags;
1595 /*************************************************
1596 * Read global rewrite information *
1597 *************************************************/
1599 /* Each line is a single rewrite rule; it is parsed into a control block
1600 by readconf_one_rewrite(), and its flags are ORed into the global flag
1601 word rewrite_existflags. */
1604 readconf_rewrites(void)
1606 rewrite_rule **chain = &global_rewrite_rules;
1609 while ((p = get_config_line()) != NULL)
1611 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1613 chain = &(next->next);
1619 /*************************************************
1621 *************************************************/
1623 /* Strings are read into the normal store pool. As long we aren't too
1624 near the end of the current block, the string will just use what is necessary
1625 on the top of the stacking pool, because string_cat() uses the extension
1629 s the rest of the input line
1630 name the option name (for errors)
1632 Returns: pointer to the string
1636 read_string(const uschar *s, const uschar *name)
1641 if (*s != '\"') return string_copy(s);
1644 yield = string_dequote(&s);
1646 if (s == ss+1 || s[-1] != '\"')
1647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1648 "missing quote at end of string value for %s", name);
1650 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1656 /*************************************************
1657 * Custom-handler options *
1658 *************************************************/
1660 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1663 smtp_receive_timeout_s = string_copy(str);
1666 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1667 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1668 if (smtp_receive_timeout < 0)
1669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1674 /*************************************************
1675 * Handle option line *
1676 *************************************************/
1678 /* This function is called from several places to process a line containing the
1679 setting of an option. The first argument is the line to be decoded; it has been
1680 checked not to be empty and not to start with '#'. Trailing newlines and white
1681 space have been removed. The second argument is a pointer to the list of
1682 variable names that are to be recognized, together with their types and
1683 locations, and the third argument gives the number of entries in the list.
1685 The fourth argument is a pointer to a data block. If it is NULL, then the data
1686 values in the options list are absolute addresses. Otherwise, they are byte
1687 offsets in the data block.
1689 String option data may continue onto several lines; this function reads further
1690 data from config_file if necessary.
1692 The yield of this function is normally zero. If a string continues onto
1693 multiple lines, then the data value is permitted to be followed by a comma
1694 or a semicolon (for use in drivers) and the yield is that character.
1697 buffer contains the configuration line to be handled
1698 oltop points to the start of the relevant option list
1699 last one more than the offset of the last item in the option list
1700 data_block NULL when reading main options => data values in the option
1701 list are absolute addresses; otherwise they are byte offsets
1702 in data_block when they have opt_public set; otherwise
1703 they are byte offsets in data_block->options_block.
1704 unknown_txt format string to use in panic message for unknown option;
1705 must contain %s for option name
1706 if given as NULL, don't panic on unknown option
1708 Returns: TRUE if an option was read successfully,
1709 FALSE false for an unknown option if unknown_txt == NULL,
1710 otherwise panic and die on an unknown option
1714 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1715 void *data_block, uschar *unknown_txt)
1719 int n, count, type, value;
1723 BOOL boolvalue = TRUE;
1724 BOOL freesptr = TRUE;
1725 optionlist *ol, *ol2;
1729 uschar *inttype = US"";
1732 uschar **str_target;
1736 /* There may be leading spaces; thereafter, we expect an option name starting
1739 while (isspace(*s)) s++;
1741 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1743 /* Read the name of the option, and skip any subsequent white space. If
1744 it turns out that what we read was "hide", set the flag indicating that
1745 this is a secure option, and loop to read the next word. */
1747 for (n = 0; n < 2; n++)
1749 while (isalnum(*s) || *s == '_')
1751 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1755 while (isspace(*s)) s++;
1756 if (Ustrcmp(name, "hide") != 0) break;
1757 issecure = opt_secure;
1761 /* Deal with "no_" or "not_" here for booleans */
1763 if (Ustrncmp(name, "no_", 3) == 0)
1769 if (Ustrncmp(name, "not_", 4) == 0)
1775 /* Search the list for the given name. A non-existent name, or an option that
1776 is set twice, is a disaster. */
1778 if (!(ol = find_option(name + offset, oltop, last)))
1780 if (unknown_txt == NULL) return FALSE;
1781 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1784 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1785 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1786 "\"%s\" option set for the second time", name);
1788 ol->type |= opt_set | issecure;
1789 type = ol->type & opt_mask;
1791 /* Types with data values must be followed by '='; the "no[t]_" prefix
1792 applies only to boolean values. */
1794 if (type < opt_bool || type > opt_bool_last)
1797 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1798 "negation prefix applied to a non-boolean option");
1800 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1801 "unexpected end of line (data missing) after %s", name);
1803 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1806 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1807 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1808 ultimately expands to one of those values. */
1810 else if (*s != 0 && (offset != 0 || *s != '='))
1811 extra_chars_error(s, US"boolean option ", name, US"");
1813 /* Skip white space after = */
1815 if (*s == '=') while (isspace((*(++s))));
1817 /* If there is a data block and the opt_public flag is not set, change
1818 the data block pointer to the private options block. */
1820 if (data_block != NULL && (ol->type & opt_public) == 0)
1821 data_block = (void *)(((driver_instance *)data_block)->options_block);
1823 /* Now get the data according to the type. */
1827 /* If a string value is not enclosed in quotes, it consists of
1828 the rest of the current line, verbatim. Otherwise, string escapes
1831 A transport is specified as a string, which is then looked up in the
1832 list of transports. A search type is specified as one of a number of
1835 A set or rewrite rules for a driver is specified as a string, which is
1836 then parsed into a suitable chain of control blocks.
1838 Uids and gids are specified as strings which are then looked up in the
1839 passwd file. Lists of uids and gids are similarly specified as colon-
1840 separated strings. */
1845 case opt_expand_uid:
1846 case opt_expand_gid:
1851 reset_point = sptr = read_string(s, name);
1853 /* Having read a string, we now have several different ways of using it,
1854 depending on the data type, so do another switch. If keeping the actual
1855 string is not required (because it is interpreted), freesptr is set TRUE,
1856 and at the end we reset the pool. */
1860 /* If this was a string, set the variable to point to the new string,
1861 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1862 rules, we still keep the string (for printing), and parse the rules into a
1863 control block and flags word. */
1866 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1868 if (ol->type & opt_rep_con)
1870 uschar * saved_condition;
1871 /* We already have a condition, we're conducting a crude hack to let
1872 multiple condition rules be chained together, despite storing them in
1874 *str_target = string_copy_malloc( (saved_condition = *str_target)
1875 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1876 saved_condition, sptr)
1878 /* TODO(pdp): there is a memory leak here and just below
1879 when we set 3 or more conditions; I still don't
1880 understand the store mechanism enough to know
1881 what's the safe way to free content from an earlier store.
1882 AFAICT, stores stack, so freeing an early stored item also stores
1883 all data alloc'd after it. If we knew conditions were adjacent,
1884 we could survive that, but we don't. So I *think* we need to take
1885 another bit from opt_type to indicate "malloced"; this seems like
1886 quite a hack, especially for this one case. It also means that
1887 we can't ever reclaim the store from the *first* condition.
1889 Because we only do this once, near process start-up, I'm prepared to
1890 let this slide for the time being, even though it rankles. */
1892 else if (ol->type & opt_rep_str)
1894 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1895 int sep_i = -(int)sep_o;
1896 const uschar * list = sptr;
1898 uschar * list_o = *str_target;
1900 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1901 list_o = string_append_listele(list_o, sep_o, s);
1903 *str_target = string_copy_malloc(list_o);
1914 *USS (US data_block + (long int)(ol->value)) = sptr;
1916 *USS (ol->value) = sptr;
1918 if (type == opt_rewrite)
1923 rewrite_rule **chain;
1926 sprintf(CS name2, "*%.50s_rules", name);
1927 ol2 = find_option(name2, oltop, last);
1928 sprintf(CS name2, "*%.50s_flags", name);
1929 ol3 = find_option(name2, oltop, last);
1931 if (ol2 == NULL || ol3 == NULL)
1932 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1933 "rewrite rules not available for driver");
1935 if (data_block == NULL)
1937 chain = (rewrite_rule **)(ol2->value);
1938 flagptr = (int *)(ol3->value);
1942 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1943 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1946 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1948 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1950 chain = &(next->next);
1953 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1954 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1955 "non-header rewrite - not allowed at transport time -");
1959 /* If it was an expanded uid, see if there is any expansion to be
1960 done by checking for the presence of a $ character. If there is, save it
1961 in the corresponding *expand_user option field. Otherwise, fall through
1962 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1965 case opt_expand_uid:
1966 sprintf(CS name2, "*expand_%.50s", name);
1967 ol2 = find_option(name2, oltop, last);
1970 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1972 if (data_block == NULL)
1973 *((uschar **)(ol2->value)) = ss;
1975 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1979 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1985 /* Look up a fixed uid, and also make use of the corresponding gid
1986 if a passwd entry is returned and the gid has not been set. */
1989 if (!route_finduser(sptr, &pw, &uid))
1990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1991 if (data_block == NULL)
1992 *((uid_t *)(ol->value)) = uid;
1994 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1996 /* Set the flag indicating a fixed value is set */
1998 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2000 /* Handle matching gid if we have a passwd entry: done by finding the
2001 same name with terminating "user" changed to "group"; if not found,
2002 ignore. Also ignore if the value is already set. */
2004 if (pw == NULL) break;
2005 Ustrcpy(name+Ustrlen(name)-4, "group");
2006 ol2 = find_option(name, oltop, last);
2007 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
2008 (ol2->type & opt_mask) == opt_expand_gid))
2010 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
2013 if (data_block == NULL)
2014 *((gid_t *)(ol2->value)) = pw->pw_gid;
2016 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
2022 /* If it was an expanded gid, see if there is any expansion to be
2023 done by checking for the presence of a $ character. If there is, save it
2024 in the corresponding *expand_user option field. Otherwise, fall through
2025 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
2028 case opt_expand_gid:
2029 sprintf(CS name2, "*expand_%.50s", name);
2030 ol2 = find_option(name2, oltop, last);
2033 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
2035 if (data_block == NULL)
2036 *((uschar **)(ol2->value)) = ss;
2038 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
2042 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2048 /* Handle freestanding gid */
2051 if (!route_findgroup(sptr, &gid))
2052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2053 if (data_block == NULL)
2054 *((gid_t *)(ol->value)) = gid;
2056 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
2057 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2060 /* If it was a uid list, look up each individual entry, and build
2061 a vector of uids, with a count in the first element. Put the vector
2062 in malloc store so we can free the string. (We are reading into
2063 permanent store already.) */
2071 const uschar *op = expand_string (sptr);
2074 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2075 name, expand_string_message);
2078 if (*p != 0) count++;
2079 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2080 list = store_malloc(count*sizeof(uid_t));
2081 list[ptr++] = (uid_t)(count - 1);
2083 if (data_block == NULL)
2084 *((uid_t **)(ol->value)) = list;
2086 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2092 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2093 if (!route_finduser(big_buffer, NULL, &uid))
2094 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2101 /* If it was a gid list, look up each individual entry, and build
2102 a vector of gids, with a count in the first element. Put the vector
2103 in malloc store so we can free the string. (We are reading into permanent
2112 const uschar *op = expand_string (sptr);
2115 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2116 name, expand_string_message);
2119 if (*p != 0) count++;
2120 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2121 list = store_malloc(count*sizeof(gid_t));
2122 list[ptr++] = (gid_t)(count - 1);
2124 if (data_block == NULL)
2125 *((gid_t **)(ol->value)) = list;
2127 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2133 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2134 if (!route_findgroup(big_buffer, &gid))
2135 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2143 /* Release store if the value of the string doesn't need to be kept. */
2145 if (freesptr) store_reset(reset_point);
2148 /* Expanded boolean: if no characters follow, or if there are no dollar
2149 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2150 save the string for later expansion in the alternate place. */
2152 case opt_expand_bool:
2153 if (*s != 0 && Ustrchr(s, '$') != 0)
2155 sprintf(CS name2, "*expand_%.50s", name);
2156 ol2 = find_option(name2, oltop, last);
2159 reset_point = sptr = read_string(s, name);
2160 if (data_block == NULL)
2161 *((uschar **)(ol2->value)) = sptr;
2163 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
2170 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2171 look for yes/not/true/false. Some booleans are stored in a single bit in
2172 a single int. There's a special fudge for verify settings; without a suffix
2173 they set both xx_sender and xx_recipient. The table points to the sender
2174 value; search subsequently for the recipient. There's another special case:
2175 opt_bool_set also notes when a boolean has been set. */
2179 case opt_bool_verify:
2183 s = readconf_readname(name2, 64, s);
2184 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2186 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2188 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2189 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2190 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2191 US"for boolean option ", name);
2194 /* Handle single-bit type. */
2196 if (type == opt_bit)
2198 int bit = 1 << ((ol->type >> 16) & 31);
2199 int *ptr = (data_block == NULL)?
2200 (int *)(ol->value) :
2201 (int *)((uschar *)data_block + (long int)ol->value);
2202 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2206 /* Handle full BOOL types */
2208 if (data_block == NULL)
2209 *((BOOL *)(ol->value)) = boolvalue;
2211 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
2215 if (type == opt_bool_verify)
2217 sprintf(CS name2, "%.50s_recipient", name + offset);
2218 ol2 = find_option(name2, oltop, last);
2221 if (data_block == NULL)
2222 *((BOOL *)(ol2->value)) = boolvalue;
2224 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
2228 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2230 else if (type == opt_bool_set)
2232 sprintf(CS name2, "*set_%.50s", name + offset);
2233 ol2 = find_option(name2, oltop, last);
2236 if (data_block == NULL)
2237 *((BOOL *)(ol2->value)) = TRUE;
2239 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
2248 inttype = US"octal ";
2250 /* Integer: a simple(ish) case; allow octal and hex formats, and
2251 suffixes K, M and G. The different types affect output, not input. */
2260 lvalue = strtol(CS s, CSS &endptr, intbase);
2263 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2266 if (errno != ERANGE)
2267 if (tolower(*endptr) == 'k')
2269 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2270 else lvalue *= 1024;
2273 else if (tolower(*endptr) == 'm')
2275 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2277 else lvalue *= 1024*1024;
2280 else if (tolower(*endptr) == 'g')
2282 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2284 else lvalue *= 1024*1024*1024;
2288 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2289 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2290 "absolute value of integer \"%s\" is too large (overflow)", s);
2292 while (isspace(*endptr)) endptr++;
2294 extra_chars_error(endptr, inttype, US"integer value for ", name);
2296 value = (int)lvalue;
2299 if (data_block == NULL)
2300 *((int *)(ol->value)) = value;
2302 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2305 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2307 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2313 value = strtol(CS s, CSS &endptr, intbase);
2316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2319 if (errno != ERANGE)
2320 if (tolower(*endptr) == 'g')
2322 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2328 else if (tolower(*endptr) == 'm')
2330 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2336 else if (tolower(*endptr) == 'k')
2339 value = (value + 512)/1024;
2341 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2342 "absolute value of integer \"%s\" is too large (overflow)", s);
2344 while (isspace(*endptr)) endptr++;
2346 extra_chars_error(endptr, inttype, US"integer value for ", name);
2349 if (data_block == NULL)
2350 *((int *)(ol->value)) = value;
2352 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2355 /* Fixed-point number: held to 3 decimal places. */
2358 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2359 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2360 "fixed-point number expected for %s", name);
2362 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2363 "integer \"%s\" is too large (overflow)", s);
2367 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2368 "integer \"%s\" is too large (overflow)", s);
2370 /* We get a coverity error here for using count, as it derived
2371 from the tainted buffer pointed to by s, as parsed by sscanf().
2372 By the definition of sscanf we must be accessing between start
2373 and end of s (assuming it is nul-terminated...) so ignore the error. */
2374 /* coverity[tainted_data] */
2375 if (s[count] == '.')
2378 while (isdigit(s[++count]))
2380 value += (s[count] - '0') * d;
2385 while (isspace(s[count])) count++;
2388 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2390 if (data_block == NULL)
2391 *((int *)(ol->value)) = value;
2393 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2396 /* There's a special routine to read time values. */
2399 value = readconf_readtime(s, 0, FALSE);
2401 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2403 if (data_block == NULL)
2404 *((int *)(ol->value)) = value;
2406 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2409 /* A time list is a list of colon-separated times, with the first
2410 element holding the size of the list and the second the number of
2416 int *list = (data_block == NULL)?
2417 (int *)(ol->value) :
2418 (int *)((uschar *)data_block + (long int)(ol->value));
2420 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2423 uschar *snext = Ustrchr(s, ':');
2427 while (ss > s && isspace(ss[-1])) ss--;
2430 value = readconf_readtime(s, terminator, FALSE);
2432 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2434 if (count > 1 && value <= list[count])
2435 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2436 "time value out of order for %s", name);
2437 list[count+1] = value;
2438 if (snext == NULL) break;
2440 while (isspace(*s)) s++;
2443 if (count > list[0] - 2)
2444 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2446 if (count > 0 && list[2] == 0) count = 0;
2453 void (*fn)() = ol->value;
2464 /*************************************************
2465 * Print a time value *
2466 *************************************************/
2469 Argument: a time value in seconds
2470 Returns: pointer to a fixed buffer containing the time as a string,
2471 in readconf_readtime() format
2475 readconf_printtime(int t)
2478 uschar *p = time_buffer;
2495 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2496 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2497 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2498 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2499 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2506 /*************************************************
2507 * Print an individual option value *
2508 *************************************************/
2510 /* This is used by the -bP option, so prints to the standard output.
2511 The entire options list is passed in as an argument, because some options come
2512 in pairs - typically uid/gid settings, which can either be explicit numerical
2513 values, or strings to be expanded later. If the numerical value is unset,
2514 search for "*expand_<name>" to see if there is a string equivalent.
2517 ol option entry, or NULL for an unknown option
2519 options_block NULL for main configuration options; otherwise points to
2520 a driver block; if the option doesn't have opt_public
2521 set, then options_block->options_block is where the item
2523 oltop points to the option list in which ol exists
2524 last one more than the offset of the last entry in optop
2525 no_labels do not show "foo = " at the start.
2531 print_ol(optionlist *ol, uschar *name, void *options_block,
2532 optionlist *oltop, int last, BOOL no_labels)
2545 printf("%s is not a known option\n", name);
2549 /* Non-admin callers cannot see options that have been flagged secure by the
2552 if (!admin_user && (ol->type & opt_secure) != 0)
2555 printf("%s\n", hidden);
2557 printf("%s = %s\n", name, hidden);
2561 /* Else show the value of the option */
2564 if (options_block != NULL)
2566 if ((ol->type & opt_public) == 0)
2567 options_block = (void *)(((driver_instance *)options_block)->options_block);
2568 value = (void *)((uschar *)options_block + (long int)value);
2571 switch(ol->type & opt_mask)
2574 case opt_rewrite: /* Show the text value */
2575 s = *((uschar **)value);
2576 if (!no_labels) printf("%s = ", name);
2577 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2581 if (!no_labels) printf("%s = ", name);
2582 printf("%d\n", *((int *)value));
2587 int x = *((int *)value);
2588 if (x != 0 && (x & 1023) == 0)
2592 if ((x & 1023) == 0)
2597 if (!no_labels) printf("%s = ", name);
2598 printf("%d%c\n", x, c);
2602 if (!no_labels) printf("%s = ", name);
2610 int x = *((int *)value);
2611 if (!no_labels) printf("%s = ", name);
2612 if (x == 0) printf("0\n");
2613 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2614 else printf("%dK\n", x);
2619 if (!no_labels) printf("%s = ", name);
2620 printf("%#o\n", *((int *)value));
2623 /* Can be negative only when "unset", in which case integer */
2627 int x = *((int *)value);
2630 if (x < 0) printf("%s =\n", name); else
2632 if (!no_labels) printf("%s = ", name);
2633 printf("%d.", x/1000);
2646 /* If the numerical value is unset, try for the string value */
2648 case opt_expand_uid:
2649 if (! *get_set_flag(name, oltop, last, options_block))
2651 sprintf(CS name2, "*expand_%.50s", name);
2652 ol2 = find_option(name2, oltop, last);
2655 void *value2 = ol2->value;
2656 if (options_block != NULL)
2657 value2 = (void *)((uschar *)options_block + (long int)value2);
2658 s = *((uschar **)value2);
2659 if (!no_labels) printf("%s = ", name);
2660 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2665 /* Else fall through */
2668 if (!no_labels) printf("%s = ", name);
2669 if (! *get_set_flag(name, oltop, last, options_block))
2673 pw = getpwuid(*((uid_t *)value));
2675 printf("%ld\n", (long int)(*((uid_t *)value)));
2676 else printf("%s\n", pw->pw_name);
2680 /* If the numerical value is unset, try for the string value */
2682 case opt_expand_gid:
2683 if (! *get_set_flag(name, oltop, last, options_block))
2685 sprintf(CS name2, "*expand_%.50s", name);
2686 ol2 = find_option(name2, oltop, last);
2687 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2689 void *value2 = ol2->value;
2690 if (options_block != NULL)
2691 value2 = (void *)((uschar *)options_block + (long int)value2);
2692 s = *((uschar **)value2);
2693 if (!no_labels) printf("%s = ", name);
2694 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2699 /* Else fall through */
2702 if (!no_labels) printf("%s = ", name);
2703 if (! *get_set_flag(name, oltop, last, options_block))
2707 gr = getgrgid(*((int *)value));
2709 printf("%ld\n", (long int)(*((int *)value)));
2710 else printf("%s\n", gr->gr_name);
2715 uidlist = *((uid_t **)value);
2716 if (!no_labels) printf("%s =", name);
2717 if (uidlist != NULL)
2721 if (no_labels) sep = '\0';
2722 for (i = 1; i <= (int)(uidlist[0]); i++)
2724 uschar *name = NULL;
2725 pw = getpwuid(uidlist[i]);
2726 if (pw != NULL) name = US pw->pw_name;
2727 if (sep != '\0') printf("%c", sep);
2728 if (name != NULL) printf("%s", name);
2729 else printf("%ld", (long int)(uidlist[i]));
2737 gidlist = *((gid_t **)value);
2738 if (!no_labels) printf("%s =", name);
2739 if (gidlist != NULL)
2743 if (no_labels) sep = '\0';
2744 for (i = 1; i <= (int)(gidlist[0]); i++)
2746 uschar *name = NULL;
2747 gr = getgrgid(gidlist[i]);
2748 if (gr != NULL) name = US gr->gr_name;
2749 if (sep != '\0') printf("%c", sep);
2750 if (name != NULL) printf("%s", name);
2751 else printf("%ld", (long int)(gidlist[i]));
2759 if (!no_labels) printf("%s = ", name);
2760 printf("%s\n", readconf_printtime(*((int *)value)));
2766 int *list = (int *)value;
2767 if (!no_labels) printf("%s = ", name);
2768 for (i = 0; i < list[1]; i++)
2769 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2775 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2779 case opt_expand_bool:
2780 sprintf(CS name2, "*expand_%.50s", name);
2781 ol2 = find_option(name2, oltop, last);
2782 if (ol2 != NULL && ol2->value != NULL)
2784 void *value2 = ol2->value;
2785 if (options_block != NULL)
2786 value2 = (void *)((uschar *)options_block + (long int)value2);
2787 s = *((uschar **)value2);
2790 if (!no_labels) printf("%s = ", name);
2791 printf("%s\n", string_printing(s));
2794 /* s == NULL => string not set; fall through */
2800 case opt_bool_verify:
2802 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2809 /*************************************************
2810 * Print value from main configuration *
2811 *************************************************/
2813 /* This function, called as a result of encountering the -bP option,
2814 causes the value of any main configuration variable to be output if the
2815 second argument is NULL. There are some special values:
2817 all print all main configuration options
2818 config_file print the name of the configuration file
2819 (configure_file will still work, for backward
2821 routers print the routers' configurations
2822 transports print the transports' configuration
2823 authenticators print the authenticators' configuration
2824 macros print the macros' configuration
2825 router_list print a list of router names
2826 transport_list print a list of transport names
2827 authenticator_list print a list of authentication mechanism names
2828 macro_list print a list of macro names
2829 +name print a named list item
2830 local_scan print the local_scan options
2831 config print the configuration as it is parsed
2832 environment print the used execution environment
2834 If the second argument is not NULL, it must be one of "router", "transport",
2835 "authenticator" or "macro" in which case the first argument identifies the
2836 driver whose options are to be printed.
2839 name option name if type == NULL; else driver name
2840 type NULL or driver type name, as described above
2841 no_labels avoid the "foo = " at the start of an item
2847 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2849 BOOL names_only = FALSE;
2851 optionlist *ol2 = NULL;
2852 driver_instance *d = NULL;
2863 static uschar *types[] = { US"address", US"domain", US"host",
2865 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2866 &hostlist_anchor, &localpartlist_anchor };
2868 for (i = 0; i < 4; i++)
2870 t = tree_search(*(anchors[i]), name+1);
2875 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2877 printf("%slist %s = %s\n", types[i], name+1,
2878 ((namedlist_block *)(t->data.ptr))->string);
2883 printf("no address, domain, host, or local part list called \"%s\" "
2884 "exists\n", name+1);
2889 if ( Ustrcmp(name, "configure_file") == 0
2890 || Ustrcmp(name, "config_file") == 0)
2892 printf("%s\n", CS config_main_filename);
2896 if (Ustrcmp(name, "all") == 0)
2898 for (ol = optionlist_config;
2899 ol < optionlist_config + nelem(optionlist_config); ol++)
2901 if ((ol->type & opt_hidden) == 0)
2902 print_ol(ol, US ol->name, NULL,
2903 optionlist_config, nelem(optionlist_config),
2909 if (Ustrcmp(name, "local_scan") == 0)
2911 #ifndef LOCAL_SCAN_HAS_OPTIONS
2912 printf("local_scan() options are not supported\n");
2914 for (ol = local_scan_options;
2915 ol < local_scan_options + local_scan_options_count; ol++)
2917 print_ol(ol, US ol->name, NULL, local_scan_options,
2918 local_scan_options_count, no_labels);
2924 if (Ustrcmp(name, "config") == 0)
2926 print_config(admin_user, no_labels);
2930 if (Ustrcmp(name, "routers") == 0)
2935 else if (Ustrcmp(name, "transports") == 0)
2937 type = US"transport";
2941 else if (Ustrcmp(name, "authenticators") == 0)
2943 type = US"authenticator";
2947 else if (Ustrcmp(name, "macros") == 0)
2953 else if (Ustrcmp(name, "router_list") == 0)
2960 else if (Ustrcmp(name, "transport_list") == 0)
2962 type = US"transport";
2967 else if (Ustrcmp(name, "authenticator_list") == 0)
2969 type = US"authenticator";
2974 else if (Ustrcmp(name, "macro_list") == 0)
2981 else if (Ustrcmp(name, "environment") == 0)
2986 for (p = USS environ; *p; p++) ;
2987 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2989 for (p = USS environ; *p; p++)
2992 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
3001 print_ol(find_option(name, optionlist_config, nelem(optionlist_config)),
3002 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
3007 /* Handle the options for a router or transport. Skip options that are flagged
3008 as hidden. Some of these are options with names starting with '*', used for
3009 internal alternative representations of other options (which the printing
3010 function will sort out). Others are synonyms kept for backward compatibility.
3013 if (Ustrcmp(type, "router") == 0)
3015 d = (driver_instance *)routers;
3016 ol2 = optionlist_routers;
3017 size = optionlist_routers_size;
3019 else if (Ustrcmp(type, "transport") == 0)
3021 d = (driver_instance *)transports;
3022 ol2 = optionlist_transports;
3023 size = optionlist_transports_size;
3025 else if (Ustrcmp(type, "authenticator") == 0)
3027 d = (driver_instance *)auths;
3028 ol2 = optionlist_auths;
3029 size = optionlist_auths_size;
3032 else if (Ustrcmp(type, "macro") == 0)
3034 /* People store passwords in macros and they were previously not available
3035 for printing. So we have an admin_users restriction. */
3038 fprintf(stderr, "exim: permission denied\n");
3041 if (!macros_builtin_created) macros_create_builtin();
3042 for (m = macros; m; m = m->next)
3043 if (!name || Ustrcmp(name, m->name) == 0)
3046 printf("%s\n", CS m->name);
3048 printf("%s=%s\n", CS m->name, CS m->replacement);
3053 printf("%s %s not found\n", type, name);
3059 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
3063 /* Either search for a given driver, or print all of them */
3065 for (; d != NULL; d = d->next)
3068 printf("\n%s %s:\n", d->name, type);
3069 else if (Ustrcmp(d->name, name) != 0) continue;
3071 for (ol = ol2; ol < ol2 + size; ol++)
3073 if ((ol->type & opt_hidden) == 0)
3074 print_ol(ol, US ol->name, d, ol2, size, no_labels);
3077 for (ol = d->info->options;
3078 ol < d->info->options + *(d->info->options_count); ol++)
3080 if ((ol->type & opt_hidden) == 0)
3081 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
3083 if (name != NULL) return;
3085 if (name != NULL) printf("%s %s not found\n", type, name);
3090 /*************************************************
3091 * Read a named list item *
3092 *************************************************/
3094 /* This function reads a name and a list (i.e. string). The name is used to
3095 save the list in a tree, sorted by its name. Each entry also has a number,
3096 which can be used for caching tests, but if the string contains any expansion
3097 items other than $key, the number is set negative to inhibit caching. This
3098 mechanism is used for domain, host, and address lists that are referenced by
3102 anchorp points to the tree anchor
3103 numberp points to the current number for this tree
3104 max the maximum number permitted
3105 s the text of the option line, starting immediately after the name
3107 tname the name of the list type, for messages
3113 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3116 BOOL forcecache = FALSE;
3119 namedlist_block *nb = store_get(sizeof(namedlist_block));
3121 if (Ustrncmp(s, "_cache", 6) == 0)
3128 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3130 if (*numberp >= max)
3131 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3134 while (isspace(*s)) s++;
3136 while (isalnum(*s) || *s == '_') s++;
3137 t = store_get(sizeof(tree_node) + s-ss);
3138 Ustrncpy(t->name, ss, s-ss);
3140 while (isspace(*s)) s++;
3142 if (!tree_insertnode(anchorp, t))
3143 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3144 "duplicate name \"%s\" for a named %s", t->name, tname);
3147 nb->number = *numberp;
3150 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3151 "missing '=' after \"%s\"", t->name);
3152 while (isspace(*s)) s++;
3153 nb->string = read_string(s, t->name);
3154 nb->cache_data = NULL;
3156 /* Check the string for any expansions; if any are found, mark this list
3157 uncacheable unless the user has explicited forced caching. */
3159 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3165 /*************************************************
3166 * Unpick data for a rate limit *
3167 *************************************************/
3169 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3173 s string, in the form t,b,f,l
3174 where t is the threshold (integer)
3175 b is the initial delay (time)
3176 f is the multiplicative factor (fixed point)
3177 k is the maximum time (time)
3178 threshold where to store threshold
3179 base where to store base in milliseconds
3180 factor where to store factor in milliseconds
3181 limit where to store limit
3183 Returns: nothing (panics on error)
3187 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3190 uschar bstring[16], lstring[16];
3192 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3193 factor, lstring) == 4)
3195 *base = readconf_readtime(bstring, 0, TRUE);
3196 *limit = readconf_readtime(lstring, 0, TRUE);
3197 if (*base >= 0 && *limit >= 0) return;
3199 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3205 /*************************************************
3206 * Drop privs for checking TLS config *
3207 *************************************************/
3209 /* We want to validate TLS options during readconf, but do not want to be
3210 root when we call into the TLS library, in case of library linkage errors
3211 which cause segfaults; before this check, those were always done as the Exim
3212 runtime user and it makes sense to continue with that.
3214 Assumes: tls_require_ciphers has been set, if it will be
3215 exim_user has been set, if it will be
3216 exim_group has been set, if it will be
3218 Returns: bool for "okay"; false will cause caller to immediately exit.
3223 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3225 const uschar *errmsg;
3228 void (*oldsignal)(int);
3230 /* If TLS will never be used, no point checking ciphers */
3232 if ( !tls_advertise_hosts
3233 || !*tls_advertise_hosts
3234 || Ustrcmp(tls_advertise_hosts, ":") == 0
3237 else if (!nowarn && !tls_certificate)
3238 log_write(0, LOG_MAIN,
3239 "Warning: No server certificate defined; will use a selfsigned one.\n"
3240 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3242 oldsignal = signal(SIGCHLD, SIG_DFL);
3245 if ((pid = fork()) < 0)
3246 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3250 /* in some modes, will have dropped privilege already */
3252 exim_setugid(exim_uid, exim_gid, FALSE,
3253 US"calling tls_validate_require_cipher");
3255 if ((errmsg = tls_validate_require_cipher()))
3256 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3257 "tls_require_ciphers invalid: %s", errmsg);
3263 rc = waitpid(pid, &status, 0);
3264 } while (rc < 0 && errno == EINTR);
3267 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3270 signal(SIGCHLD, oldsignal);
3274 #endif /* SUPPORT_TLS */
3279 /*************************************************
3280 * Read main configuration options *
3281 *************************************************/
3283 /* This function is the first to be called for configuration reading. It
3284 opens the configuration file and reads general configuration settings until
3285 it reaches the end of the configuration section. The file is then left open so
3286 that the remaining configuration data can subsequently be read if needed for
3289 The configuration file must be owned either by root or exim, and be writeable
3290 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3291 in the config file, so the test is done on the compiled in values. A slight
3292 anomaly, to be carefully documented.
3294 The name of the configuration file is taken from a list that is included in the
3295 binary of Exim. It can be altered from the command line, but if that is done,
3296 root privilege is immediately withdrawn unless the caller is root or exim.
3297 The first file on the list that exists is used.
3299 For use on multiple systems that share file systems, first look for a
3300 configuration file whose name has the current node name on the end. If that is
3301 not found, try the generic name. For really contorted configurations, that run
3302 multiple Exims with different uid settings, first try adding the effective uid
3303 before the node name. These complications are going to waste resources on most
3304 systems. Therefore they are available only when requested by compile-time
3308 readconf_main(BOOL nowarn)
3311 struct stat statbuf;
3312 uschar *s, *filename;
3313 const uschar *list = config_main_filelist;
3315 /* Loop through the possible file names */
3317 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3320 /* Cut out all the fancy processing unless specifically wanted */
3322 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3323 uschar *suffix = filename + Ustrlen(filename);
3325 /* Try for the node-specific file if a node name exists */
3327 #ifdef CONFIGURE_FILE_USE_NODE
3329 if (uname(&uts) >= 0)
3331 #ifdef CONFIGURE_FILE_USE_EUID
3332 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3333 config_file = Ufopen(filename, "rb");
3334 if (config_file == NULL)
3335 #endif /* CONFIGURE_FILE_USE_EUID */
3337 sprintf(CS suffix, ".%.256s", uts.nodename);
3338 config_file = Ufopen(filename, "rb");
3341 #endif /* CONFIGURE_FILE_USE_NODE */
3343 /* Otherwise, try the generic name, possibly with the euid added */
3345 #ifdef CONFIGURE_FILE_USE_EUID
3346 if (config_file == NULL)
3348 sprintf(CS suffix, ".%ld", (long int)original_euid);
3349 config_file = Ufopen(filename, "rb");
3351 #endif /* CONFIGURE_FILE_USE_EUID */
3353 /* Finally, try the unadorned name */
3355 if (config_file == NULL)
3358 config_file = Ufopen(filename, "rb");
3360 #else /* if neither defined */
3362 /* This is the common case when the fancy processing is not included. */
3364 config_file = Ufopen(filename, "rb");
3367 /* If the file does not exist, continue to try any others. For any other
3368 error, break out (and die). */
3370 if (config_file != NULL || errno != ENOENT) break;
3373 /* On success, save the name for verification; config_filename is used when
3374 logging configuration errors (it changes for .included files) whereas
3375 config_main_filename is the name shown by -bP. Failure to open a configuration
3376 file is a serious disaster. */
3380 uschar *last_slash = Ustrrchr(filename, '/');
3381 config_filename = config_main_filename = string_copy(filename);
3383 /* The config_main_directory we need for the $config_dir expansion.
3384 config_main_filename we need for $config_file expansion.
3385 And config_dir is the directory of the current configuration, used for
3386 relative .includes. We do need to know it's name, as we change our working
3389 if (filename[0] == '/')
3390 config_main_directory = last_slash == filename ? US"/" : string_copyn(filename, last_slash - filename);
3393 /* relative configuration file name: working dir + / + basename(filename) */
3395 uschar buf[PATH_MAX];
3399 if (os_getcwd(buf, PATH_MAX) == NULL)
3401 perror("exim: getcwd");
3404 config_main_directory = string_cat(NULL, &size, &offset, buf);
3406 /* If the dir does not end with a "/", append one */
3407 if (config_main_directory[offset-1] != '/')
3408 config_main_directory = string_catn(config_main_directory, &size, &offset, US"/", 1);
3410 /* If the config file contains a "/", extract the directory part */
3412 config_main_directory = string_catn(config_main_directory, &size, &offset, filename, last_slash - filename);
3414 config_main_directory[offset] = '\0';
3416 config_directory = config_main_directory;
3420 if (filename == NULL)
3421 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3422 "%s", config_main_filelist);
3424 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3425 "configuration file %s", filename));
3428 /* Now, once we found and opened our configuration file, we change the directory
3429 to a safe place. Later we change to $spool_directory. */
3431 if (Uchdir("/") < 0)
3433 perror("exim: chdir `/': ");
3437 /* Check the status of the file we have opened, if we have retained root
3438 privileges and the file isn't /dev/null (which *should* be 0666). */
3440 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3442 if (fstat(fileno(config_file), &statbuf) != 0)
3443 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3446 if ((statbuf.st_uid != root_uid /* owner not root */
3447 #ifdef CONFIGURE_OWNER
3448 && statbuf.st_uid != config_uid /* owner not the special one */
3451 (statbuf.st_gid != root_gid /* group not root & */
3452 #ifdef CONFIGURE_GROUP
3453 && statbuf.st_gid != config_gid /* group not the special one */
3455 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3457 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3459 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3460 "wrong owner, group, or mode", big_buffer);
3463 /* Process the main configuration settings. They all begin with a lower case
3464 letter. If we see something starting with an upper case letter, it is taken as
3465 a macro definition. */
3467 while ((s = get_config_line()) != NULL)
3469 if (isupper(s[0])) read_macro_assignment(s);
3471 else if (Ustrncmp(s, "domainlist", 10) == 0)
3472 read_named_list(&domainlist_anchor, &domainlist_count,
3473 MAX_NAMED_LIST, s+10, US"domain list");
3475 else if (Ustrncmp(s, "hostlist", 8) == 0)
3476 read_named_list(&hostlist_anchor, &hostlist_count,
3477 MAX_NAMED_LIST, s+8, US"host list");
3479 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3480 read_named_list(&addresslist_anchor, &addresslist_count,
3481 MAX_NAMED_LIST, s+11, US"address list");
3483 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3484 read_named_list(&localpartlist_anchor, &localpartlist_count,
3485 MAX_NAMED_LIST, s+13, US"local part list");
3488 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3489 NULL, US"main option \"%s\" unknown");
3493 /* If local_sender_retain is set, local_from_check must be unset. */
3495 if (local_sender_retain && local_from_check)
3496 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3497 "local_sender_retain are set; this combination is not allowed");
3499 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3502 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3504 /* The max retry interval must not be greater than 24 hours. */
3506 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3508 /* remote_max_parallel must be > 0 */
3510 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3512 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3513 start of a new SMTP message. */
3515 freeze_tell_config = freeze_tell;
3517 /* The primary host name may be required for expansion of spool_directory
3518 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3519 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3520 canonize it. Some people like upper case letters in their host names, so we
3521 don't force the case. */
3523 if (primary_hostname == NULL)
3525 const uschar *hostname;
3527 if (uname(&uts) < 0)
3528 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3529 hostname = US uts.nodename;
3531 if (Ustrchr(hostname, '.') == NULL)
3534 struct hostent *hostdata;
3537 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3538 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3539 MCL_DOMAIN, TRUE, NULL) != OK))
3548 #if HAVE_GETIPNODEBYNAME
3550 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3552 hostdata = gethostbyname2(CS hostname, af);
3555 hostdata = gethostbyname(CS hostname);
3558 if (hostdata != NULL)
3560 hostname = US hostdata->h_name;
3564 if (af == AF_INET) break;
3569 primary_hostname = string_copy(hostname);
3572 /* Set up default value for smtp_active_hostname */
3574 smtp_active_hostname = primary_hostname;
3576 /* If spool_directory wasn't set in the build-time configuration, it must have
3577 got set above. Of course, writing to the log may not work if log_file_path is
3578 not set, but it will at least get to syslog or somewhere, with any luck. */
3580 if (*spool_directory == 0)
3581 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3584 /* Expand the spool directory name; it may, for example, contain the primary
3585 host name. Same comment about failure. */
3587 s = expand_string(spool_directory);
3589 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3590 "\"%s\": %s", spool_directory, expand_string_message);
3591 spool_directory = s;
3593 /* Expand log_file_path, which must contain "%s" in any component that isn't
3594 the null string or "syslog". It is also allowed to contain one instance of %D
3595 or %M. However, it must NOT contain % followed by anything else. */
3597 if (*log_file_path != 0)
3599 const uschar *ss, *sss;
3600 int sep = ':'; /* Fixed for log file path */
3601 s = expand_string(log_file_path);
3603 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3604 "\"%s\": %s", log_file_path, expand_string_message);
3607 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3610 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3611 t = Ustrstr(sss, "%s");
3613 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3614 "contain \"%%s\"", sss);
3616 t = Ustrchr(sss, '%');
3619 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3620 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3621 "unexpected \"%%\" character", s);
3628 /* Interpret syslog_facility into an integer argument for 'ident' param to
3629 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3632 if (syslog_facility_str != NULL)
3635 uschar *s = syslog_facility_str;
3637 if ((Ustrlen(syslog_facility_str) >= 4) &&
3638 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3641 for (i = 0; i < syslog_list_size; i++)
3643 if (strcmpic(s, syslog_list[i].name) == 0)
3645 syslog_facility = syslog_list[i].value;
3650 if (i >= syslog_list_size)
3652 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3653 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3657 /* Expand pid_file_path */
3659 if (*pid_file_path != 0)
3661 s = expand_string(pid_file_path);
3663 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3664 "\"%s\": %s", pid_file_path, expand_string_message);
3668 /* Set default value of process_log_path */
3670 if (process_log_path == NULL || *process_log_path =='\0')
3671 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3673 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3676 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3678 /* Unpick the SMTP rate limiting options, if set */
3680 if (smtp_ratelimit_mail != NULL)
3682 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3683 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3686 if (smtp_ratelimit_rcpt != NULL)
3688 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3689 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3692 /* The qualify domains default to the primary host name */
3694 if (qualify_domain_sender == NULL)
3695 qualify_domain_sender = primary_hostname;
3696 if (qualify_domain_recipient == NULL)
3697 qualify_domain_recipient = qualify_domain_sender;
3699 /* Setting system_filter_user in the configuration sets the gid as well if a
3700 name is given, but a numerical value does not. */
3702 if (system_filter_uid_set && !system_filter_gid_set)
3704 struct passwd *pw = getpwuid(system_filter_uid);
3706 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3707 (long int)system_filter_uid);
3708 system_filter_gid = pw->pw_gid;
3709 system_filter_gid_set = TRUE;
3712 /* If the errors_reply_to field is set, check that it is syntactically valid
3713 and ensure it contains a domain. */
3715 if (errors_reply_to != NULL)
3718 int start, end, domain;
3719 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3720 &start, &end, &domain, FALSE);
3722 if (recipient == NULL)
3723 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3724 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3727 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3728 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3731 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3732 smtp_accept_max must also be set. */
3734 if (smtp_accept_max == 0 &&
3735 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3736 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3737 "smtp_accept_max must be set if smtp_accept_queue or "
3738 "smtp_accept_max_per_host is set");
3740 /* Set up the host number if anything is specified. It is an expanded string
3741 so that it can be computed from the host name, for example. We do this last
3742 so as to ensure that everything else is set up before the expansion. */
3744 if (host_number_string != NULL)
3748 uschar *s = expand_string(host_number_string);
3750 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3751 "failed to expand localhost_number \"%s\": %s",
3752 host_number_string, expand_string_message);
3753 n = Ustrtol(s, &end, 0);
3754 while (isspace(*end)) end++;
3756 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3757 "localhost_number value is not a number: %s", s);
3758 if (n > LOCALHOST_MAX)
3759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3760 "localhost_number is greater than the maximum allowed value (%d)",
3766 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3768 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3769 tls_verify_certificates == NULL)
3770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3771 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3772 (tls_verify_hosts != NULL)? "" : "try_");
3774 /* This also checks that the library linkage is working and we can call
3775 routines in it, so call even if tls_require_ciphers is unset */
3776 if (!tls_dropprivs_validate_require_cipher(nowarn))
3779 /* Magic number: at time of writing, 1024 has been the long-standing value
3780 used by so many clients, and what Exim used to use always, that it makes
3781 sense to just min-clamp this max-clamp at that. */
3782 if (tls_dh_max_bits < 1024)
3783 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3784 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3786 /* If openssl_options is set, validate it */
3787 if (openssl_options != NULL)
3790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3791 "openssl_options is set but we're using GnuTLS");
3794 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3795 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3796 "openssl_options parse error: %s", openssl_options);
3799 #endif /*SUPPORT_TLS*/
3801 if (!nowarn && !keep_environment && environ && *environ)
3802 log_write(0, LOG_MAIN,
3803 "Warning: purging the environment.\n"
3804 " Suggested action: use keep_environment.");
3809 /*************************************************
3810 * Initialize one driver *
3811 *************************************************/
3813 /* This is called once the driver's generic options, if any, have been read.
3814 We can now find the driver, set up defaults for the private options, and
3815 unset any "set" bits in the private options table (which might have been
3816 set by another incarnation of the same driver).
3819 d pointer to driver instance block, with generic
3821 drivers_available vector of available drivers
3822 size_of_info size of each block in drivers_available
3823 class class of driver, for error message
3825 Returns: pointer to the driver info block
3828 static driver_info *
3829 init_driver(driver_instance *d, driver_info *drivers_available,
3830 int size_of_info, uschar *class)
3834 for (dd = drivers_available; dd->driver_name[0] != 0;
3835 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3837 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3840 int len = dd->options_len;
3842 d->options_block = store_get(len);
3843 memcpy(d->options_block, dd->options_block, len);
3844 for (i = 0; i < *(dd->options_count); i++)
3845 dd->options[i].type &= ~opt_set;
3850 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3851 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3853 return NULL; /* never obeyed */
3859 /*************************************************
3860 * Initialize driver list *
3861 *************************************************/
3863 /* This function is called for routers, transports, and authentication
3864 mechanisms. It reads the data from the current point in the configuration file
3865 up to the end of the section, and sets up a chain of instance blocks according
3866 to the file's contents. The file will already have been opened by a call to
3867 readconf_main, and must be left open for subsequent reading of further data.
3869 Any errors cause a panic crash. Note that the blocks with names driver_info and
3870 driver_instance must map the first portions of all the _info and _instance
3871 blocks for this shared code to work.
3874 class "router", "transport", or "authenticator"
3875 anchor &routers, &transports, &auths
3876 drivers_available available drivers
3877 size_of_info size of each info block
3878 instance_default points to default data for an instance
3879 instance_size size of instance block
3880 driver_optionlist generic option list
3881 driver_optionlist_count count of generic option list
3887 readconf_driver_init(
3889 driver_instance **anchor,
3890 driver_info *drivers_available,
3892 void *instance_default,
3894 optionlist *driver_optionlist,
3895 int driver_optionlist_count)
3897 driver_instance **p = anchor;
3898 driver_instance *d = NULL;
3901 while ((buffer = get_config_line()) != NULL)
3906 /* Read the first name on the line and test for the start of a new driver. A
3907 macro definition indicates the end of the previous driver. If this isn't the
3908 start of a new driver, the line will be re-read. */
3910 s = readconf_readname(name, sizeof(name), buffer);
3912 /* Handle macro definition, first finishing off the initialization of the
3913 previous driver, if any. */
3915 if (isupper(*name) && *s == '=')
3919 if (!d->driver_name)
3920 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3921 "no driver defined for %s \"%s\"", class, d->name);
3925 read_macro_assignment(buffer);
3929 /* If the line starts with a name terminated by a colon, we are at the
3930 start of the definition of a new driver. The rest of the line must be
3937 /* Finish off initializing the previous driver. */
3941 if (!d->driver_name)
3942 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3943 "no driver defined for %s \"%s\"", class, d->name);
3947 /* Check that we haven't already got a driver of this name */
3949 for (d = *anchor; d; d = d->next)
3950 if (Ustrcmp(name, d->name) == 0)
3951 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3952 "there are two %ss called \"%s\"", class, name);
3954 /* Set up a new driver instance data block on the chain, with
3955 its default values installed. */
3957 d = store_get(instance_size);
3958 memcpy(d, instance_default, instance_size);
3961 d->name = string_copy(name);
3963 /* Clear out the "set" bits in the generic options */
3965 for (i = 0; i < driver_optionlist_count; i++)
3966 driver_optionlist[i].type &= ~opt_set;
3968 /* Check nothing more on this line, then do the next loop iteration. */
3970 while (isspace(*s)) s++;
3971 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3975 /* Not the start of a new driver. Give an error if we have not set up a
3976 current driver yet. */
3979 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3981 /* First look to see if this is a generic option; if it is "driver",
3982 initialize the driver. If is it not a generic option, we can look for a
3983 private option provided that the driver has been previously set up. */
3985 if (readconf_handle_option(buffer, driver_optionlist,
3986 driver_optionlist_count, d, NULL))
3988 if (!d->info && d->driver_name)
3989 init_driver(d, drivers_available, size_of_info, class);
3992 /* Handle private options - pass the generic block because some may
3993 live therein. A flag with each option indicates if it is in the public
3997 readconf_handle_option(buffer, d->info->options,
3998 *(d->info->options_count), d, US"option \"%s\" unknown");
4000 /* The option is not generic and the driver name has not yet been given. */
4002 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
4003 "(\"driver\" must be specified before any private options)", name);
4006 /* Run the initialization function for the final driver. */
4010 if (!d->driver_name)
4011 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
4012 "no driver defined for %s \"%s\"", class, d->name);
4019 /*************************************************
4020 * Check driver dependency *
4021 *************************************************/
4023 /* This function is passed a driver instance and a string. It checks whether
4024 any of the string options for the driver contains the given string as an
4028 d points to a driver instance block
4029 s the string to search for
4031 Returns: TRUE if a dependency is found
4035 readconf_depends(driver_instance *d, uschar *s)
4037 int count = *(d->info->options_count);
4041 for (ol = d->info->options; ol < d->info->options + count; ol++)
4043 void *options_block;
4045 int type = ol->type & opt_mask;
4046 if (type != opt_stringptr) continue;
4047 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
4048 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
4049 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
4051 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
4052 isalnum(ss[Ustrlen(s)])) continue;
4053 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
4054 d->name, ol->name, s);
4059 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4066 /*************************************************
4067 * Decode an error type for retries *
4068 *************************************************/
4070 /* This function is global because it is also called from the main
4071 program when testing retry information. It decodes strings such as "quota_7d"
4072 into numerical error codes.
4075 pp points to start of text
4076 p points past end of text
4077 basic_errno points to an int to receive the main error number
4078 more_errno points to an int to receive the secondary error data
4080 Returns: NULL if decoded correctly; else points to error text
4084 readconf_retry_error(const uschar *pp, const uschar *p,
4085 int *basic_errno, int *more_errno)
4088 const uschar *q = pp;
4089 while (q < p && *q != '_') q++;
4092 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4094 *basic_errno = ERRNO_EXIMQUOTA;
4095 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4096 return US"bad time value";
4099 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4101 *basic_errno = ECONNREFUSED;
4104 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4105 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4106 else return US"A or MX expected after \"refused\"";
4110 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4112 *basic_errno = ETIMEDOUT;
4116 int xlen = p - q - 1;
4117 const uschar *x = q + 1;
4119 static uschar *extras[] =
4120 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4121 static int values[] =
4122 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4124 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
4125 if (strncmpic(x, extras[i], xlen) == 0)
4127 *more_errno = values[i];
4131 if (i >= sizeof(extras)/sizeof(uschar *))
4132 if (strncmpic(x, US"DNS", xlen) == 0)
4133 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4134 "available in retry rules (it has never worked) - treated as "
4137 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4141 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4142 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4143 strncmpic(pp, US"data_4", 6) == 0)
4146 int x = 255; /* means "any 4xx code" */
4147 if (p != pp + 8) bad = TRUE; else
4149 int a = pp[6], b = pp[7];
4153 if (isdigit(b)) x += b - '0';
4154 else if (b == 'x') x += 100;
4157 else if (a != 'x' || b != 'x') bad = TRUE;
4161 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4162 "x is literal and d is any digit", pp);
4164 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4165 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4166 *more_errno = x << 8;
4169 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4170 strncmpic(q+1, US"failed", p-q-1) == 0)
4171 *basic_errno = ERRNO_AUTHFAIL;
4173 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4174 *basic_errno = ERRNO_SMTPCLOSED;
4176 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4177 *basic_errno = ERRNO_TLSREQUIRED;
4179 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4180 *basic_errno = ERRNO_UNKNOWNHOST;
4182 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4183 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4191 /*************************************************
4192 * Read retry information *
4193 *************************************************/
4195 /* Each line of retry information contains:
4197 . A domain name pattern or an address pattern;
4199 . An error name, possibly with additional data, or *;
4201 . An optional sequence of retry items, each consisting of an identifying
4202 letter, a cutoff time, and optional parameters.
4204 All this is decoded and placed into a control block. */
4207 /* Subroutine to read an argument, preceded by a comma and terminated
4208 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4209 1 = fixed point number (returned *1000).
4212 paddr pointer to pointer to current character; updated
4213 type 0 => read a time; 1 => read a fixed point number
4215 Returns: time in seconds or fixed point number * 1000
4219 retry_arg(const uschar **paddr, int type)
4221 const uschar *p = *paddr;
4224 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4226 while (isspace(*p)) p++;
4228 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4230 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4231 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4236 case 0: return readconf_readtime(pp, *p, FALSE);
4237 case 1: return readconf_readfixed(pp, *p);
4239 return 0; /* Keep picky compilers happy */
4242 /* The function proper */
4245 readconf_retries(void)
4247 retry_config **chain = &retries;
4251 while ((p = get_config_line()))
4253 retry_rule **rchain;
4257 next = store_get(sizeof(retry_config));
4260 chain = &(next->next);
4261 next->basic_errno = next->more_errno = 0;
4262 next->senders = NULL;
4264 rchain = &(next->rules);
4266 next->pattern = string_dequote(&p);
4267 while (isspace(*p)) p++;
4269 while (mac_isgraph(*p)) p++;
4270 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4271 "missing error type in retry rule");
4273 /* Test error names for things we understand. */
4275 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4276 &next->more_errno)))
4277 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4279 /* There may be an optional address list of senders to be used as another
4280 constraint on the rule. This was added later, so the syntax is a bit of a
4281 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4284 while (isspace(*p)) p++;
4285 if (Ustrncmp(p, "senders", 7) == 0)
4288 while (isspace(*p)) p++;
4289 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4290 "\"=\" expected after \"senders\" in retry rule");
4291 while (isspace(*p)) p++;
4292 next->senders = string_dequote(&p);
4295 /* Now the retry rules. Keep the maximum timeout encountered. */
4297 while (isspace(*p)) p++;
4301 retry_rule *rule = store_get(sizeof(retry_rule));
4303 rchain = &(rule->next);
4305 rule->rule = toupper(*p++);
4306 rule->timeout = retry_arg(&p, 0);
4307 if (rule->timeout > retry_maximum_timeout)
4308 retry_maximum_timeout = rule->timeout;
4312 case 'F': /* Fixed interval */
4313 rule->p1 = retry_arg(&p, 0);
4316 case 'G': /* Geometrically increasing intervals */
4317 case 'H': /* Ditto, but with randomness */
4318 rule->p1 = retry_arg(&p, 0);
4319 rule->p2 = retry_arg(&p, 1);
4323 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4327 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4328 (rule->rule != 'F' && rule->p2 < 1000))
4329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4330 "bad parameters for retry rule");
4332 while (isspace(*p)) p++;
4336 while (isspace(*p)) p++;
4339 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4346 /*************************************************
4347 * Initialize authenticators *
4348 *************************************************/
4351 readconf_options_auths(void)
4353 struct auth_info * ai;
4355 readconf_options_from_list(optionlist_auths, optionlist_auths_size, US"AUTHENTICATORS", NULL);
4357 for (ai = auths_available; ai->driver_name[0]; ai++)
4359 macro_create(string_sprintf("_DRIVER_AUTHENTICATOR_%T", ai->driver_name), US"y", FALSE, TRUE);
4360 readconf_options_from_list(ai->options, (unsigned)*ai->options_count, US"AUTHENTICATOR", ai->driver_name);
4365 /* Read the authenticators section of the configuration file.
4374 auth_instance *au, *bu;
4376 readconf_driver_init(US"authenticator",
4377 (driver_instance **)(&auths), /* chain anchor */
4378 (driver_info *)auths_available, /* available drivers */
4379 sizeof(auth_info), /* size of info block */
4380 &auth_defaults, /* default values for generic options */
4381 sizeof(auth_instance), /* size of instance block */
4382 optionlist_auths, /* generic options */
4383 optionlist_auths_size);
4385 for (au = auths; au; au = au->next)
4387 if (!au->public_name)
4388 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4389 "the %s authenticator", au->name);
4391 for (bu = au->next; bu; bu = bu->next)
4392 if (strcmpic(au->public_name, bu->public_name) == 0)
4393 if ((au->client && bu->client) || (au->server && bu->server))
4394 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4395 "(%s and %s) have the same public name (%s)",
4396 au->client ? US"client" : US"server", au->name, bu->name,
4404 /*************************************************
4405 * Read ACL information *
4406 *************************************************/
4408 /* If this run of Exim is not doing something that involves receiving a
4409 message, we can just skip over the ACL information. No need to parse it.
4411 First, we have a function for acl_read() to call back to get the next line. We
4412 need to remember the line we passed, because at the end it will contain the
4413 name of the next ACL. */
4415 static uschar *acl_line;
4420 acl_line = get_config_line();
4425 /* Now the main function:
4436 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4439 acl_line = get_config_line();
4441 while(acl_line != NULL)
4447 p = readconf_readname(name, sizeof(name), acl_line);
4448 if (isupper(*name) && *p == '=')
4450 read_macro_assignment(acl_line);
4451 acl_line = get_config_line();
4455 if (*p != ':' || name[0] == 0)
4456 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4458 node = store_get(sizeof(tree_node) + Ustrlen(name));
4459 Ustrcpy(node->name, name);
4460 if (!tree_insertnode(&acl_anchor, node))
4461 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4462 "there are two ACLs called \"%s\"", name);
4464 node->data.ptr = acl_read(acl_callback, &error);
4466 if (node->data.ptr == NULL && error != NULL)
4467 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4473 /*************************************************
4474 * Read configuration for local_scan() *
4475 *************************************************/
4477 /* This function is called after "begin local_scan" is encountered in the
4478 configuration file. If the local_scan() function allows for configuration
4479 options, we can process them. Otherwise, we expire in a panic.
4486 local_scan_init(void)
4488 #ifndef LOCAL_SCAN_HAS_OPTIONS
4489 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4490 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4494 while ((p = get_config_line()) != NULL)
4496 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4497 NULL, US"local_scan option \"%s\" unknown");
4504 /*************************************************
4505 * Read rest of configuration (after main) *
4506 *************************************************/
4508 /* This function reads the rest of the runtime configuration, after the main
4509 configuration. It is called only when actually needed. Each subsequent section
4510 of the configuration starts with a line of the form
4514 where the name is "routers", "transports", etc. A section is terminated by
4515 hitting the next "begin" line, and the next name is left in next_section.
4516 Because it may confuse people as to whether the names are singular or plural,
4517 we add "s" if it's missing. There is always enough room in next_section for
4518 this. This function is basically just a switch.
4524 static uschar *section_list[] = {
4538 while(next_section[0] != 0)
4542 int last = sizeof(section_list) / sizeof(uschar *);
4544 int n = Ustrlen(next_section);
4546 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4550 int c = strcmpic(next_section, section_list[mid]);
4552 if (c > 0) first = mid + 1; else last = mid;
4554 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4555 "\"%.*s\" is not a known configuration section name", n, next_section);
4556 mid = (last + first)/2;
4560 if (((had ^= bit) & bit) == 0)
4561 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4562 "\"%.*s\" section is repeated in the configuration file", n,
4567 case 0: readconf_acl(); break;
4568 case 1: auths_init(); break;
4569 case 2: local_scan_init(); break;
4570 case 3: readconf_retries(); break;
4571 case 4: readconf_rewrites(); break;
4572 case 5: route_init(); break;
4573 case 6: transport_init(); break;
4577 (void)fclose(config_file);
4580 /* Init the storage for the pre-parsed config lines */
4582 readconf_save_config(const uschar *s)
4584 save_config_line(string_sprintf("# Exim Configuration (%s)",
4585 running_in_test_harness ? US"X" : s));
4589 save_config_position(const uschar *file, int line)
4591 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4594 /* Append a pre-parsed logical line to the config lines store,
4595 this operates on a global (static) list that holds all the pre-parsed
4596 config lines, we do no further processing here, output formatting and
4597 honouring of <hide> or macros will be done during output */
4599 save_config_line(const uschar* line)
4601 static config_line_item *current;
4602 config_line_item *next;
4604 next = (config_line_item*) store_get(sizeof(config_line_item));
4605 next->line = string_copy(line);
4608 if (!config_lines) config_lines = next;
4609 else current->next = next;
4614 /* List the parsed config lines, care about nice formatting and
4615 hide the <hide> values unless we're the admin user */
4617 print_config(BOOL admin, BOOL terse)
4619 config_line_item *i;
4620 const int TS = terse ? 0 : 2;
4623 for (i = config_lines; i; i = i->next)
4628 /* skip over to the first non-space */
4629 for (current = i->line; *current && isspace(*current); ++current)
4632 if (*current == '\0')
4635 /* Collapse runs of spaces. We stop this if we encounter one of the
4636 * following characters: "'$, as this may indicate careful formatting */
4637 for (p = current; *p; ++p)
4640 if (!isspace(*p)) continue;
4641 if (*p != ' ') *p = ' ';
4643 for (next = p; isspace(*next); ++next)
4647 memmove(p+1, next, Ustrlen(next)+1);
4649 if (*next == '"' || *next == '\'' || *next == '$')
4654 if (current[0] == '#')
4657 /* begin lines are left aligned */
4658 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4660 if (!terse) puts("");
4665 /* router/acl/transport block names */
4666 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4668 if (!terse) puts("");
4669 printf("%*s%s\n", TS, "", current);
4673 /* hidden lines (all MACROS or lines prefixed with "hide") */
4675 && ( isupper(*current)
4676 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4680 if ((p = Ustrchr(current, '=')))
4683 printf("%*s%s= %s\n", indent, "", current, hidden);
4685 /* e.g.: hide split_spool_directory */
4687 printf("%*s\n", indent, hidden);
4691 /* rest is public */
4692 printf("%*s%s\n", indent, "", current);
4698 /* End of readconf.c */