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
26 /* Structure for chain (stack) of .included files */
28 typedef struct config_file_item {
29 struct config_file_item *next;
35 /* Structure for chain of configuration lines (-bP config) */
37 typedef struct config_line_item {
38 struct config_line_item *next;
42 static config_line_item* config_lines;
44 /* Structure of table of conditional words and their state transitions */
46 typedef struct cond_item {
54 /* Structure of table of syslog facility names and values */
56 typedef struct syslog_fac_item {
62 static const char * const hidden = "<value not displayable>";
64 /* Static variables */
66 static config_file_item *config_file_stack = NULL; /* For includes */
68 static uschar *syslog_facility_str = NULL;
69 static uschar next_section[24];
70 static uschar time_buffer[24];
72 /* State variables for conditional loading (.ifdef / .else / .endif) */
74 static int cstate = 0;
75 static int cstate_stack_ptr = -1;
76 static int cstate_stack[CSTATE_STACK_SIZE];
78 /* Table of state transitions for handling conditional inclusions. There are
79 four possible state transitions:
83 .elifdef true (or .else)
86 .endif just causes the previous cstate to be popped off the stack */
88 static int next_cstate[3][4] =
90 /* State 0: reading from file, or reading until next .else or .endif */
92 /* State 1: condition failed, skipping until next .else or .endif */
94 /* State 2: skipping until .endif */
98 /* Table of conditionals and the states to set. For each name, there are four
99 values: the length of the name (to save computing it each time), the state to
100 set if a macro was found in the line, the state to set if a macro was not found
101 in the line, and a stack manipulation setting which is:
103 -1 pull state value off the stack
104 0 don't alter the stack
105 +1 push value onto stack, before setting new state
108 static cond_item cond_list[] = {
109 { US"ifdef", 5, 0, 1, 1 },
110 { US"ifndef", 6, 1, 0, 1 },
111 { US"elifdef", 7, 2, 3, 0 },
112 { US"elifndef", 8, 3, 2, 0 },
113 { US"else", 4, 2, 2, 0 },
114 { US"endif", 5, 0, 0, -1 }
117 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
119 /* Table of syslog facility names and their values */
121 static syslog_fac_item syslog_list[] = {
122 { US"mail", LOG_MAIL },
123 { US"user", LOG_USER },
124 { US"news", LOG_NEWS },
125 { US"uucp", LOG_UUCP },
126 { US"local0", LOG_LOCAL0 },
127 { US"local1", LOG_LOCAL1 },
128 { US"local2", LOG_LOCAL2 },
129 { US"local3", LOG_LOCAL3 },
130 { US"local4", LOG_LOCAL4 },
131 { US"local5", LOG_LOCAL5 },
132 { US"local6", LOG_LOCAL6 },
133 { US"local7", LOG_LOCAL7 },
134 { US"daemon", LOG_DAEMON }
137 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
142 /*************************************************
143 * Main configuration options *
144 *************************************************/
146 /* The list of options that can be set in the main configuration file. This
147 must be in alphabetic order because it is searched by binary chop. */
149 static optionlist optionlist_config[] = {
150 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
151 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
152 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
153 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
154 { "accept_8bitmime", opt_bool, &accept_8bitmime },
155 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
156 #ifdef WITH_CONTENT_SCAN
157 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
159 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
160 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
161 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
162 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
164 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
167 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
169 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
170 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
171 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
172 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
173 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
174 #ifdef WITH_CONTENT_SCAN
175 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
177 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
178 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
179 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
180 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
182 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
184 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
185 { "add_environment", opt_stringptr, &add_environment },
186 { "admin_groups", opt_gidlist, &admin_groups },
187 { "allow_domain_literals", opt_bool, &allow_domain_literals },
188 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
189 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
190 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
191 { "auto_thaw", opt_time, &auto_thaw },
192 #ifdef WITH_CONTENT_SCAN
193 { "av_scanner", opt_stringptr, &av_scanner },
195 { "bi_command", opt_stringptr, &bi_command },
196 #ifdef EXPERIMENTAL_BRIGHTMAIL
197 { "bmi_config_file", opt_stringptr, &bmi_config_file },
199 { "bounce_message_file", opt_stringptr, &bounce_message_file },
200 { "bounce_message_text", opt_stringptr, &bounce_message_text },
201 { "bounce_return_body", opt_bool, &bounce_return_body },
202 { "bounce_return_linesize_limit", opt_mkint, &bounce_return_linesize_limit },
203 { "bounce_return_message", opt_bool, &bounce_return_message },
204 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
205 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
206 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
207 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
208 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
209 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
210 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
211 { "check_log_inodes", opt_int, &check_log_inodes },
212 { "check_log_space", opt_Kint, &check_log_space },
213 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
214 { "check_spool_inodes", opt_int, &check_spool_inodes },
215 { "check_spool_space", opt_Kint, &check_spool_space },
216 { "chunking_advertise_hosts", opt_stringptr, &chunking_advertise_hosts },
217 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
218 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
219 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
220 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
221 #ifdef EXPERIMENTAL_DCC
222 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
223 { "dccifd_address", opt_stringptr, &dccifd_address },
224 { "dccifd_options", opt_stringptr, &dccifd_options },
226 { "delay_warning", opt_timelist, &delay_warning },
227 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
228 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
229 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
230 { "delivery_date_remove", opt_bool, &delivery_date_remove },
231 #ifdef ENABLE_DISABLE_FSYNC
232 { "disable_fsync", opt_bool, &disable_fsync },
234 { "disable_ipv6", opt_bool, &disable_ipv6 },
236 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
238 #ifdef EXPERIMENTAL_DMARC
239 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
240 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
241 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
243 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
244 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
245 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
246 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
247 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
248 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
249 { "dns_retrans", opt_time, &dns_retrans },
250 { "dns_retry", opt_int, &dns_retry },
251 { "dns_trust_aa", opt_stringptr, &dns_trust_aa },
252 { "dns_use_edns0", opt_int, &dns_use_edns0 },
253 /* This option is now a no-op, retained for compability */
254 { "drop_cr", opt_bool, &drop_cr },
255 /*********************************************************/
256 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
257 { "dsn_from", opt_stringptr, &dsn_from },
258 { "envelope_to_remove", opt_bool, &envelope_to_remove },
259 { "errors_copy", opt_stringptr, &errors_copy },
260 { "errors_reply_to", opt_stringptr, &errors_reply_to },
261 #ifndef DISABLE_EVENT
262 { "event_action", opt_stringptr, &event_action },
264 { "exim_group", opt_gid, &exim_gid },
265 { "exim_path", opt_stringptr, &exim_path },
266 { "exim_user", opt_uid, &exim_uid },
267 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
268 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
269 { "finduser_retries", opt_int, &finduser_retries },
270 { "freeze_tell", opt_stringptr, &freeze_tell },
271 { "gecos_name", opt_stringptr, &gecos_name },
272 { "gecos_pattern", opt_stringptr, &gecos_pattern },
274 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
275 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
277 { "header_line_maxsize", opt_int, &header_line_maxsize },
278 { "header_maxsize", opt_int, &header_maxsize },
279 { "headers_charset", opt_stringptr, &headers_charset },
280 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
281 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
282 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
283 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
284 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
285 { "hold_domains", opt_stringptr, &hold_domains },
286 { "host_lookup", opt_stringptr, &host_lookup },
287 { "host_lookup_order", opt_stringptr, &host_lookup_order },
288 { "host_reject_connection", opt_stringptr, &host_reject_connection },
289 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
291 { "hosts_proxy", opt_stringptr, &hosts_proxy },
293 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
295 { "ibase_servers", opt_stringptr, &ibase_servers },
297 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
298 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
299 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
300 { "keep_environment", opt_stringptr, &keep_environment },
301 { "keep_malformed", opt_time, &keep_malformed },
303 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
304 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
305 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
306 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
307 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
308 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
309 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
310 { "ldap_start_tls", opt_bool, &eldap_start_tls },
311 { "ldap_version", opt_int, &eldap_version },
313 { "local_from_check", opt_bool, &local_from_check },
314 { "local_from_prefix", opt_stringptr, &local_from_prefix },
315 { "local_from_suffix", opt_stringptr, &local_from_suffix },
316 { "local_interfaces", opt_stringptr, &local_interfaces },
317 { "local_scan_timeout", opt_time, &local_scan_timeout },
318 { "local_sender_retain", opt_bool, &local_sender_retain },
319 { "localhost_number", opt_stringptr, &host_number_string },
320 { "log_file_path", opt_stringptr, &log_file_path },
321 { "log_selector", opt_stringptr, &log_selector_string },
322 { "log_timezone", opt_bool, &log_timezone },
323 { "lookup_open_max", opt_int, &lookup_open_max },
324 { "max_username_length", opt_int, &max_username_length },
325 { "message_body_newlines", opt_bool, &message_body_newlines },
326 { "message_body_visible", opt_mkint, &message_body_visible },
327 { "message_id_header_domain", opt_stringptr, &message_id_domain },
328 { "message_id_header_text", opt_stringptr, &message_id_text },
329 { "message_logs", opt_bool, &message_logs },
330 { "message_size_limit", opt_stringptr, &message_size_limit },
331 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
332 { "move_frozen_messages", opt_bool, &move_frozen_messages },
334 { "mua_wrapper", opt_bool, &mua_wrapper },
336 { "mysql_servers", opt_stringptr, &mysql_servers },
338 { "never_users", opt_uidlist, &never_users },
340 { "openssl_options", opt_stringptr, &openssl_options },
343 { "oracle_servers", opt_stringptr, &oracle_servers },
345 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
347 { "perl_at_start", opt_bool, &opt_perl_at_start },
348 { "perl_startup", opt_stringptr, &opt_perl_startup },
349 { "perl_taintmode", opt_bool, &opt_perl_taintmode },
352 { "pgsql_servers", opt_stringptr, &pgsql_servers },
354 { "pid_file_path", opt_stringptr, &pid_file_path },
355 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
357 { "prdr_enable", opt_bool, &prdr_enable },
359 { "preserve_message_logs", opt_bool, &preserve_message_logs },
360 { "primary_hostname", opt_stringptr, &primary_hostname },
361 { "print_topbitchars", opt_bool, &print_topbitchars },
362 { "process_log_path", opt_stringptr, &process_log_path },
363 { "prod_requires_admin", opt_bool, &prod_requires_admin },
364 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
365 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
366 { "queue_domains", opt_stringptr, &queue_domains },
367 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
368 { "queue_only", opt_bool, &queue_only },
369 { "queue_only_file", opt_stringptr, &queue_only_file },
370 { "queue_only_load", opt_fixed, &queue_only_load },
371 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
372 { "queue_only_override", opt_bool, &queue_only_override },
373 { "queue_run_in_order", opt_bool, &queue_run_in_order },
374 { "queue_run_max", opt_stringptr, &queue_run_max },
375 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
376 { "receive_timeout", opt_time, &receive_timeout },
377 { "received_header_text", opt_stringptr, &received_header_text },
378 { "received_headers_max", opt_int, &received_headers_max },
379 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
380 { "recipients_max", opt_int, &recipients_max },
381 { "recipients_max_reject", opt_bool, &recipients_max_reject },
383 { "redis_servers", opt_stringptr, &redis_servers },
385 { "remote_max_parallel", opt_int, &remote_max_parallel },
386 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
387 { "retry_data_expire", opt_time, &retry_data_expire },
388 { "retry_interval_max", opt_time, &retry_interval_max },
389 { "return_path_remove", opt_bool, &return_path_remove },
390 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
391 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
392 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
393 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
394 { "slow_lookup_log", opt_int, &slow_lookup_log },
395 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
396 { "smtp_accept_max", opt_int, &smtp_accept_max },
397 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
398 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
399 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
400 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
401 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
402 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
403 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
404 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
405 { "smtp_banner", opt_stringptr, &smtp_banner },
406 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
407 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
408 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
409 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
410 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
411 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
412 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
413 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
414 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
415 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
416 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
417 { "smtp_receive_timeout", opt_func, &fn_smtp_receive_timeout },
418 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
419 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
421 { "smtputf8_advertise_hosts", opt_stringptr, &smtputf8_advertise_hosts },
423 #ifdef WITH_CONTENT_SCAN
424 { "spamd_address", opt_stringptr, &spamd_address },
426 #ifdef EXPERIMENTAL_SPF
427 { "spf_guess", opt_stringptr, &spf_guess },
429 { "split_spool_directory", opt_bool, &split_spool_directory },
430 { "spool_directory", opt_stringptr, &spool_directory },
432 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
434 #ifdef EXPERIMENTAL_SRS
435 { "srs_config", opt_stringptr, &srs_config },
436 { "srs_hashlength", opt_int, &srs_hashlength },
437 { "srs_hashmin", opt_int, &srs_hashmin },
438 { "srs_maxage", opt_int, &srs_maxage },
439 { "srs_secrets", opt_stringptr, &srs_secrets },
440 { "srs_usehash", opt_bool, &srs_usehash },
441 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
443 { "strict_acl_vars", opt_bool, &strict_acl_vars },
444 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
445 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
446 { "syslog_duplication", opt_bool, &syslog_duplication },
447 { "syslog_facility", opt_stringptr, &syslog_facility_str },
448 { "syslog_pid", opt_bool, &syslog_pid },
449 { "syslog_processname", opt_stringptr, &syslog_processname },
450 { "syslog_timestamp", opt_bool, &syslog_timestamp },
451 { "system_filter", opt_stringptr, &system_filter },
452 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
453 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
454 { "system_filter_group", opt_gid, &system_filter_gid },
455 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
456 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
457 { "system_filter_user", opt_uid, &system_filter_uid },
458 { "tcp_nodelay", opt_bool, &tcp_nodelay },
459 #ifdef USE_TCP_WRAPPERS
460 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
462 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
463 { "timezone", opt_stringptr, &timezone_string },
464 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
466 { "tls_certificate", opt_stringptr, &tls_certificate },
467 { "tls_crl", opt_stringptr, &tls_crl },
468 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
469 { "tls_dhparam", opt_stringptr, &tls_dhparam },
470 { "tls_eccurve", opt_stringptr, &tls_eccurve },
471 # ifndef DISABLE_OCSP
472 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
474 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
475 { "tls_privatekey", opt_stringptr, &tls_privatekey },
476 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
477 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
478 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
479 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
480 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
482 { "trusted_groups", opt_gidlist, &trusted_groups },
483 { "trusted_users", opt_uidlist, &trusted_users },
484 { "unknown_login", opt_stringptr, &unknown_login },
485 { "unknown_username", opt_stringptr, &unknown_username },
486 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
487 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
488 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
489 { "warn_message_file", opt_stringptr, &warn_message_file },
490 { "write_rejectlog", opt_bool, &write_rejectlog }
493 static int optionlist_config_size = nelem(optionlist_config);
497 /*************************************************
498 * Find the name of an option *
499 *************************************************/
501 /* This function is to aid debugging. Various functions take arguments that are
502 pointer variables in the options table or in option tables for various drivers.
503 For debugging output, it is useful to be able to find the name of the option
504 which is currently being processed. This function finds it, if it exists, by
505 searching the table(s).
507 Arguments: a value that is presumed to be in the table above
508 Returns: the option name, or an empty string
512 readconf_find_option(void *p)
516 transport_instance *t;
518 for (i = 0; i < nelem(optionlist_config); i++)
519 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
521 for (r = routers; r; r = r->next)
523 router_info *ri = r->info;
524 for (i = 0; i < *ri->options_count; i++)
526 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
527 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
528 return US ri->options[i].name;
532 for (t = transports; t; t = t->next)
534 transport_info *ti = t->info;
535 for (i = 0; i < *ti->options_count; i++)
537 optionlist * op = &ti->options[i];
538 if ((op->type & opt_mask) != opt_stringptr) continue;
539 if (p == ( op->type & opt_public
541 : (char *)t->options_block
543 + (long int)op->value)
554 /*************************************************
555 * Deal with an assignment to a macro *
556 *************************************************/
558 /* We have a new definition. The macro_item structure includes a final vector
559 called "name" which is one byte long. Thus, adding "namelen" gives us enough
560 room to store the "name" string.
561 If a builtin macro we place at head of list, else tail. This lets us lazy-create
565 macro_create(const uschar * name, const uschar * val,
566 BOOL command_line, BOOL builtin)
568 unsigned namelen = Ustrlen(name);
569 macro_item * m = store_get(sizeof(macro_item) + namelen);
571 /* fprintf(stderr, "%s: '%s' '%s'\n", __FUNCTION__, name, val) */
589 m->command_line = command_line;
590 m->namelen = namelen;
591 m->replacement = string_copy(val);
592 Ustrcpy(m->name, name);
597 /* This function is called when a line that starts with an upper case letter is
598 encountered. The argument "line" should contain a complete logical line, and
599 start with the first letter of the macro name. The macro name and the
600 replacement text are extracted and stored. Redefinition of existing,
601 non-command line, macros is permitted using '==' instead of '='.
604 s points to the start of the logical line
610 read_macro_assignment(uschar *s)
617 while (isalnum(*s) || *s == '_')
619 if (namelen >= sizeof(name) - 1)
620 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
621 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
622 name[namelen++] = *s++;
626 while (isspace(*s)) s++;
628 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
635 while (isspace(*s)) s++;
637 /* If an existing macro of the same name was defined on the command line, we
638 just skip this definition. It's an error to attempt to redefine a macro without
639 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
640 It is also an error to define a macro whose name begins with the name of a
641 previously defined macro. This is the requirement that make using a tree
642 for macros hard; we must check all macros for the substring. Perhaps a
643 sorted list, and a bsearch, would work?
644 Note: it is documented that the other way round works. */
646 for (m = macros; m; m = m->next)
648 if (Ustrcmp(m->name, name) == 0)
650 if (!m->command_line && !redef)
651 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
652 "defined (use \"==\" if you want to redefine it", name);
656 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
657 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
658 "a macro because previously defined macro \"%s\" is a substring",
661 /* We cannot have this test, because it is documented that a substring
662 macro is permitted (there is even an example).
664 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
665 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
666 * "a macro because it is a substring of previously defined macro \"%s\"",
671 /* Check for an overriding command-line definition. */
673 if (m && m->command_line) return;
675 /* Redefinition must refer to an existing macro. */
679 m->replacement = string_copy(s);
681 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
684 /* We have a new definition. */
686 (void) macro_create(name, s, FALSE, FALSE);
693 /*************************************************/
694 /* Create compile-time feature macros */
696 readconf_features(void)
698 /* Probably we could work out a static initialiser for wherever
699 macros are stored, but this will do for now. Some names are awkward
700 due to conflicts with other common macros. */
702 #ifdef SUPPORT_CRYPTEQ
703 macro_create(US"_HAVE_CRYPTEQ", US"y", FALSE, TRUE);
706 macro_create(US"_HAVE_ICONV", US"y", FALSE, TRUE);
709 macro_create(US"_HAVE_IPV6", US"y", FALSE, TRUE);
711 #ifdef HAVE_SETCLASSRESOURCES
712 macro_create(US"_HAVE_SETCLASSRESOURCES", US"y", FALSE, TRUE);
715 macro_create(US"_HAVE_PAM", US"y", FALSE, TRUE);
718 macro_create(US"_HAVE_PERL", US"y", FALSE, TRUE);
721 macro_create(US"_HAVE_DLFUNC", US"y", FALSE, TRUE);
723 #ifdef USE_TCP_WRAPPERS
724 macro_create(US"_HAVE_TCPWRAPPERS", US"y", FALSE, TRUE);
727 macro_create(US"_HAVE_TLS", US"y", FALSE, TRUE);
729 macro_create(US"_HAVE_GNUTLS", US"y", FALSE, TRUE);
731 macro_create(US"_HAVE_OPENSSL", US"y", FALSE, TRUE);
734 #ifdef SUPPORT_TRANSLATE_IP_ADDRESS
735 macro_create(US"_HAVE_TRANSLATE_IP_ADDRESS", US"y", FALSE, TRUE);
737 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
738 macro_create(US"_HAVE_MOVE_FROZEN_MESSAGES", US"y", FALSE, TRUE);
740 #ifdef WITH_CONTENT_SCAN
741 macro_create(US"_HAVE_CONTENT_SCANNING", US"y", FALSE, TRUE);
744 macro_create(US"_HAVE_DKIM", US"y", FALSE, TRUE);
746 #ifndef DISABLE_DNSSEC
747 macro_create(US"_HAVE_DNSSEC", US"y", FALSE, TRUE);
749 #ifndef DISABLE_EVENT
750 macro_create(US"_HAVE_EVENT", US"y", FALSE, TRUE);
753 macro_create(US"_HAVE_I18N", US"y", FALSE, TRUE);
756 macro_create(US"_HAVE_OCSP", US"y", FALSE, TRUE);
759 macro_create(US"_HAVE_PRDR", US"y", FALSE, TRUE);
762 macro_create(US"_HAVE_PROXY", US"y", FALSE, TRUE);
765 macro_create(US"_HAVE_SOCKS", US"y", FALSE, TRUE);
768 macro_create(US"_HAVE_TCP_FASTOPEN", US"y", FALSE, TRUE);
770 #ifdef EXPERIMENTAL_LMDB
771 macro_create(US"_HAVE_LMDB", US"y", FALSE, TRUE);
773 #ifdef EXPERIMENTAL_SPF
774 macro_create(US"_HAVE_SPF", US"y", FALSE, TRUE);
776 #ifdef EXPERIMENTAL_SRS
777 macro_create(US"_HAVE_SRS", US"y", FALSE, TRUE);
779 #ifdef EXPERIMENTAL_BRIGHTMAIL
780 macro_create(US"_HAVE_BRIGHTMAIL", US"y", FALSE, TRUE);
782 #ifdef EXPERIMENTAL_DANE
783 macro_create(US"_HAVE_DANE", US"y", FALSE, TRUE);
785 #ifdef EXPERIMENTAL_DCC
786 macro_create(US"_HAVE_DCC", US"y", FALSE, TRUE);
788 #ifdef EXPERIMENTAL_DMARC
789 macro_create(US"_HAVE_DMARC", US"y", FALSE, TRUE);
791 #ifdef EXPERIMENTAL_DSN_INFO
792 macro_create(US"_HAVE_DSN_INFO", US"y", FALSE, TRUE);
795 #ifdef LOOKUP_LSEARCH
796 macro_create(US"_HAVE_LKUP_LSEARCH", US"y", FALSE, TRUE);
799 macro_create(US"_HAVE_LKUP_CDB", US"y", FALSE, TRUE);
802 macro_create(US"_HAVE_LKUP_DBM", US"y", FALSE, TRUE);
805 macro_create(US"_HAVE_LKUP_DNSDB", US"y", FALSE, TRUE);
807 #ifdef LOOKUP_DSEARCH
808 macro_create(US"_HAVE_LKUP_DSEARCH", US"y", FALSE, TRUE);
811 macro_create(US"_HAVE_LKUP_IBASE", US"y", FALSE, TRUE);
814 macro_create(US"_HAVE_LKUP_LDAP", US"y", FALSE, TRUE);
816 #ifdef EXPERIMENTAL_LMDB
817 macro_create(US"_HAVE_LKUP_LMDB", US"y", FALSE, TRUE);
820 macro_create(US"_HAVE_LKUP_MYSQL", US"y", FALSE, TRUE);
823 macro_create(US"_HAVE_LKUP_NIS", US"y", FALSE, TRUE);
825 #ifdef LOOKUP_NISPLUS
826 macro_create(US"_HAVE_LKUP_NISPLUS", US"y", FALSE, TRUE);
829 macro_create(US"_HAVE_LKUP_ORACLE", US"y", FALSE, TRUE);
832 macro_create(US"_HAVE_LKUP_PASSWD", US"y", FALSE, TRUE);
835 macro_create(US"_HAVE_LKUP_PGSQL", US"y", FALSE, TRUE);
838 macro_create(US"_HAVE_LKUP_REDIS", US"y", FALSE, TRUE);
841 macro_create(US"_HAVE_LKUP_SQLITE", US"y", FALSE, TRUE);
844 macro_create(US"_HAVE_LKUP_TESTDB", US"y", FALSE, TRUE);
847 macro_create(US"_HAVE_LKUP_WHOSON", US"y", FALSE, TRUE);
850 #ifdef TRANSPORT_APPENDFILE
851 # ifdef SUPPORT_MAILDIR
852 macro_create(US"_HAVE_TPT_APPEND_MAILDR", US"y", FALSE, TRUE);
854 # ifdef SUPPORT_MAILSTORE
855 macro_create(US"_HAVE_TPT_APPEND_MAILSTORE", US"y", FALSE, TRUE);
858 macro_create(US"_HAVE_TPT_APPEND_MBX", US"y", FALSE, TRUE);
865 readconf_options_from_list(optionlist * opts, unsigned nopt, uschar * group)
870 /* The 'previously-defined-substring' rule for macros in config file
871 lines is done so for these builtin macros: we know that the table
872 we source from is in strict alpha order, hence the builtins portion
873 of the macros list is in reverse-alpha (we prepend them) - so longer
874 macros that have substrings are always discovered first during
877 for (i = 0; i < nopt; i++) if (*(s = opts[i].name) && *s != '*')
878 macro_create(string_sprintf("_OPT_%T_%T", group, s), US"y", FALSE, TRUE);
883 readconf_options(void)
885 readconf_options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN");
886 readconf_options_routers();
887 readconf_options_transports();
888 readconf_options_auths();
892 macros_create_builtin(void)
896 macros_builtin_created = TRUE;
900 /*************************************************
901 * Read configuration line *
902 *************************************************/
904 /* A logical line of text is read from the configuration file into the big
905 buffer, taking account of macros, .includes, and continuations. The size of
906 big_buffer is increased if necessary. The count of configuration lines is
907 maintained. Physical input lines starting with # (ignoring leading white space,
908 and after macro replacement) and empty logical lines are always ignored.
909 Leading and trailing spaces are removed.
911 If we hit a line of the form "begin xxxx", the xxxx is placed in the
912 next_section vector, and the function returns NULL, indicating the end of a
913 configuration section. On end-of-file, NULL is returned with next_section
918 Returns: a pointer to the first non-blank in the line,
919 or NULL if eof or end of section is reached
923 get_config_line(void)
925 int startoffset = 0; /* To first non-blank char in logical line */
926 int len = 0; /* Of logical line so far */
932 /* Loop for handling continuation lines, skipping comments, and dealing with
937 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
939 if (config_file_stack != NULL) /* EOF inside .include */
941 (void)fclose(config_file);
942 config_file = config_file_stack->file;
943 config_filename = config_file_stack->filename;
944 config_lineno = config_file_stack->lineno;
945 config_file_stack = config_file_stack->next;
947 save_config_position(config_filename, config_lineno);
951 /* EOF at top level */
953 if (cstate_stack_ptr >= 0)
954 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
955 "Unexpected end of configuration file: .endif missing");
957 if (len != 0) break; /* EOF after continuation */
958 next_section[0] = 0; /* EOF at start of logical line */
963 newlen = len + Ustrlen(big_buffer + len);
965 if (config_lines && config_lineno == 1)
966 save_config_position(config_filename, config_lineno);
968 /* Handle pathologically long physical lines - yes, it did happen - by
969 extending big_buffer at this point. The code also copes with very long
972 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
975 big_buffer_size += BIG_BUFFER_SIZE;
976 newbuffer = store_malloc(big_buffer_size);
978 /* This use of strcpy is OK because we know that the string in the old
979 buffer is shorter than the new buffer. */
981 Ustrcpy(newbuffer, big_buffer);
982 store_free(big_buffer);
983 big_buffer = newbuffer;
984 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
986 newlen += Ustrlen(big_buffer + newlen);
989 /* Find the true start of the physical line - leading spaces are always
992 ss = big_buffer + len;
993 while (isspace(*ss)) ss++;
995 /* Process the physical line for macros. If this is the start of the logical
996 line, skip over initial text at the start of the line if it starts with an
997 upper case character followed by a sequence of name characters and an equals
998 sign, because that is the definition of a new macro, and we don't do
999 replacement therein. */
1002 if (len == 0 && isupper(*s))
1004 while (isalnum(*s) || *s == '_') s++;
1005 while (isspace(*s)) s++;
1006 if (*s != '=') s = ss; /* Not a macro definition */
1009 /* If the builtin macros are not yet defined, and the line contains an
1010 underscrore followed by an one of the three possible chars used by
1011 builtins, create them. */
1013 if (!macros_builtin_created)
1015 const uschar * t, * p;
1017 for (t = s; (p = CUstrchr(t, '_')); t = p+1)
1018 if (c = p[1], c == 'O' || c == 'D' || c == 'H')
1020 /* fprintf(stderr, "%s: builtins create triggered by '%s'\n", __FUNCTION__, s); */
1021 macros_create_builtin();
1026 /* For each defined macro, scan the line (from after XXX= if present),
1027 replacing all occurrences of the macro. */
1029 macro_found = FALSE;
1030 for (m = macros; m; m = m->next)
1035 while ((p = Ustrstr(t, m->name)) != NULL)
1038 int replen = Ustrlen(m->replacement);
1040 /* fprintf(stderr, "%s: matched '%s' in '%s'\n", __FUNCTION__, m->name, t) */
1041 /* Expand the buffer if necessary */
1043 while (newlen - m->namelen + replen + 1 > big_buffer_size)
1045 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
1046 uschar *newbuffer = store_malloc(newsize);
1047 memcpy(newbuffer, big_buffer, newlen + 1);
1048 p = newbuffer + (p - big_buffer);
1049 s = newbuffer + (s - big_buffer);
1050 ss = newbuffer + (ss - big_buffer);
1051 t = newbuffer + (t - big_buffer);
1052 big_buffer_size = newsize;
1053 store_free(big_buffer);
1054 big_buffer = newbuffer;
1057 /* Shuffle the remaining characters up or down in the buffer before
1058 copying in the replacement text. Don't rescan the replacement for this
1061 pp = p + m->namelen;
1062 if ((moveby = replen - m->namelen) != 0)
1064 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
1067 Ustrncpy(p, m->replacement, replen);
1073 /* An empty macro replacement at the start of a line could mean that ss no
1074 longer points to the first non-blank character. */
1076 while (isspace(*ss)) ss++;
1078 /* Check for comment lines - these are physical lines. */
1080 if (*ss == '#') continue;
1082 /* Handle conditionals, which are also applied to physical lines. Conditions
1083 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1084 expansion occured on the rest of the line. A preliminary test for the leading
1085 '.' saves effort on most lines. */
1091 /* Search the list of conditional directives */
1093 for (i = 0; i < cond_list_size; i++)
1096 cond_item *c = cond_list+i;
1097 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1099 /* The following character must be white space or end of string */
1101 n = ss[1 + c->namelen];
1102 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1104 /* .ifdef and .ifndef push the current state onto the stack, then set
1105 a new one from the table. Stack overflow is an error */
1109 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1110 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1111 ".%s nested too deeply", c->name);
1112 cstate_stack[++cstate_stack_ptr] = cstate;
1113 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1116 /* For any of the others, stack underflow is an error. The next state
1117 comes either from the stack (.endif) or from the table. */
1121 if (cstate_stack_ptr < 0)
1122 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1123 ".%s without matching .ifdef", c->name);
1124 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1125 next_cstate[cstate][macro_found? c->action1 : c->action2];
1128 /* Having dealt with a directive, break the loop */
1133 /* If we have handled a conditional directive, continue with the next
1134 physical line. Otherwise, fall through. */
1136 if (i < cond_list_size) continue;
1139 /* If the conditional state is not 0 (actively using these lines), ignore
1142 if (cstate != 0) continue; /* Conditional skip */
1144 /* Handle .include lines - these are also physical lines. */
1146 if (Ustrncmp(ss, ".include", 8) == 0 &&
1148 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1151 int include_if_exists = isspace(ss[8])? 0 : 10;
1152 config_file_item *save;
1153 struct stat statbuf;
1155 ss += 9 + include_if_exists;
1156 while (isspace(*ss)) ss++;
1157 t = ss + Ustrlen(ss);
1158 while (t > ss && isspace(t[-1])) t--;
1159 if (*ss == '\"' && t[-1] == '\"')
1167 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1168 "absolute path \"%s\"", ss);
1170 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1173 save_config_position(config_filename, config_lineno);
1174 save = store_get(sizeof(config_file_item));
1175 save->next = config_file_stack;
1176 config_file_stack = save;
1177 save->file = config_file;
1178 save->filename = config_filename;
1179 save->lineno = config_lineno;
1181 if (!(config_file = Ufopen(ss, "rb")))
1182 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1183 "configuration file %s", ss);
1185 config_filename = string_copy(ss);
1190 /* If this is the start of the logical line, remember where the non-blank
1191 data starts. Otherwise shuffle down continuation lines to remove leading
1195 startoffset = ss - big_buffer;
1198 s = big_buffer + len;
1201 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1206 /* Accept the new addition to the line. Remove trailing white space. */
1209 while (len > 0 && isspace(big_buffer[len-1])) len--;
1210 big_buffer[len] = 0;
1212 /* We are done if the line does not end in backslash and contains some data.
1213 Empty logical lines are ignored. For continuations, remove the backslash and
1214 go round the loop to read the continuation line. */
1218 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1219 big_buffer[--len] = 0; /* Remove backslash */
1221 } /* Loop for reading multiple physical lines */
1223 /* We now have a logical line. Test for the end of a configuration section (or,
1224 more accurately, for the start of the next section). Place the name of the next
1225 section in next_section, and return NULL. If the name given is longer than
1226 next_section, truncate it. It will be unrecognized later, because all the known
1227 section names do fit. Leave space for pluralizing. */
1229 s = big_buffer + startoffset; /* First non-space character */
1232 save_config_line(s);
1234 if (strncmpic(s, US"begin ", 6) == 0)
1237 while (isspace(*s)) s++;
1238 if (big_buffer + len - s > sizeof(next_section) - 2)
1239 s[sizeof(next_section) - 2] = 0;
1240 Ustrcpy(next_section, s);
1244 /* Return the first non-blank character. */
1251 /*************************************************
1253 *************************************************/
1255 /* The yield is the pointer to the next uschar. Names longer than the
1256 output space are silently truncated. This function is also used from acl.c when
1260 name where to put the name
1264 Returns: new input pointer
1268 readconf_readname(uschar *name, int len, uschar *s)
1271 while (isspace(*s)) s++;
1274 while (isalnum(*s) || *s == '_')
1276 if (p < len-1) name[p++] = *s;
1281 while (isspace(*s)) s++;
1288 /*************************************************
1289 * Read a time value *
1290 *************************************************/
1292 /* This function is also called from outside, to read argument
1293 time values. The format of a time value is:
1295 [<n>w][<n>d][<n>h][<n>m][<n>s]
1297 as long as at least one is present. If a format error is encountered,
1298 return a negative value. The value must be terminated by the given
1303 terminator required terminating character
1304 return_msec if TRUE, allow fractional seconds and return milliseconds
1306 Returns: the time value, or -1 on syntax error
1307 value is seconds if return_msec is FALSE
1308 value is milliseconds if return_msec is TRUE
1312 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1320 if (!isdigit(*s)) return -1;
1321 (void)sscanf(CCS s, "%d%n", &value, &count);
1326 case 'w': value *= 7;
1327 case 'd': value *= 24;
1328 case 'h': value *= 60;
1329 case 'm': value *= 60;
1334 if (!return_msec) return -1;
1335 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1337 if (*s++ != 's') return -1;
1338 yield += (int)(fraction * 1000.0);
1344 if (return_msec) value *= 1000;
1346 if (*s == terminator) return yield;
1348 /* Control never reaches here. */
1353 /*************************************************
1354 * Read a fixed point value *
1355 *************************************************/
1357 /* The value is returned *1000
1361 terminator required terminator
1363 Returns: the value, or -1 on error
1367 readconf_readfixed(const uschar *s, int terminator)
1371 if (!isdigit(*s)) return -1;
1372 (void)sscanf(CS s, "%d%n", &value, &count);
1374 yield = value * 1000;
1378 while (isdigit((*(++s))))
1380 yield += (*s - '0') * m;
1385 return (*s == terminator)? yield : (-1);
1390 /*************************************************
1391 * Find option in list *
1392 *************************************************/
1394 /* The lists are always in order, so binary chop can be used.
1397 name the option name to search for
1398 ol the first entry in the option list
1399 last one more than the offset of the last entry in the option list
1401 Returns: pointer to an option entry, or NULL if not found
1405 find_option(uschar *name, optionlist *ol, int last)
1408 while (last > first)
1410 int middle = (first + last)/2;
1411 int c = Ustrcmp(name, ol[middle].name);
1413 if (c == 0) return ol + middle;
1414 else if (c > 0) first = middle + 1;
1422 /*************************************************
1423 * Find a set flag in option list *
1424 *************************************************/
1426 /* Because some versions of Unix make no restrictions on the values of uids and
1427 gids (even negative ones), we cannot represent "unset" by a special value.
1428 There is therefore a separate boolean variable for each one indicating whether
1429 a value is set or not. This function returns a pointer to the boolean, given
1430 the original option name. It is a major disaster if the flag cannot be found.
1433 name the name of the uid or gid option
1434 oltop points to the start of the relevant option list
1435 last one more than the offset of the last item in the option list
1436 data_block NULL when reading main options => data values in the option
1437 list are absolute addresses; otherwise they are byte offsets
1438 in data_block (used for driver options)
1440 Returns: a pointer to the boolean flag.
1444 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1448 sprintf(CS name2, "*set_%.50s", name);
1449 ol = find_option(name2, oltop, last);
1450 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1451 "Exim internal error: missing set flag for %s", name);
1452 return (data_block == NULL)? (BOOL *)(ol->value) :
1453 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1459 /*************************************************
1460 * Output extra characters message and die *
1461 *************************************************/
1463 /* Called when an option line has junk on the end. Sometimes this is because
1464 the sysadmin thinks comments are permitted.
1467 s points to the extra characters
1468 t1..t3 strings to insert in the log message
1470 Returns: doesn't return; dies
1474 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1476 uschar *comment = US"";
1477 if (*s == '#') comment = US" (# is comment only at line start)";
1478 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1479 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1484 /*************************************************
1485 * Read rewrite information *
1486 *************************************************/
1488 /* Each line of rewrite information contains:
1490 . A complete address in the form user@domain, possibly with
1491 leading * for each part; or alternatively, a regex.
1493 . A replacement string (which will be expanded).
1495 . An optional sequence of one-letter flags, indicating which
1496 headers etc. to apply this rule to.
1498 All this is decoded and placed into a control block. The OR of the flags is
1499 maintained in a common word.
1502 p points to the string that makes up the rule
1503 existflags points to the overall flag word
1504 isglobal TRUE if reading global rewrite rules
1506 Returns: the control block for the parsed rule.
1509 static rewrite_rule *
1510 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1512 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1515 next->key = string_dequote(&p);
1517 while (isspace(*p)) p++;
1519 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1520 "missing rewrite replacement string");
1523 next->replacement = string_dequote(&p);
1525 while (*p != 0) switch (*p++)
1527 case ' ': case '\t': break;
1529 case 'q': next->flags |= rewrite_quit; break;
1530 case 'w': next->flags |= rewrite_whole; break;
1532 case 'h': next->flags |= rewrite_all_headers; break;
1533 case 's': next->flags |= rewrite_sender; break;
1534 case 'f': next->flags |= rewrite_from; break;
1535 case 't': next->flags |= rewrite_to; break;
1536 case 'c': next->flags |= rewrite_cc; break;
1537 case 'b': next->flags |= rewrite_bcc; break;
1538 case 'r': next->flags |= rewrite_replyto; break;
1540 case 'E': next->flags |= rewrite_all_envelope; break;
1541 case 'F': next->flags |= rewrite_envfrom; break;
1542 case 'T': next->flags |= rewrite_envto; break;
1544 case 'Q': next->flags |= rewrite_qualify; break;
1545 case 'R': next->flags |= rewrite_repeat; break;
1548 next->flags |= rewrite_smtp;
1549 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1550 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1551 "rewrite rule has the S flag but is not a regular expression");
1555 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1556 "unknown rewrite flag character '%c' "
1557 "(could be missing quotes round replacement item)", p[-1]);
1561 /* If no action flags are set, set all the "normal" rewrites. */
1563 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1564 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1566 /* Remember which exist, for optimization, and return the rule */
1568 *existflags |= next->flags;
1575 /*************************************************
1576 * Read global rewrite information *
1577 *************************************************/
1579 /* Each line is a single rewrite rule; it is parsed into a control block
1580 by readconf_one_rewrite(), and its flags are ORed into the global flag
1581 word rewrite_existflags. */
1584 readconf_rewrites(void)
1586 rewrite_rule **chain = &global_rewrite_rules;
1589 while ((p = get_config_line()) != NULL)
1591 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1593 chain = &(next->next);
1599 /*************************************************
1601 *************************************************/
1603 /* Strings are read into the normal store pool. As long we aren't too
1604 near the end of the current block, the string will just use what is necessary
1605 on the top of the stacking pool, because string_cat() uses the extension
1609 s the rest of the input line
1610 name the option name (for errors)
1612 Returns: pointer to the string
1616 read_string(const uschar *s, const uschar *name)
1621 if (*s != '\"') return string_copy(s);
1624 yield = string_dequote(&s);
1626 if (s == ss+1 || s[-1] != '\"')
1627 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1628 "missing quote at end of string value for %s", name);
1630 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1636 /*************************************************
1637 * Custom-handler options *
1638 *************************************************/
1640 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1643 smtp_receive_timeout_s = string_copy(str);
1646 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1647 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1648 if (smtp_receive_timeout < 0)
1649 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1654 /*************************************************
1655 * Handle option line *
1656 *************************************************/
1658 /* This function is called from several places to process a line containing the
1659 setting of an option. The first argument is the line to be decoded; it has been
1660 checked not to be empty and not to start with '#'. Trailing newlines and white
1661 space have been removed. The second argument is a pointer to the list of
1662 variable names that are to be recognized, together with their types and
1663 locations, and the third argument gives the number of entries in the list.
1665 The fourth argument is a pointer to a data block. If it is NULL, then the data
1666 values in the options list are absolute addresses. Otherwise, they are byte
1667 offsets in the data block.
1669 String option data may continue onto several lines; this function reads further
1670 data from config_file if necessary.
1672 The yield of this function is normally zero. If a string continues onto
1673 multiple lines, then the data value is permitted to be followed by a comma
1674 or a semicolon (for use in drivers) and the yield is that character.
1677 buffer contains the configuration line to be handled
1678 oltop points to the start of the relevant option list
1679 last one more than the offset of the last item in the option list
1680 data_block NULL when reading main options => data values in the option
1681 list are absolute addresses; otherwise they are byte offsets
1682 in data_block when they have opt_public set; otherwise
1683 they are byte offsets in data_block->options_block.
1684 unknown_txt format string to use in panic message for unknown option;
1685 must contain %s for option name
1686 if given as NULL, don't panic on unknown option
1688 Returns: TRUE if an option was read successfully,
1689 FALSE false for an unknown option if unknown_txt == NULL,
1690 otherwise panic and die on an unknown option
1694 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1695 void *data_block, uschar *unknown_txt)
1699 int n, count, type, value;
1703 BOOL boolvalue = TRUE;
1704 BOOL freesptr = TRUE;
1705 optionlist *ol, *ol2;
1709 uschar *inttype = US"";
1712 uschar **str_target;
1716 /* There may be leading spaces; thereafter, we expect an option name starting
1719 while (isspace(*s)) s++;
1721 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1723 /* Read the name of the option, and skip any subsequent white space. If
1724 it turns out that what we read was "hide", set the flag indicating that
1725 this is a secure option, and loop to read the next word. */
1727 for (n = 0; n < 2; n++)
1729 while (isalnum(*s) || *s == '_')
1731 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1735 while (isspace(*s)) s++;
1736 if (Ustrcmp(name, "hide") != 0) break;
1737 issecure = opt_secure;
1741 /* Deal with "no_" or "not_" here for booleans */
1743 if (Ustrncmp(name, "no_", 3) == 0)
1749 if (Ustrncmp(name, "not_", 4) == 0)
1755 /* Search the list for the given name. A non-existent name, or an option that
1756 is set twice, is a disaster. */
1758 if (!(ol = find_option(name + offset, oltop, last)))
1760 if (unknown_txt == NULL) return FALSE;
1761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1764 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1765 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1766 "\"%s\" option set for the second time", name);
1768 ol->type |= opt_set | issecure;
1769 type = ol->type & opt_mask;
1771 /* Types with data values must be followed by '='; the "no[t]_" prefix
1772 applies only to boolean values. */
1774 if (type < opt_bool || type > opt_bool_last)
1777 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1778 "negation prefix applied to a non-boolean option");
1780 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1781 "unexpected end of line (data missing) after %s", name);
1783 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1786 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1787 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1788 ultimately expands to one of those values. */
1790 else if (*s != 0 && (offset != 0 || *s != '='))
1791 extra_chars_error(s, US"boolean option ", name, US"");
1793 /* Skip white space after = */
1795 if (*s == '=') while (isspace((*(++s))));
1797 /* If there is a data block and the opt_public flag is not set, change
1798 the data block pointer to the private options block. */
1800 if (data_block != NULL && (ol->type & opt_public) == 0)
1801 data_block = (void *)(((driver_instance *)data_block)->options_block);
1803 /* Now get the data according to the type. */
1807 /* If a string value is not enclosed in quotes, it consists of
1808 the rest of the current line, verbatim. Otherwise, string escapes
1811 A transport is specified as a string, which is then looked up in the
1812 list of transports. A search type is specified as one of a number of
1815 A set or rewrite rules for a driver is specified as a string, which is
1816 then parsed into a suitable chain of control blocks.
1818 Uids and gids are specified as strings which are then looked up in the
1819 passwd file. Lists of uids and gids are similarly specified as colon-
1820 separated strings. */
1825 case opt_expand_uid:
1826 case opt_expand_gid:
1831 reset_point = sptr = read_string(s, name);
1833 /* Having read a string, we now have several different ways of using it,
1834 depending on the data type, so do another switch. If keeping the actual
1835 string is not required (because it is interpreted), freesptr is set TRUE,
1836 and at the end we reset the pool. */
1840 /* If this was a string, set the variable to point to the new string,
1841 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1842 rules, we still keep the string (for printing), and parse the rules into a
1843 control block and flags word. */
1846 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1848 if (ol->type & opt_rep_con)
1850 uschar * saved_condition;
1851 /* We already have a condition, we're conducting a crude hack to let
1852 multiple condition rules be chained together, despite storing them in
1854 *str_target = string_copy_malloc( (saved_condition = *str_target)
1855 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1856 saved_condition, sptr)
1858 /* TODO(pdp): there is a memory leak here and just below
1859 when we set 3 or more conditions; I still don't
1860 understand the store mechanism enough to know
1861 what's the safe way to free content from an earlier store.
1862 AFAICT, stores stack, so freeing an early stored item also stores
1863 all data alloc'd after it. If we knew conditions were adjacent,
1864 we could survive that, but we don't. So I *think* we need to take
1865 another bit from opt_type to indicate "malloced"; this seems like
1866 quite a hack, especially for this one case. It also means that
1867 we can't ever reclaim the store from the *first* condition.
1869 Because we only do this once, near process start-up, I'm prepared to
1870 let this slide for the time being, even though it rankles. */
1872 else if (ol->type & opt_rep_str)
1874 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1875 int sep_i = -(int)sep_o;
1876 const uschar * list = sptr;
1878 uschar * list_o = *str_target;
1880 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1881 list_o = string_append_listele(list_o, sep_o, s);
1883 *str_target = string_copy_malloc(list_o);
1894 *USS (US data_block + (long int)(ol->value)) = sptr;
1896 *USS (ol->value) = sptr;
1898 if (type == opt_rewrite)
1903 rewrite_rule **chain;
1906 sprintf(CS name2, "*%.50s_rules", name);
1907 ol2 = find_option(name2, oltop, last);
1908 sprintf(CS name2, "*%.50s_flags", name);
1909 ol3 = find_option(name2, oltop, last);
1911 if (ol2 == NULL || ol3 == NULL)
1912 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1913 "rewrite rules not available for driver");
1915 if (data_block == NULL)
1917 chain = (rewrite_rule **)(ol2->value);
1918 flagptr = (int *)(ol3->value);
1922 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1923 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1926 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1928 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1930 chain = &(next->next);
1933 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1934 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1935 "non-header rewrite - not allowed at transport time -");
1939 /* If it was an expanded uid, see if there is any expansion to be
1940 done by checking for the presence of a $ character. If there is, save it
1941 in the corresponding *expand_user option field. Otherwise, fall through
1942 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1945 case opt_expand_uid:
1946 sprintf(CS name2, "*expand_%.50s", name);
1947 ol2 = find_option(name2, oltop, last);
1950 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1952 if (data_block == NULL)
1953 *((uschar **)(ol2->value)) = ss;
1955 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1959 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1965 /* Look up a fixed uid, and also make use of the corresponding gid
1966 if a passwd entry is returned and the gid has not been set. */
1969 if (!route_finduser(sptr, &pw, &uid))
1970 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1971 if (data_block == NULL)
1972 *((uid_t *)(ol->value)) = uid;
1974 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1976 /* Set the flag indicating a fixed value is set */
1978 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1980 /* Handle matching gid if we have a passwd entry: done by finding the
1981 same name with terminating "user" changed to "group"; if not found,
1982 ignore. Also ignore if the value is already set. */
1984 if (pw == NULL) break;
1985 Ustrcpy(name+Ustrlen(name)-4, "group");
1986 ol2 = find_option(name, oltop, last);
1987 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1988 (ol2->type & opt_mask) == opt_expand_gid))
1990 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1993 if (data_block == NULL)
1994 *((gid_t *)(ol2->value)) = pw->pw_gid;
1996 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
2002 /* If it was an expanded gid, see if there is any expansion to be
2003 done by checking for the presence of a $ character. If there is, save it
2004 in the corresponding *expand_user option field. Otherwise, fall through
2005 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
2008 case opt_expand_gid:
2009 sprintf(CS name2, "*expand_%.50s", name);
2010 ol2 = find_option(name2, oltop, last);
2013 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
2015 if (data_block == NULL)
2016 *((uschar **)(ol2->value)) = ss;
2018 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
2022 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2028 /* Handle freestanding gid */
2031 if (!route_findgroup(sptr, &gid))
2032 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2033 if (data_block == NULL)
2034 *((gid_t *)(ol->value)) = gid;
2036 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
2037 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2040 /* If it was a uid list, look up each individual entry, and build
2041 a vector of uids, with a count in the first element. Put the vector
2042 in malloc store so we can free the string. (We are reading into
2043 permanent store already.) */
2051 const uschar *op = expand_string (sptr);
2054 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2055 name, expand_string_message);
2058 if (*p != 0) count++;
2059 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2060 list = store_malloc(count*sizeof(uid_t));
2061 list[ptr++] = (uid_t)(count - 1);
2063 if (data_block == NULL)
2064 *((uid_t **)(ol->value)) = list;
2066 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2072 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2073 if (!route_finduser(big_buffer, NULL, &uid))
2074 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2081 /* If it was a gid list, look up each individual entry, and build
2082 a vector of gids, with a count in the first element. Put the vector
2083 in malloc store so we can free the string. (We are reading into permanent
2092 const uschar *op = expand_string (sptr);
2095 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2096 name, expand_string_message);
2099 if (*p != 0) count++;
2100 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2101 list = store_malloc(count*sizeof(gid_t));
2102 list[ptr++] = (gid_t)(count - 1);
2104 if (data_block == NULL)
2105 *((gid_t **)(ol->value)) = list;
2107 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2113 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2114 if (!route_findgroup(big_buffer, &gid))
2115 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2123 /* Release store if the value of the string doesn't need to be kept. */
2125 if (freesptr) store_reset(reset_point);
2128 /* Expanded boolean: if no characters follow, or if there are no dollar
2129 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2130 save the string for later expansion in the alternate place. */
2132 case opt_expand_bool:
2133 if (*s != 0 && Ustrchr(s, '$') != 0)
2135 sprintf(CS name2, "*expand_%.50s", name);
2136 ol2 = find_option(name2, oltop, last);
2139 reset_point = sptr = read_string(s, name);
2140 if (data_block == NULL)
2141 *((uschar **)(ol2->value)) = sptr;
2143 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
2150 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2151 look for yes/not/true/false. Some booleans are stored in a single bit in
2152 a single int. There's a special fudge for verify settings; without a suffix
2153 they set both xx_sender and xx_recipient. The table points to the sender
2154 value; search subsequently for the recipient. There's another special case:
2155 opt_bool_set also notes when a boolean has been set. */
2159 case opt_bool_verify:
2163 s = readconf_readname(name2, 64, s);
2164 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2166 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2168 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2169 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2170 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2171 US"for boolean option ", name);
2174 /* Handle single-bit type. */
2176 if (type == opt_bit)
2178 int bit = 1 << ((ol->type >> 16) & 31);
2179 int *ptr = (data_block == NULL)?
2180 (int *)(ol->value) :
2181 (int *)((uschar *)data_block + (long int)ol->value);
2182 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2186 /* Handle full BOOL types */
2188 if (data_block == NULL)
2189 *((BOOL *)(ol->value)) = boolvalue;
2191 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
2195 if (type == opt_bool_verify)
2197 sprintf(CS name2, "%.50s_recipient", name + offset);
2198 ol2 = find_option(name2, oltop, last);
2201 if (data_block == NULL)
2202 *((BOOL *)(ol2->value)) = boolvalue;
2204 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
2208 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2210 else if (type == opt_bool_set)
2212 sprintf(CS name2, "*set_%.50s", name + offset);
2213 ol2 = find_option(name2, oltop, last);
2216 if (data_block == NULL)
2217 *((BOOL *)(ol2->value)) = TRUE;
2219 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
2228 inttype = US"octal ";
2230 /* Integer: a simple(ish) case; allow octal and hex formats, and
2231 suffixes K, M and G. The different types affect output, not input. */
2240 lvalue = strtol(CS s, CSS &endptr, intbase);
2243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2246 if (errno != ERANGE)
2247 if (tolower(*endptr) == 'k')
2249 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2250 else lvalue *= 1024;
2253 else if (tolower(*endptr) == 'm')
2255 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2257 else lvalue *= 1024*1024;
2260 else if (tolower(*endptr) == 'g')
2262 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2264 else lvalue *= 1024*1024*1024;
2268 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2269 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2270 "absolute value of integer \"%s\" is too large (overflow)", s);
2272 while (isspace(*endptr)) endptr++;
2274 extra_chars_error(endptr, inttype, US"integer value for ", name);
2276 value = (int)lvalue;
2279 if (data_block == NULL)
2280 *((int *)(ol->value)) = value;
2282 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2285 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2287 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2293 value = strtol(CS s, CSS &endptr, intbase);
2296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2299 if (errno != ERANGE)
2300 if (tolower(*endptr) == 'g')
2302 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2308 else if (tolower(*endptr) == 'm')
2310 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2316 else if (tolower(*endptr) == 'k')
2319 value = (value + 512)/1024;
2321 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2322 "absolute value of integer \"%s\" is too large (overflow)", s);
2324 while (isspace(*endptr)) endptr++;
2326 extra_chars_error(endptr, inttype, US"integer value for ", name);
2329 if (data_block == NULL)
2330 *((int *)(ol->value)) = value;
2332 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2335 /* Fixed-point number: held to 3 decimal places. */
2338 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2339 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2340 "fixed-point number expected for %s", name);
2342 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2343 "integer \"%s\" is too large (overflow)", s);
2347 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2348 "integer \"%s\" is too large (overflow)", s);
2350 /* We get a coverity error here for using count, as it derived
2351 from the tainted buffer pointed to by s, as parsed by sscanf().
2352 By the definition of sscanf we must be aceessing between start
2353 and end of s (assuming it is nul-terminated...) so ignore the error. */
2354 /* coverity[tainted_data] */
2355 if (s[count] == '.')
2358 while (isdigit(s[++count]))
2360 value += (s[count] - '0') * d;
2365 while (isspace(s[count])) count++;
2368 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2370 if (data_block == NULL)
2371 *((int *)(ol->value)) = value;
2373 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2376 /* There's a special routine to read time values. */
2379 value = readconf_readtime(s, 0, FALSE);
2381 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2383 if (data_block == NULL)
2384 *((int *)(ol->value)) = value;
2386 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2389 /* A time list is a list of colon-separated times, with the first
2390 element holding the size of the list and the second the number of
2396 int *list = (data_block == NULL)?
2397 (int *)(ol->value) :
2398 (int *)((uschar *)data_block + (long int)(ol->value));
2400 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2403 uschar *snext = Ustrchr(s, ':');
2407 while (ss > s && isspace(ss[-1])) ss--;
2410 value = readconf_readtime(s, terminator, FALSE);
2412 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2414 if (count > 1 && value <= list[count])
2415 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2416 "time value out of order for %s", name);
2417 list[count+1] = value;
2418 if (snext == NULL) break;
2420 while (isspace(*s)) s++;
2423 if (count > list[0] - 2)
2424 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2426 if (count > 0 && list[2] == 0) count = 0;
2433 void (*fn)() = ol->value;
2444 /*************************************************
2445 * Print a time value *
2446 *************************************************/
2449 Argument: a time value in seconds
2450 Returns: pointer to a fixed buffer containing the time as a string,
2451 in readconf_readtime() format
2455 readconf_printtime(int t)
2458 uschar *p = time_buffer;
2475 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2476 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2477 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2478 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2479 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2486 /*************************************************
2487 * Print an individual option value *
2488 *************************************************/
2490 /* This is used by the -bP option, so prints to the standard output.
2491 The entire options list is passed in as an argument, because some options come
2492 in pairs - typically uid/gid settings, which can either be explicit numerical
2493 values, or strings to be expanded later. If the numerical value is unset,
2494 search for "*expand_<name>" to see if there is a string equivalent.
2497 ol option entry, or NULL for an unknown option
2499 options_block NULL for main configuration options; otherwise points to
2500 a driver block; if the option doesn't have opt_public
2501 set, then options_block->options_block is where the item
2503 oltop points to the option list in which ol exists
2504 last one more than the offset of the last entry in optop
2505 no_labels do not show "foo = " at the start.
2511 print_ol(optionlist *ol, uschar *name, void *options_block,
2512 optionlist *oltop, int last, BOOL no_labels)
2525 printf("%s is not a known option\n", name);
2529 /* Non-admin callers cannot see options that have been flagged secure by the
2532 if (!admin_user && (ol->type & opt_secure) != 0)
2535 printf("%s\n", hidden);
2537 printf("%s = %s\n", name, hidden);
2541 /* Else show the value of the option */
2544 if (options_block != NULL)
2546 if ((ol->type & opt_public) == 0)
2547 options_block = (void *)(((driver_instance *)options_block)->options_block);
2548 value = (void *)((uschar *)options_block + (long int)value);
2551 switch(ol->type & opt_mask)
2554 case opt_rewrite: /* Show the text value */
2555 s = *((uschar **)value);
2556 if (!no_labels) printf("%s = ", name);
2557 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2561 if (!no_labels) printf("%s = ", name);
2562 printf("%d\n", *((int *)value));
2567 int x = *((int *)value);
2568 if (x != 0 && (x & 1023) == 0)
2572 if ((x & 1023) == 0)
2577 if (!no_labels) printf("%s = ", name);
2578 printf("%d%c\n", x, c);
2582 if (!no_labels) printf("%s = ", name);
2590 int x = *((int *)value);
2591 if (!no_labels) printf("%s = ", name);
2592 if (x == 0) printf("0\n");
2593 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2594 else printf("%dK\n", x);
2599 if (!no_labels) printf("%s = ", name);
2600 printf("%#o\n", *((int *)value));
2603 /* Can be negative only when "unset", in which case integer */
2607 int x = *((int *)value);
2610 if (x < 0) printf("%s =\n", name); else
2612 if (!no_labels) printf("%s = ", name);
2613 printf("%d.", x/1000);
2626 /* If the numerical value is unset, try for the string value */
2628 case opt_expand_uid:
2629 if (! *get_set_flag(name, oltop, last, options_block))
2631 sprintf(CS name2, "*expand_%.50s", name);
2632 ol2 = find_option(name2, oltop, last);
2635 void *value2 = ol2->value;
2636 if (options_block != NULL)
2637 value2 = (void *)((uschar *)options_block + (long int)value2);
2638 s = *((uschar **)value2);
2639 if (!no_labels) printf("%s = ", name);
2640 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2645 /* Else fall through */
2648 if (!no_labels) printf("%s = ", name);
2649 if (! *get_set_flag(name, oltop, last, options_block))
2653 pw = getpwuid(*((uid_t *)value));
2655 printf("%ld\n", (long int)(*((uid_t *)value)));
2656 else printf("%s\n", pw->pw_name);
2660 /* If the numerical value is unset, try for the string value */
2662 case opt_expand_gid:
2663 if (! *get_set_flag(name, oltop, last, options_block))
2665 sprintf(CS name2, "*expand_%.50s", name);
2666 ol2 = find_option(name2, oltop, last);
2667 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2669 void *value2 = ol2->value;
2670 if (options_block != NULL)
2671 value2 = (void *)((uschar *)options_block + (long int)value2);
2672 s = *((uschar **)value2);
2673 if (!no_labels) printf("%s = ", name);
2674 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2679 /* Else fall through */
2682 if (!no_labels) printf("%s = ", name);
2683 if (! *get_set_flag(name, oltop, last, options_block))
2687 gr = getgrgid(*((int *)value));
2689 printf("%ld\n", (long int)(*((int *)value)));
2690 else printf("%s\n", gr->gr_name);
2695 uidlist = *((uid_t **)value);
2696 if (!no_labels) printf("%s =", name);
2697 if (uidlist != NULL)
2701 if (no_labels) sep = '\0';
2702 for (i = 1; i <= (int)(uidlist[0]); i++)
2704 uschar *name = NULL;
2705 pw = getpwuid(uidlist[i]);
2706 if (pw != NULL) name = US pw->pw_name;
2707 if (sep != '\0') printf("%c", sep);
2708 if (name != NULL) printf("%s", name);
2709 else printf("%ld", (long int)(uidlist[i]));
2717 gidlist = *((gid_t **)value);
2718 if (!no_labels) printf("%s =", name);
2719 if (gidlist != NULL)
2723 if (no_labels) sep = '\0';
2724 for (i = 1; i <= (int)(gidlist[0]); i++)
2726 uschar *name = NULL;
2727 gr = getgrgid(gidlist[i]);
2728 if (gr != NULL) name = US gr->gr_name;
2729 if (sep != '\0') printf("%c", sep);
2730 if (name != NULL) printf("%s", name);
2731 else printf("%ld", (long int)(gidlist[i]));
2739 if (!no_labels) printf("%s = ", name);
2740 printf("%s\n", readconf_printtime(*((int *)value)));
2746 int *list = (int *)value;
2747 if (!no_labels) printf("%s = ", name);
2748 for (i = 0; i < list[1]; i++)
2749 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2755 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2759 case opt_expand_bool:
2760 sprintf(CS name2, "*expand_%.50s", name);
2761 ol2 = find_option(name2, oltop, last);
2762 if (ol2 != NULL && ol2->value != NULL)
2764 void *value2 = ol2->value;
2765 if (options_block != NULL)
2766 value2 = (void *)((uschar *)options_block + (long int)value2);
2767 s = *((uschar **)value2);
2770 if (!no_labels) printf("%s = ", name);
2771 printf("%s\n", string_printing(s));
2774 /* s == NULL => string not set; fall through */
2780 case opt_bool_verify:
2782 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2789 /*************************************************
2790 * Print value from main configuration *
2791 *************************************************/
2793 /* This function, called as a result of encountering the -bP option,
2794 causes the value of any main configuration variable to be output if the
2795 second argument is NULL. There are some special values:
2797 all print all main configuration options
2798 config_file print the name of the configuration file
2799 (configure_file will still work, for backward
2801 routers print the routers' configurations
2802 transports print the transports' configuration
2803 authenticators print the authenticators' configuration
2804 macros print the macros' configuration
2805 router_list print a list of router names
2806 transport_list print a list of transport names
2807 authenticator_list print a list of authentication mechanism names
2808 macro_list print a list of macro names
2809 +name print a named list item
2810 local_scan print the local_scan options
2811 config print the configuration as it is parsed
2812 environment print the used execution environment
2814 If the second argument is not NULL, it must be one of "router", "transport",
2815 "authenticator" or "macro" in which case the first argument identifies the
2816 driver whose options are to be printed.
2819 name option name if type == NULL; else driver name
2820 type NULL or driver type name, as described above
2821 no_labels avoid the "foo = " at the start of an item
2827 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2829 BOOL names_only = FALSE;
2831 optionlist *ol2 = NULL;
2832 driver_instance *d = NULL;
2843 static uschar *types[] = { US"address", US"domain", US"host",
2845 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2846 &hostlist_anchor, &localpartlist_anchor };
2848 for (i = 0; i < 4; i++)
2850 t = tree_search(*(anchors[i]), name+1);
2855 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2857 printf("%slist %s = %s\n", types[i], name+1,
2858 ((namedlist_block *)(t->data.ptr))->string);
2863 printf("no address, domain, host, or local part list called \"%s\" "
2864 "exists\n", name+1);
2869 if ( Ustrcmp(name, "configure_file") == 0
2870 || Ustrcmp(name, "config_file") == 0)
2872 printf("%s\n", CS config_main_filename);
2876 if (Ustrcmp(name, "all") == 0)
2878 for (ol = optionlist_config;
2879 ol < optionlist_config + nelem(optionlist_config); ol++)
2881 if ((ol->type & opt_hidden) == 0)
2882 print_ol(ol, US ol->name, NULL,
2883 optionlist_config, nelem(optionlist_config),
2889 if (Ustrcmp(name, "local_scan") == 0)
2891 #ifndef LOCAL_SCAN_HAS_OPTIONS
2892 printf("local_scan() options are not supported\n");
2894 for (ol = local_scan_options;
2895 ol < local_scan_options + local_scan_options_count; ol++)
2897 print_ol(ol, US ol->name, NULL, local_scan_options,
2898 local_scan_options_count, no_labels);
2904 if (Ustrcmp(name, "config") == 0)
2906 print_config(admin_user, no_labels);
2910 if (Ustrcmp(name, "routers") == 0)
2915 else if (Ustrcmp(name, "transports") == 0)
2917 type = US"transport";
2921 else if (Ustrcmp(name, "authenticators") == 0)
2923 type = US"authenticator";
2927 else if (Ustrcmp(name, "macros") == 0)
2933 else if (Ustrcmp(name, "router_list") == 0)
2940 else if (Ustrcmp(name, "transport_list") == 0)
2942 type = US"transport";
2947 else if (Ustrcmp(name, "authenticator_list") == 0)
2949 type = US"authenticator";
2954 else if (Ustrcmp(name, "macro_list") == 0)
2961 else if (Ustrcmp(name, "environment") == 0)
2966 for (p = USS environ; *p; p++) ;
2967 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2969 for (p = USS environ; *p; p++)
2972 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2981 print_ol(find_option(name, optionlist_config, nelem(optionlist_config)),
2982 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2987 /* Handle the options for a router or transport. Skip options that are flagged
2988 as hidden. Some of these are options with names starting with '*', used for
2989 internal alternative representations of other options (which the printing
2990 function will sort out). Others are synonyms kept for backward compatibility.
2993 if (Ustrcmp(type, "router") == 0)
2995 d = (driver_instance *)routers;
2996 ol2 = optionlist_routers;
2997 size = optionlist_routers_size;
2999 else if (Ustrcmp(type, "transport") == 0)
3001 d = (driver_instance *)transports;
3002 ol2 = optionlist_transports;
3003 size = optionlist_transports_size;
3005 else if (Ustrcmp(type, "authenticator") == 0)
3007 d = (driver_instance *)auths;
3008 ol2 = optionlist_auths;
3009 size = optionlist_auths_size;
3012 else if (Ustrcmp(type, "macro") == 0)
3014 /* People store passwords in macros and they were previously not available
3015 for printing. So we have an admin_users restriction. */
3018 fprintf(stderr, "exim: permission denied\n");
3021 if (!macros_builtin_created) macros_create_builtin();
3022 for (m = macros; m; m = m->next)
3023 if (!name || Ustrcmp(name, m->name) == 0)
3026 printf("%s\n", CS m->name);
3028 printf("%s=%s\n", CS m->name, CS m->replacement);
3033 printf("%s %s not found\n", type, name);
3039 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
3043 /* Either search for a given driver, or print all of them */
3045 for (; d != NULL; d = d->next)
3048 printf("\n%s %s:\n", d->name, type);
3049 else if (Ustrcmp(d->name, name) != 0) continue;
3051 for (ol = ol2; ol < ol2 + size; ol++)
3053 if ((ol->type & opt_hidden) == 0)
3054 print_ol(ol, US ol->name, d, ol2, size, no_labels);
3057 for (ol = d->info->options;
3058 ol < d->info->options + *(d->info->options_count); ol++)
3060 if ((ol->type & opt_hidden) == 0)
3061 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
3063 if (name != NULL) return;
3065 if (name != NULL) printf("%s %s not found\n", type, name);
3070 /*************************************************
3071 * Read a named list item *
3072 *************************************************/
3074 /* This function reads a name and a list (i.e. string). The name is used to
3075 save the list in a tree, sorted by its name. Each entry also has a number,
3076 which can be used for caching tests, but if the string contains any expansion
3077 items other than $key, the number is set negative to inhibit caching. This
3078 mechanism is used for domain, host, and address lists that are referenced by
3082 anchorp points to the tree anchor
3083 numberp points to the current number for this tree
3084 max the maximum number permitted
3085 s the text of the option line, starting immediately after the name
3087 tname the name of the list type, for messages
3093 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3096 BOOL forcecache = FALSE;
3099 namedlist_block *nb = store_get(sizeof(namedlist_block));
3101 if (Ustrncmp(s, "_cache", 6) == 0)
3108 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3110 if (*numberp >= max)
3111 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3114 while (isspace(*s)) s++;
3116 while (isalnum(*s) || *s == '_') s++;
3117 t = store_get(sizeof(tree_node) + s-ss);
3118 Ustrncpy(t->name, ss, s-ss);
3120 while (isspace(*s)) s++;
3122 if (!tree_insertnode(anchorp, t))
3123 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3124 "duplicate name \"%s\" for a named %s", t->name, tname);
3127 nb->number = *numberp;
3130 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3131 "missing '=' after \"%s\"", t->name);
3132 while (isspace(*s)) s++;
3133 nb->string = read_string(s, t->name);
3134 nb->cache_data = NULL;
3136 /* Check the string for any expansions; if any are found, mark this list
3137 uncacheable unless the user has explicited forced caching. */
3139 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3145 /*************************************************
3146 * Unpick data for a rate limit *
3147 *************************************************/
3149 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3153 s string, in the form t,b,f,l
3154 where t is the threshold (integer)
3155 b is the initial delay (time)
3156 f is the multiplicative factor (fixed point)
3157 k is the maximum time (time)
3158 threshold where to store threshold
3159 base where to store base in milliseconds
3160 factor where to store factor in milliseconds
3161 limit where to store limit
3163 Returns: nothing (panics on error)
3167 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3170 uschar bstring[16], lstring[16];
3172 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3173 factor, lstring) == 4)
3175 *base = readconf_readtime(bstring, 0, TRUE);
3176 *limit = readconf_readtime(lstring, 0, TRUE);
3177 if (*base >= 0 && *limit >= 0) return;
3179 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3185 /*************************************************
3186 * Drop privs for checking TLS config *
3187 *************************************************/
3189 /* We want to validate TLS options during readconf, but do not want to be
3190 root when we call into the TLS library, in case of library linkage errors
3191 which cause segfaults; before this check, those were always done as the Exim
3192 runtime user and it makes sense to continue with that.
3194 Assumes: tls_require_ciphers has been set, if it will be
3195 exim_user has been set, if it will be
3196 exim_group has been set, if it will be
3198 Returns: bool for "okay"; false will cause caller to immediately exit.
3203 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3205 const uschar *errmsg;
3208 void (*oldsignal)(int);
3210 /* If TLS will never be used, no point checking ciphers */
3212 if ( !tls_advertise_hosts
3213 || !*tls_advertise_hosts
3214 || Ustrcmp(tls_advertise_hosts, ":") == 0
3217 else if (!nowarn && !tls_certificate)
3218 log_write(0, LOG_MAIN,
3219 "Warning: No server certificate defined; will use a selfsigned one.\n"
3220 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3222 oldsignal = signal(SIGCHLD, SIG_DFL);
3225 if ((pid = fork()) < 0)
3226 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3230 /* in some modes, will have dropped privilege already */
3232 exim_setugid(exim_uid, exim_gid, FALSE,
3233 US"calling tls_validate_require_cipher");
3235 errmsg = tls_validate_require_cipher();
3238 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3239 "tls_require_ciphers invalid: %s", errmsg);
3246 rc = waitpid(pid, &status, 0);
3247 } while (rc < 0 && errno == EINTR);
3250 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3253 signal(SIGCHLD, oldsignal);
3257 #endif /* SUPPORT_TLS */
3262 /*************************************************
3263 * Read main configuration options *
3264 *************************************************/
3266 /* This function is the first to be called for configuration reading. It
3267 opens the configuration file and reads general configuration settings until
3268 it reaches the end of the configuration section. The file is then left open so
3269 that the remaining configuration data can subsequently be read if needed for
3272 The configuration file must be owned either by root or exim, and be writeable
3273 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3274 in the config file, so the test is done on the compiled in values. A slight
3275 anomaly, to be carefully documented.
3277 The name of the configuration file is taken from a list that is included in the
3278 binary of Exim. It can be altered from the command line, but if that is done,
3279 root privilege is immediately withdrawn unless the caller is root or exim.
3280 The first file on the list that exists is used.
3282 For use on multiple systems that share file systems, first look for a
3283 configuration file whose name has the current node name on the end. If that is
3284 not found, try the generic name. For really contorted configurations, that run
3285 multiple Exims with different uid settings, first try adding the effective uid
3286 before the node name. These complications are going to waste resources on most
3287 systems. Therefore they are available only when requested by compile-time
3291 readconf_main(BOOL nowarn)
3294 struct stat statbuf;
3295 uschar *s, *filename;
3296 const uschar *list = config_main_filelist;
3298 /* Loop through the possible file names */
3300 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3303 /* Cut out all the fancy processing unless specifically wanted */
3305 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3306 uschar *suffix = filename + Ustrlen(filename);
3308 /* Try for the node-specific file if a node name exists */
3310 #ifdef CONFIGURE_FILE_USE_NODE
3312 if (uname(&uts) >= 0)
3314 #ifdef CONFIGURE_FILE_USE_EUID
3315 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3316 config_file = Ufopen(filename, "rb");
3317 if (config_file == NULL)
3318 #endif /* CONFIGURE_FILE_USE_EUID */
3320 sprintf(CS suffix, ".%.256s", uts.nodename);
3321 config_file = Ufopen(filename, "rb");
3324 #endif /* CONFIGURE_FILE_USE_NODE */
3326 /* Otherwise, try the generic name, possibly with the euid added */
3328 #ifdef CONFIGURE_FILE_USE_EUID
3329 if (config_file == NULL)
3331 sprintf(CS suffix, ".%ld", (long int)original_euid);
3332 config_file = Ufopen(filename, "rb");
3334 #endif /* CONFIGURE_FILE_USE_EUID */
3336 /* Finally, try the unadorned name */
3338 if (config_file == NULL)
3341 config_file = Ufopen(filename, "rb");
3343 #else /* if neither defined */
3345 /* This is the common case when the fancy processing is not included. */
3347 config_file = Ufopen(filename, "rb");
3350 /* If the file does not exist, continue to try any others. For any other
3351 error, break out (and die). */
3353 if (config_file != NULL || errno != ENOENT) break;
3356 /* Now, once we found and opened our configuration file, we change the directory
3357 to a safe place. Later we change to $spool_directory. */
3359 if (Uchdir("/") < 0)
3361 perror("exim: chdir `/': ");
3365 /* On success, save the name for verification; config_filename is used when
3366 logging configuration errors (it changes for .included files) whereas
3367 config_main_filename is the name shown by -bP. Failure to open a configuration
3368 file is a serious disaster. */
3370 if (config_file != NULL)
3373 config_filename = config_main_filename = string_copy(filename);
3375 p = Ustrrchr(filename, '/');
3376 config_main_directory = p ? string_copyn(filename, p - filename)
3377 : string_copy(US".");
3381 if (filename == NULL)
3382 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3383 "%s", config_main_filelist);
3385 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3386 "configuration file %s", filename));
3389 /* Check the status of the file we have opened, if we have retained root
3390 privileges and the file isn't /dev/null (which *should* be 0666). */
3392 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3394 if (fstat(fileno(config_file), &statbuf) != 0)
3395 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3398 if ((statbuf.st_uid != root_uid /* owner not root */
3399 #ifdef CONFIGURE_OWNER
3400 && statbuf.st_uid != config_uid /* owner not the special one */
3403 (statbuf.st_gid != root_gid /* group not root & */
3404 #ifdef CONFIGURE_GROUP
3405 && statbuf.st_gid != config_gid /* group not the special one */
3407 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3409 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3411 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3412 "wrong owner, group, or mode", big_buffer);
3415 /* Process the main configuration settings. They all begin with a lower case
3416 letter. If we see something starting with an upper case letter, it is taken as
3417 a macro definition. */
3419 while ((s = get_config_line()) != NULL)
3421 if (isupper(s[0])) read_macro_assignment(s);
3423 else if (Ustrncmp(s, "domainlist", 10) == 0)
3424 read_named_list(&domainlist_anchor, &domainlist_count,
3425 MAX_NAMED_LIST, s+10, US"domain list");
3427 else if (Ustrncmp(s, "hostlist", 8) == 0)
3428 read_named_list(&hostlist_anchor, &hostlist_count,
3429 MAX_NAMED_LIST, s+8, US"host list");
3431 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3432 read_named_list(&addresslist_anchor, &addresslist_count,
3433 MAX_NAMED_LIST, s+11, US"address list");
3435 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3436 read_named_list(&localpartlist_anchor, &localpartlist_count,
3437 MAX_NAMED_LIST, s+13, US"local part list");
3440 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3441 NULL, US"main option \"%s\" unknown");
3445 /* If local_sender_retain is set, local_from_check must be unset. */
3447 if (local_sender_retain && local_from_check)
3448 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3449 "local_sender_retain are set; this combination is not allowed");
3451 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3454 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3456 /* The max retry interval must not be greater than 24 hours. */
3458 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3460 /* remote_max_parallel must be > 0 */
3462 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3464 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3465 start of a new SMTP message. */
3467 freeze_tell_config = freeze_tell;
3469 /* The primary host name may be required for expansion of spool_directory
3470 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3471 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3472 canonize it. Some people like upper case letters in their host names, so we
3473 don't force the case. */
3475 if (primary_hostname == NULL)
3477 const uschar *hostname;
3479 if (uname(&uts) < 0)
3480 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3481 hostname = US uts.nodename;
3483 if (Ustrchr(hostname, '.') == NULL)
3486 struct hostent *hostdata;
3489 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3490 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3491 MCL_DOMAIN, TRUE, NULL) != OK))
3500 #if HAVE_GETIPNODEBYNAME
3502 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3504 hostdata = gethostbyname2(CS hostname, af);
3507 hostdata = gethostbyname(CS hostname);
3510 if (hostdata != NULL)
3512 hostname = US hostdata->h_name;
3516 if (af == AF_INET) break;
3521 primary_hostname = string_copy(hostname);
3524 /* Set up default value for smtp_active_hostname */
3526 smtp_active_hostname = primary_hostname;
3528 /* If spool_directory wasn't set in the build-time configuration, it must have
3529 got set above. Of course, writing to the log may not work if log_file_path is
3530 not set, but it will at least get to syslog or somewhere, with any luck. */
3532 if (*spool_directory == 0)
3533 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3536 /* Expand the spool directory name; it may, for example, contain the primary
3537 host name. Same comment about failure. */
3539 s = expand_string(spool_directory);
3541 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3542 "\"%s\": %s", spool_directory, expand_string_message);
3543 spool_directory = s;
3545 /* Expand log_file_path, which must contain "%s" in any component that isn't
3546 the null string or "syslog". It is also allowed to contain one instance of %D
3547 or %M. However, it must NOT contain % followed by anything else. */
3549 if (*log_file_path != 0)
3551 const uschar *ss, *sss;
3552 int sep = ':'; /* Fixed for log file path */
3553 s = expand_string(log_file_path);
3555 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3556 "\"%s\": %s", log_file_path, expand_string_message);
3559 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3562 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3563 t = Ustrstr(sss, "%s");
3565 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3566 "contain \"%%s\"", sss);
3568 t = Ustrchr(sss, '%');
3571 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3572 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3573 "unexpected \"%%\" character", s);
3580 /* Interpret syslog_facility into an integer argument for 'ident' param to
3581 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3584 if (syslog_facility_str != NULL)
3587 uschar *s = syslog_facility_str;
3589 if ((Ustrlen(syslog_facility_str) >= 4) &&
3590 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3593 for (i = 0; i < syslog_list_size; i++)
3595 if (strcmpic(s, syslog_list[i].name) == 0)
3597 syslog_facility = syslog_list[i].value;
3602 if (i >= syslog_list_size)
3604 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3605 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3609 /* Expand pid_file_path */
3611 if (*pid_file_path != 0)
3613 s = expand_string(pid_file_path);
3615 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3616 "\"%s\": %s", pid_file_path, expand_string_message);
3620 /* Set default value of process_log_path */
3622 if (process_log_path == NULL || *process_log_path =='\0')
3623 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3625 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3628 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3630 /* Unpick the SMTP rate limiting options, if set */
3632 if (smtp_ratelimit_mail != NULL)
3634 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3635 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3638 if (smtp_ratelimit_rcpt != NULL)
3640 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3641 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3644 /* The qualify domains default to the primary host name */
3646 if (qualify_domain_sender == NULL)
3647 qualify_domain_sender = primary_hostname;
3648 if (qualify_domain_recipient == NULL)
3649 qualify_domain_recipient = qualify_domain_sender;
3651 /* Setting system_filter_user in the configuration sets the gid as well if a
3652 name is given, but a numerical value does not. */
3654 if (system_filter_uid_set && !system_filter_gid_set)
3656 struct passwd *pw = getpwuid(system_filter_uid);
3658 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3659 (long int)system_filter_uid);
3660 system_filter_gid = pw->pw_gid;
3661 system_filter_gid_set = TRUE;
3664 /* If the errors_reply_to field is set, check that it is syntactically valid
3665 and ensure it contains a domain. */
3667 if (errors_reply_to != NULL)
3670 int start, end, domain;
3671 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3672 &start, &end, &domain, FALSE);
3674 if (recipient == NULL)
3675 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3676 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3679 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3680 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3683 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3684 smtp_accept_max must also be set. */
3686 if (smtp_accept_max == 0 &&
3687 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3688 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3689 "smtp_accept_max must be set if smtp_accept_queue or "
3690 "smtp_accept_max_per_host is set");
3692 /* Set up the host number if anything is specified. It is an expanded string
3693 so that it can be computed from the host name, for example. We do this last
3694 so as to ensure that everything else is set up before the expansion. */
3696 if (host_number_string != NULL)
3700 uschar *s = expand_string(host_number_string);
3702 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3703 "failed to expand localhost_number \"%s\": %s",
3704 host_number_string, expand_string_message);
3705 n = Ustrtol(s, &end, 0);
3706 while (isspace(*end)) end++;
3708 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3709 "localhost_number value is not a number: %s", s);
3710 if (n > LOCALHOST_MAX)
3711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3712 "localhost_number is greater than the maximum allowed value (%d)",
3718 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3720 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3721 tls_verify_certificates == NULL)
3722 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3723 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3724 (tls_verify_hosts != NULL)? "" : "try_");
3726 /* This also checks that the library linkage is working and we can call
3727 routines in it, so call even if tls_require_ciphers is unset */
3728 if (!tls_dropprivs_validate_require_cipher(nowarn))
3731 /* Magic number: at time of writing, 1024 has been the long-standing value
3732 used by so many clients, and what Exim used to use always, that it makes
3733 sense to just min-clamp this max-clamp at that. */
3734 if (tls_dh_max_bits < 1024)
3735 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3736 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3738 /* If openssl_options is set, validate it */
3739 if (openssl_options != NULL)
3742 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3743 "openssl_options is set but we're using GnuTLS");
3746 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3747 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3748 "openssl_options parse error: %s", openssl_options);
3751 #endif /*SUPPORT_TLS*/
3753 if (!nowarn && !keep_environment && environ && *environ)
3754 log_write(0, LOG_MAIN,
3755 "Warning: purging the environment.\n"
3756 " Suggested action: use keep_environment.");
3761 /*************************************************
3762 * Initialize one driver *
3763 *************************************************/
3765 /* This is called once the driver's generic options, if any, have been read.
3766 We can now find the driver, set up defaults for the private options, and
3767 unset any "set" bits in the private options table (which might have been
3768 set by another incarnation of the same driver).
3771 d pointer to driver instance block, with generic
3773 drivers_available vector of available drivers
3774 size_of_info size of each block in drivers_available
3775 class class of driver, for error message
3777 Returns: pointer to the driver info block
3780 static driver_info *
3781 init_driver(driver_instance *d, driver_info *drivers_available,
3782 int size_of_info, uschar *class)
3786 for (dd = drivers_available; dd->driver_name[0] != 0;
3787 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3789 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3792 int len = dd->options_len;
3794 d->options_block = store_get(len);
3795 memcpy(d->options_block, dd->options_block, len);
3796 for (i = 0; i < *(dd->options_count); i++)
3797 dd->options[i].type &= ~opt_set;
3802 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3803 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3805 return NULL; /* never obeyed */
3811 /*************************************************
3812 * Initialize driver list *
3813 *************************************************/
3815 /* This function is called for routers, transports, and authentication
3816 mechanisms. It reads the data from the current point in the configuration file
3817 up to the end of the section, and sets up a chain of instance blocks according
3818 to the file's contents. The file will already have been opened by a call to
3819 readconf_main, and must be left open for subsequent reading of further data.
3821 Any errors cause a panic crash. Note that the blocks with names driver_info and
3822 driver_instance must map the first portions of all the _info and _instance
3823 blocks for this shared code to work.
3826 class "router", "transport", or "authenticator"
3827 anchor &routers, &transports, &auths
3828 drivers_available available drivers
3829 size_of_info size of each info block
3830 instance_default points to default data for an instance
3831 instance_size size of instance block
3832 driver_optionlist generic option list
3833 driver_optionlist_count count of generic option list
3839 readconf_driver_init(
3841 driver_instance **anchor,
3842 driver_info *drivers_available,
3844 void *instance_default,
3846 optionlist *driver_optionlist,
3847 int driver_optionlist_count)
3849 driver_instance **p = anchor;
3850 driver_instance *d = NULL;
3853 while ((buffer = get_config_line()) != NULL)
3858 /* Read the first name on the line and test for the start of a new driver. A
3859 macro definition indicates the end of the previous driver. If this isn't the
3860 start of a new driver, the line will be re-read. */
3862 s = readconf_readname(name, sizeof(name), buffer);
3864 /* Handle macro definition, first finishing off the initialization of the
3865 previous driver, if any. */
3867 if (isupper(*name) && *s == '=')
3871 if (!d->driver_name)
3872 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3873 "no driver defined for %s \"%s\"", class, d->name);
3877 read_macro_assignment(buffer);
3881 /* If the line starts with a name terminated by a colon, we are at the
3882 start of the definition of a new driver. The rest of the line must be
3889 /* Finish off initializing the previous driver. */
3893 if (!d->driver_name)
3894 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3895 "no driver defined for %s \"%s\"", class, d->name);
3899 /* Check that we haven't already got a driver of this name */
3901 for (d = *anchor; d; d = d->next)
3902 if (Ustrcmp(name, d->name) == 0)
3903 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3904 "there are two %ss called \"%s\"", class, name);
3906 /* Set up a new driver instance data block on the chain, with
3907 its default values installed. */
3909 d = store_get(instance_size);
3910 memcpy(d, instance_default, instance_size);
3913 d->name = string_copy(name);
3915 /* Clear out the "set" bits in the generic options */
3917 for (i = 0; i < driver_optionlist_count; i++)
3918 driver_optionlist[i].type &= ~opt_set;
3920 /* Check nothing more on this line, then do the next loop iteration. */
3922 while (isspace(*s)) s++;
3923 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3927 /* Not the start of a new driver. Give an error if we have not set up a
3928 current driver yet. */
3931 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3933 /* First look to see if this is a generic option; if it is "driver",
3934 initialize the driver. If is it not a generic option, we can look for a
3935 private option provided that the driver has been previously set up. */
3937 if (readconf_handle_option(buffer, driver_optionlist,
3938 driver_optionlist_count, d, NULL))
3940 if (!d->info && d->driver_name)
3941 init_driver(d, drivers_available, size_of_info, class);
3944 /* Handle private options - pass the generic block because some may
3945 live therein. A flag with each option indicates if it is in the public
3949 readconf_handle_option(buffer, d->info->options,
3950 *(d->info->options_count), d, US"option \"%s\" unknown");
3952 /* The option is not generic and the driver name has not yet been given. */
3954 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3955 "(\"driver\" must be specified before any private options)", name);
3958 /* Run the initialization function for the final driver. */
3962 if (!d->driver_name)
3963 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3964 "no driver defined for %s \"%s\"", class, d->name);
3971 /*************************************************
3972 * Check driver dependency *
3973 *************************************************/
3975 /* This function is passed a driver instance and a string. It checks whether
3976 any of the string options for the driver contains the given string as an
3980 d points to a driver instance block
3981 s the string to search for
3983 Returns: TRUE if a dependency is found
3987 readconf_depends(driver_instance *d, uschar *s)
3989 int count = *(d->info->options_count);
3993 for (ol = d->info->options; ol < d->info->options + count; ol++)
3995 void *options_block;
3997 int type = ol->type & opt_mask;
3998 if (type != opt_stringptr) continue;
3999 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
4000 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
4001 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
4003 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
4004 isalnum(ss[Ustrlen(s)])) continue;
4005 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
4006 d->name, ol->name, s);
4011 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4018 /*************************************************
4019 * Decode an error type for retries *
4020 *************************************************/
4022 /* This function is global because it is also called from the main
4023 program when testing retry information. It decodes strings such as "quota_7d"
4024 into numerical error codes.
4027 pp points to start of text
4028 p points past end of text
4029 basic_errno points to an int to receive the main error number
4030 more_errno points to an int to receive the secondary error data
4032 Returns: NULL if decoded correctly; else points to error text
4036 readconf_retry_error(const uschar *pp, const uschar *p,
4037 int *basic_errno, int *more_errno)
4040 const uschar *q = pp;
4041 while (q < p && *q != '_') q++;
4044 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4046 *basic_errno = ERRNO_EXIMQUOTA;
4047 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4048 return US"bad time value";
4051 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4053 *basic_errno = ECONNREFUSED;
4056 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4057 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4058 else return US"A or MX expected after \"refused\"";
4062 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4064 *basic_errno = ETIMEDOUT;
4068 int xlen = p - q - 1;
4069 const uschar *x = q + 1;
4071 static uschar *extras[] =
4072 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4073 static int values[] =
4074 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4076 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
4077 if (strncmpic(x, extras[i], xlen) == 0)
4079 *more_errno = values[i];
4083 if (i >= sizeof(extras)/sizeof(uschar *))
4084 if (strncmpic(x, US"DNS", xlen) == 0)
4085 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4086 "available in retry rules (it has never worked) - treated as "
4089 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4093 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4094 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4095 strncmpic(pp, US"data_4", 6) == 0)
4098 int x = 255; /* means "any 4xx code" */
4099 if (p != pp + 8) bad = TRUE; else
4101 int a = pp[6], b = pp[7];
4105 if (isdigit(b)) x += b - '0';
4106 else if (b == 'x') x += 100;
4109 else if (a != 'x' || b != 'x') bad = TRUE;
4113 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4114 "x is literal and d is any digit", pp);
4116 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4117 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4118 *more_errno = x << 8;
4121 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4122 strncmpic(q+1, US"failed", p-q-1) == 0)
4123 *basic_errno = ERRNO_AUTHFAIL;
4125 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4126 *basic_errno = ERRNO_SMTPCLOSED;
4128 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4129 *basic_errno = ERRNO_TLSREQUIRED;
4131 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4132 *basic_errno = ERRNO_UNKNOWNHOST;
4134 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4135 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4143 /*************************************************
4144 * Read retry information *
4145 *************************************************/
4147 /* Each line of retry information contains:
4149 . A domain name pattern or an address pattern;
4151 . An error name, possibly with additional data, or *;
4153 . An optional sequence of retry items, each consisting of an identifying
4154 letter, a cutoff time, and optional parameters.
4156 All this is decoded and placed into a control block. */
4159 /* Subroutine to read an argument, preceded by a comma and terminated
4160 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4161 1 = fixed point number (returned *1000).
4164 paddr pointer to pointer to current character; updated
4165 type 0 => read a time; 1 => read a fixed point number
4167 Returns: time in seconds or fixed point number * 1000
4171 retry_arg(const uschar **paddr, int type)
4173 const uschar *p = *paddr;
4176 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4178 while (isspace(*p)) p++;
4180 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4182 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4183 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4188 case 0: return readconf_readtime(pp, *p, FALSE);
4189 case 1: return readconf_readfixed(pp, *p);
4191 return 0; /* Keep picky compilers happy */
4194 /* The function proper */
4197 readconf_retries(void)
4199 retry_config **chain = &retries;
4203 while ((p = get_config_line()))
4205 retry_rule **rchain;
4209 next = store_get(sizeof(retry_config));
4212 chain = &(next->next);
4213 next->basic_errno = next->more_errno = 0;
4214 next->senders = NULL;
4216 rchain = &(next->rules);
4218 next->pattern = string_dequote(&p);
4219 while (isspace(*p)) p++;
4221 while (mac_isgraph(*p)) p++;
4222 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4223 "missing error type in retry rule");
4225 /* Test error names for things we understand. */
4227 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4228 &next->more_errno)))
4229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4231 /* There may be an optional address list of senders to be used as another
4232 constraint on the rule. This was added later, so the syntax is a bit of a
4233 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4236 while (isspace(*p)) p++;
4237 if (Ustrncmp(p, "senders", 7) == 0)
4240 while (isspace(*p)) p++;
4241 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4242 "\"=\" expected after \"senders\" in retry rule");
4243 while (isspace(*p)) p++;
4244 next->senders = string_dequote(&p);
4247 /* Now the retry rules. Keep the maximum timeout encountered. */
4249 while (isspace(*p)) p++;
4253 retry_rule *rule = store_get(sizeof(retry_rule));
4255 rchain = &(rule->next);
4257 rule->rule = toupper(*p++);
4258 rule->timeout = retry_arg(&p, 0);
4259 if (rule->timeout > retry_maximum_timeout)
4260 retry_maximum_timeout = rule->timeout;
4264 case 'F': /* Fixed interval */
4265 rule->p1 = retry_arg(&p, 0);
4268 case 'G': /* Geometrically increasing intervals */
4269 case 'H': /* Ditto, but with randomness */
4270 rule->p1 = retry_arg(&p, 0);
4271 rule->p2 = retry_arg(&p, 1);
4275 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4279 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4280 (rule->rule != 'F' && rule->p2 < 1000))
4281 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4282 "bad parameters for retry rule");
4284 while (isspace(*p)) p++;
4288 while (isspace(*p)) p++;
4291 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4298 /*************************************************
4299 * Initialize authenticators *
4300 *************************************************/
4303 readconf_options_auths(void)
4305 struct auth_info * ai;
4307 readconf_options_from_list(optionlist_auths, optionlist_auths_size, US"AU");
4309 for (ai = auths_available; ai->driver_name[0]; ai++)
4311 macro_create(string_sprintf("_DRVR_AUTH_%T", ai->driver_name), US"y", FALSE, TRUE);
4312 readconf_options_from_list(ai->options, (unsigned)*ai->options_count, ai->driver_name);
4317 /* Read the authenticators section of the configuration file.
4326 auth_instance *au, *bu;
4328 readconf_driver_init(US"authenticator",
4329 (driver_instance **)(&auths), /* chain anchor */
4330 (driver_info *)auths_available, /* available drivers */
4331 sizeof(auth_info), /* size of info block */
4332 &auth_defaults, /* default values for generic options */
4333 sizeof(auth_instance), /* size of instance block */
4334 optionlist_auths, /* generic options */
4335 optionlist_auths_size);
4337 for (au = auths; au; au = au->next)
4339 if (!au->public_name)
4340 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4341 "the %s authenticator", au->name);
4343 for (bu = au->next; bu; bu = bu->next)
4344 if (strcmpic(au->public_name, bu->public_name) == 0)
4345 if ((au->client && bu->client) || (au->server && bu->server))
4346 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4347 "(%s and %s) have the same public name (%s)",
4348 au->client ? US"client" : US"server", au->name, bu->name,
4356 /*************************************************
4357 * Read ACL information *
4358 *************************************************/
4360 /* If this run of Exim is not doing something that involves receiving a
4361 message, we can just skip over the ACL information. No need to parse it.
4363 First, we have a function for acl_read() to call back to get the next line. We
4364 need to remember the line we passed, because at the end it will contain the
4365 name of the next ACL. */
4367 static uschar *acl_line;
4372 acl_line = get_config_line();
4377 /* Now the main function:
4388 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4391 acl_line = get_config_line();
4393 while(acl_line != NULL)
4399 p = readconf_readname(name, sizeof(name), acl_line);
4400 if (isupper(*name) && *p == '=')
4402 read_macro_assignment(acl_line);
4403 acl_line = get_config_line();
4407 if (*p != ':' || name[0] == 0)
4408 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4410 node = store_get(sizeof(tree_node) + Ustrlen(name));
4411 Ustrcpy(node->name, name);
4412 if (!tree_insertnode(&acl_anchor, node))
4413 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4414 "there are two ACLs called \"%s\"", name);
4416 node->data.ptr = acl_read(acl_callback, &error);
4418 if (node->data.ptr == NULL && error != NULL)
4419 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4425 /*************************************************
4426 * Read configuration for local_scan() *
4427 *************************************************/
4429 /* This function is called after "begin local_scan" is encountered in the
4430 configuration file. If the local_scan() function allows for configuration
4431 options, we can process them. Otherwise, we expire in a panic.
4438 local_scan_init(void)
4440 #ifndef LOCAL_SCAN_HAS_OPTIONS
4441 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4442 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4446 while ((p = get_config_line()) != NULL)
4448 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4449 NULL, US"local_scan option \"%s\" unknown");
4456 /*************************************************
4457 * Read rest of configuration (after main) *
4458 *************************************************/
4460 /* This function reads the rest of the runtime configuration, after the main
4461 configuration. It is called only when actually needed. Each subsequent section
4462 of the configuration starts with a line of the form
4466 where the name is "routers", "transports", etc. A section is terminated by
4467 hitting the next "begin" line, and the next name is left in next_section.
4468 Because it may confuse people as to whether the names are singular or plural,
4469 we add "s" if it's missing. There is always enough room in next_section for
4470 this. This function is basically just a switch.
4476 static uschar *section_list[] = {
4490 while(next_section[0] != 0)
4494 int last = sizeof(section_list) / sizeof(uschar *);
4496 int n = Ustrlen(next_section);
4498 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4502 int c = strcmpic(next_section, section_list[mid]);
4504 if (c > 0) first = mid + 1; else last = mid;
4506 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4507 "\"%.*s\" is not a known configuration section name", n, next_section);
4508 mid = (last + first)/2;
4512 if (((had ^= bit) & bit) == 0)
4513 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4514 "\"%.*s\" section is repeated in the configuration file", n,
4519 case 0: readconf_acl(); break;
4520 case 1: auths_init(); break;
4521 case 2: local_scan_init(); break;
4522 case 3: readconf_retries(); break;
4523 case 4: readconf_rewrites(); break;
4524 case 5: route_init(); break;
4525 case 6: transport_init(); break;
4529 (void)fclose(config_file);
4532 /* Init the storage for the pre-parsed config lines */
4534 readconf_save_config(const uschar *s)
4536 save_config_line(string_sprintf("# Exim Configuration (%s)",
4537 running_in_test_harness ? US"X" : s));
4541 save_config_position(const uschar *file, int line)
4543 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4546 /* Append a pre-parsed logical line to the config lines store,
4547 this operates on a global (static) list that holds all the pre-parsed
4548 config lines, we do no further processing here, output formatting and
4549 honouring of <hide> or macros will be done during output */
4551 save_config_line(const uschar* line)
4553 static config_line_item *current;
4554 config_line_item *next;
4556 next = (config_line_item*) store_get(sizeof(config_line_item));
4557 next->line = string_copy(line);
4560 if (!config_lines) config_lines = next;
4561 else current->next = next;
4566 /* List the parsed config lines, care about nice formatting and
4567 hide the <hide> values unless we're the admin user */
4569 print_config(BOOL admin, BOOL terse)
4571 config_line_item *i;
4572 const int TS = terse ? 0 : 2;
4575 for (i = config_lines; i; i = i->next)
4580 /* skip over to the first non-space */
4581 for (current = i->line; *current && isspace(*current); ++current)
4584 if (*current == '\0')
4587 /* Collapse runs of spaces. We stop this if we encounter one of the
4588 * following characters: "'$, as this may indicate careful formatting */
4589 for (p = current; *p; ++p)
4592 if (!isspace(*p)) continue;
4593 if (*p != ' ') *p = ' ';
4595 for (next = p; isspace(*next); ++next)
4599 memmove(p+1, next, Ustrlen(next)+1);
4601 if (*next == '"' || *next == '\'' || *next == '$')
4606 if (current[0] == '#')
4609 /* begin lines are left aligned */
4610 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4612 if (!terse) puts("");
4617 /* router/acl/transport block names */
4618 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4620 if (!terse) puts("");
4621 printf("%*s%s\n", TS, "", current);
4625 /* hidden lines (all MACROS or lines prefixed with "hide") */
4627 && ( isupper(*current)
4628 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4632 if ((p = Ustrchr(current, '=')))
4635 printf("%*s%s= %s\n", indent, "", current, hidden);
4637 /* e.g.: hide split_spool_directory */
4639 printf("%*s\n", indent, hidden);
4643 /* rest is public */
4644 printf("%*s%s\n", indent, "", current);
4650 /* End of readconf.c */