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_processname", opt_stringptr, &syslog_processname },
449 { "syslog_timestamp", opt_bool, &syslog_timestamp },
450 { "system_filter", opt_stringptr, &system_filter },
451 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
452 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
453 { "system_filter_group", opt_gid, &system_filter_gid },
454 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
455 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
456 { "system_filter_user", opt_uid, &system_filter_uid },
457 { "tcp_nodelay", opt_bool, &tcp_nodelay },
458 #ifdef USE_TCP_WRAPPERS
459 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
461 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
462 { "timezone", opt_stringptr, &timezone_string },
463 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
465 { "tls_certificate", opt_stringptr, &tls_certificate },
466 { "tls_crl", opt_stringptr, &tls_crl },
467 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
468 { "tls_dhparam", opt_stringptr, &tls_dhparam },
469 { "tls_eccurve", opt_stringptr, &tls_eccurve },
470 # ifndef DISABLE_OCSP
471 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
473 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
474 { "tls_privatekey", opt_stringptr, &tls_privatekey },
475 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
476 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
477 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
478 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
479 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
481 { "trusted_groups", opt_gidlist, &trusted_groups },
482 { "trusted_users", opt_uidlist, &trusted_users },
483 { "unknown_login", opt_stringptr, &unknown_login },
484 { "unknown_username", opt_stringptr, &unknown_username },
485 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
486 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
487 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
488 { "warn_message_file", opt_stringptr, &warn_message_file },
489 { "write_rejectlog", opt_bool, &write_rejectlog }
492 static int optionlist_config_size = nelem(optionlist_config);
496 /*************************************************
497 * Find the name of an option *
498 *************************************************/
500 /* This function is to aid debugging. Various functions take arguments that are
501 pointer variables in the options table or in option tables for various drivers.
502 For debugging output, it is useful to be able to find the name of the option
503 which is currently being processed. This function finds it, if it exists, by
504 searching the table(s).
506 Arguments: a value that is presumed to be in the table above
507 Returns: the option name, or an empty string
511 readconf_find_option(void *p)
515 transport_instance *t;
517 for (i = 0; i < nelem(optionlist_config); i++)
518 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
520 for (r = routers; r; r = r->next)
522 router_info *ri = r->info;
523 for (i = 0; i < *ri->options_count; i++)
525 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
526 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
527 return US ri->options[i].name;
531 for (t = transports; t; t = t->next)
533 transport_info *ti = t->info;
534 for (i = 0; i < *ti->options_count; i++)
536 optionlist * op = &ti->options[i];
537 if ((op->type & opt_mask) != opt_stringptr) continue;
538 if (p == ( op->type & opt_public
540 : (char *)t->options_block
542 + (long int)op->value)
553 /*************************************************
554 * Deal with an assignment to a macro *
555 *************************************************/
557 /* We have a new definition. The macro_item structure includes a final vector
558 called "name" which is one byte long. Thus, adding "namelen" gives us enough
559 room to store the "name" string.
560 If a builtin macro we place at head of list, else tail. This lets us lazy-create
564 macro_create(const uschar * name, const uschar * val,
565 BOOL command_line, BOOL builtin)
567 unsigned namelen = Ustrlen(name);
568 macro_item * m = store_get(sizeof(macro_item) + namelen);
587 m->command_line = command_line;
588 m->namelen = namelen;
589 m->replacement = string_copy(val);
590 Ustrcpy(m->name, name);
595 /* This function is called when a line that starts with an upper case letter is
596 encountered. The argument "line" should contain a complete logical line, and
597 start with the first letter of the macro name. The macro name and the
598 replacement text are extracted and stored. Redefinition of existing,
599 non-command line, macros is permitted using '==' instead of '='.
602 s points to the start of the logical line
608 read_macro_assignment(uschar *s)
615 while (isalnum(*s) || *s == '_')
617 if (namelen >= sizeof(name) - 1)
618 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
619 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
620 name[namelen++] = *s++;
624 while (isspace(*s)) s++;
626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
633 while (isspace(*s)) s++;
635 /* If an existing macro of the same name was defined on the command line, we
636 just skip this definition. It's an error to attempt to redefine a macro without
637 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
638 It is also an error to define a macro whose name begins with the name of a
639 previously defined macro. This is the requirement that make using a tree
640 for macros hard; we must check all macros for the substring. Perhaps a
641 sorted list, and a bsearch, would work?
642 Note: it is documented that the other way round works. */
644 for (m = macros; m; m = m->next)
646 if (Ustrcmp(m->name, name) == 0)
648 if (!m->command_line && !redef)
649 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
650 "defined (use \"==\" if you want to redefine it", name);
654 if (m->namelen < namelen && Ustrstr(name, m->name) != NULL)
655 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
656 "a macro because previously defined macro \"%s\" is a substring",
659 /* We cannot have this test, because it is documented that a substring
660 macro is permitted (there is even an example).
662 * if (m->namelen > namelen && Ustrstr(m->name, name) != NULL)
663 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
664 * "a macro because it is a substring of previously defined macro \"%s\"",
669 /* Check for an overriding command-line definition. */
671 if (m && m->command_line) return;
673 /* Redefinition must refer to an existing macro. */
677 m->replacement = string_copy(s);
679 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
682 /* We have a new definition. */
684 (void) macro_create(name, s, FALSE, FALSE);
691 /*************************************************/
692 /* Create compile-time feature macros */
694 readconf_features(void)
696 /* Probably we could work out a static initialiser for wherever
697 macros are stored, but this will do for now. Some names are awkward
698 due to conflicts with other common macros. */
700 #ifdef SUPPORT_CRYPTEQ
701 macro_create(US"_HAVE_CRYPTEQ", US"y", FALSE, TRUE);
704 macro_create(US"_HAVE_ICONV", US"y", FALSE, TRUE);
707 macro_create(US"_HAVE_IPV6", US"y", FALSE, TRUE);
709 #ifdef HAVE_SETCLASSRESOURCES
710 macro_create(US"_HAVE_SETCLASSRESOURCES", US"y", FALSE, TRUE);
713 macro_create(US"_HAVE_PAM", US"y", FALSE, TRUE);
716 macro_create(US"_HAVE_PERL", US"y", FALSE, TRUE);
719 macro_create(US"_HAVE_DLFUNC", US"y", FALSE, TRUE);
721 #ifdef USE_TCP_WRAPPERS
722 macro_create(US"_HAVE_TCPWRAPPERS", US"y", FALSE, TRUE);
725 macro_create(US"_HAVE_TLS", US"y", FALSE, TRUE);
727 macro_create(US"_HAVE_GNUTLS", US"y", FALSE, TRUE);
729 macro_create(US"_HAVE_OPENSSL", US"y", FALSE, TRUE);
732 #ifdef SUPPORT_TRANSLATE_IP_ADDRESS
733 macro_create(US"_HAVE_TRANSLATE_IP_ADDRESS", US"y", FALSE, TRUE);
735 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
736 macro_create(US"_HAVE_MOVE_FROZEN_MESSAGES", US"y", FALSE, TRUE);
738 #ifdef WITH_CONTENT_SCAN
739 macro_create(US"_HAVE_CONTENT_SCANNING", US"y", FALSE, TRUE);
742 macro_create(US"_HAVE_DKIM", US"y", FALSE, TRUE);
744 #ifndef DISABLE_DNSSEC
745 macro_create(US"_HAVE_DNSSEC", US"y", FALSE, TRUE);
747 #ifndef DISABLE_EVENT
748 macro_create(US"_HAVE_EVENT", US"y", FALSE, TRUE);
751 macro_create(US"_HAVE_I18N", US"y", FALSE, TRUE);
754 macro_create(US"_HAVE_OCSP", US"y", FALSE, TRUE);
757 macro_create(US"_HAVE_PRDR", US"y", FALSE, TRUE);
760 macro_create(US"_HAVE_PROXY", US"y", FALSE, TRUE);
763 macro_create(US"_HAVE_SOCKS", US"y", FALSE, TRUE);
766 macro_create(US"_HAVE_TCP_FASTOPEN", US"y", FALSE, TRUE);
768 #ifdef EXPERIMENTAL_LMDB
769 macro_create(US"_HAVE_LMDB", US"y", FALSE, TRUE);
771 #ifdef EXPERIMENTAL_SPF
772 macro_create(US"_HAVE_SPF", US"y", FALSE, TRUE);
774 #ifdef EXPERIMENTAL_SRS
775 macro_create(US"_HAVE_SRS", US"y", FALSE, TRUE);
777 #ifdef EXPERIMENTAL_BRIGHTMAIL
778 macro_create(US"_HAVE_BRIGHTMAIL", US"y", FALSE, TRUE);
780 #ifdef EXPERIMENTAL_DANE
781 macro_create(US"_HAVE_DANE", US"y", FALSE, TRUE);
783 #ifdef EXPERIMENTAL_DCC
784 macro_create(US"_HAVE_DCC", US"y", FALSE, TRUE);
786 #ifdef EXPERIMENTAL_DMARC
787 macro_create(US"_HAVE_DMARC", US"y", FALSE, TRUE);
789 #ifdef EXPERIMENTAL_DSN_INFO
790 macro_create(US"_HAVE_DSN_INFO", US"y", FALSE, TRUE);
793 #ifdef LOOKUP_LSEARCH
794 macro_create(US"_HAVE_LKUP_LSEARCH", US"y", FALSE, TRUE);
797 macro_create(US"_HAVE_LKUP_CDB", US"y", FALSE, TRUE);
800 macro_create(US"_HAVE_LKUP_DBM", US"y", FALSE, TRUE);
803 macro_create(US"_HAVE_LKUP_DNSDB", US"y", FALSE, TRUE);
805 #ifdef LOOKUP_DSEARCH
806 macro_create(US"_HAVE_LKUP_DSEARCH", US"y", FALSE, TRUE);
809 macro_create(US"_HAVE_LKUP_IBASE", US"y", FALSE, TRUE);
812 macro_create(US"_HAVE_LKUP_LDAP", US"y", FALSE, TRUE);
814 #ifdef EXPERIMENTAL_LMDB
815 macro_create(US"_HAVE_LKUP_LMDB", US"y", FALSE, TRUE);
818 macro_create(US"_HAVE_LKUP_MYSQL", US"y", FALSE, TRUE);
821 macro_create(US"_HAVE_LKUP_NIS", US"y", FALSE, TRUE);
823 #ifdef LOOKUP_NISPLUS
824 macro_create(US"_HAVE_LKUP_NISPLUS", US"y", FALSE, TRUE);
827 macro_create(US"_HAVE_LKUP_ORACLE", US"y", FALSE, TRUE);
830 macro_create(US"_HAVE_LKUP_PASSWD", US"y", FALSE, TRUE);
833 macro_create(US"_HAVE_LKUP_PGSQL", US"y", FALSE, TRUE);
836 macro_create(US"_HAVE_LKUP_REDIS", US"y", FALSE, TRUE);
839 macro_create(US"_HAVE_LKUP_SQLITE", US"y", FALSE, TRUE);
842 macro_create(US"_HAVE_LKUP_TESTDB", US"y", FALSE, TRUE);
845 macro_create(US"_HAVE_LKUP_WHOSON", US"y", FALSE, TRUE);
848 #ifdef TRANSPORT_APPENDFILE
849 # ifdef SUPPORT_MAILDIR
850 macro_create(US"_HAVE_TPT_APPEND_MAILDR", US"y", FALSE, TRUE);
852 # ifdef SUPPORT_MAILSTORE
853 macro_create(US"_HAVE_TPT_APPEND_MAILSTORE", US"y", FALSE, TRUE);
856 macro_create(US"_HAVE_TPT_APPEND_MBX", US"y", FALSE, TRUE);
863 readconf_options_from_list(optionlist * opts, unsigned nopt, uschar * group)
868 /* Walk the array backwards to get substring-conflict names */
869 for (i = nopt-1; i >= 0; i--) if (*(s = opts[i].name) && *s != '*')
870 macro_create(string_sprintf("_OPT_%T_%T", group, s), US"y", FALSE, TRUE);
875 readconf_options(void)
877 readconf_options_from_list(optionlist_config, nelem(optionlist_config), US"MAIN");
878 readconf_options_routers();
879 readconf_options_transports();
880 readconf_options_auths();
884 macros_create_builtin(void)
888 macros_builtin_created = TRUE;
892 /*************************************************
893 * Read configuration line *
894 *************************************************/
896 /* A logical line of text is read from the configuration file into the big
897 buffer, taking account of macros, .includes, and continuations. The size of
898 big_buffer is increased if necessary. The count of configuration lines is
899 maintained. Physical input lines starting with # (ignoring leading white space,
900 and after macro replacement) and empty logical lines are always ignored.
901 Leading and trailing spaces are removed.
903 If we hit a line of the form "begin xxxx", the xxxx is placed in the
904 next_section vector, and the function returns NULL, indicating the end of a
905 configuration section. On end-of-file, NULL is returned with next_section
910 Returns: a pointer to the first non-blank in the line,
911 or NULL if eof or end of section is reached
915 get_config_line(void)
917 int startoffset = 0; /* To first non-blank char in logical line */
918 int len = 0; /* Of logical line so far */
924 /* Loop for handling continuation lines, skipping comments, and dealing with
929 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
931 if (config_file_stack != NULL) /* EOF inside .include */
933 (void)fclose(config_file);
934 config_file = config_file_stack->file;
935 config_filename = config_file_stack->filename;
936 config_lineno = config_file_stack->lineno;
937 config_file_stack = config_file_stack->next;
939 save_config_position(config_filename, config_lineno);
943 /* EOF at top level */
945 if (cstate_stack_ptr >= 0)
946 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
947 "Unexpected end of configuration file: .endif missing");
949 if (len != 0) break; /* EOF after continuation */
950 next_section[0] = 0; /* EOF at start of logical line */
955 newlen = len + Ustrlen(big_buffer + len);
957 if (config_lines && config_lineno == 1)
958 save_config_position(config_filename, config_lineno);
960 /* Handle pathologically long physical lines - yes, it did happen - by
961 extending big_buffer at this point. The code also copes with very long
964 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
967 big_buffer_size += BIG_BUFFER_SIZE;
968 newbuffer = store_malloc(big_buffer_size);
970 /* This use of strcpy is OK because we know that the string in the old
971 buffer is shorter than the new buffer. */
973 Ustrcpy(newbuffer, big_buffer);
974 store_free(big_buffer);
975 big_buffer = newbuffer;
976 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
978 newlen += Ustrlen(big_buffer + newlen);
981 /* Find the true start of the physical line - leading spaces are always
984 ss = big_buffer + len;
985 while (isspace(*ss)) ss++;
987 /* Process the physical line for macros. If this is the start of the logical
988 line, skip over initial text at the start of the line if it starts with an
989 upper case character followed by a sequence of name characters and an equals
990 sign, because that is the definition of a new macro, and we don't do
991 replacement therein. */
994 if (len == 0 && isupper(*s))
996 while (isalnum(*s) || *s == '_') s++;
997 while (isspace(*s)) s++;
998 if (*s != '=') s = ss; /* Not a macro definition */
1001 /* If the builtin macros are not yet defined, and the line contains an
1002 underscrore followed by an one of the three possible chars used by
1003 builtins, create them. */
1005 if (!macros_builtin_created)
1007 const uschar * t, * p;
1009 for (t = s; (p = CUstrchr(t, '_')); t = p+1)
1010 if (c = p[1], c == 'O' || c == 'D' || c == 'H')
1012 macros_create_builtin();
1017 /* For each defined macro, scan the line (from after XXX= if present),
1018 replacing all occurrences of the macro. */
1020 macro_found = FALSE;
1021 for (m = macros; m; m = m->next)
1026 while ((p = Ustrstr(t, m->name)) != NULL)
1029 int replen = Ustrlen(m->replacement);
1031 /* Expand the buffer if necessary */
1033 while (newlen - m->namelen + replen + 1 > big_buffer_size)
1035 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
1036 uschar *newbuffer = store_malloc(newsize);
1037 memcpy(newbuffer, big_buffer, newlen + 1);
1038 p = newbuffer + (p - big_buffer);
1039 s = newbuffer + (s - big_buffer);
1040 ss = newbuffer + (ss - big_buffer);
1041 t = newbuffer + (t - big_buffer);
1042 big_buffer_size = newsize;
1043 store_free(big_buffer);
1044 big_buffer = newbuffer;
1047 /* Shuffle the remaining characters up or down in the buffer before
1048 copying in the replacement text. Don't rescan the replacement for this
1051 pp = p + m->namelen;
1052 if ((moveby = replen - m->namelen) != 0)
1054 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
1057 Ustrncpy(p, m->replacement, replen);
1063 /* An empty macro replacement at the start of a line could mean that ss no
1064 longer points to the first non-blank character. */
1066 while (isspace(*ss)) ss++;
1068 /* Check for comment lines - these are physical lines. */
1070 if (*ss == '#') continue;
1072 /* Handle conditionals, which are also applied to physical lines. Conditions
1073 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
1074 expansion occured on the rest of the line. A preliminary test for the leading
1075 '.' saves effort on most lines. */
1081 /* Search the list of conditional directives */
1083 for (i = 0; i < cond_list_size; i++)
1086 cond_item *c = cond_list+i;
1087 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
1089 /* The following character must be white space or end of string */
1091 n = ss[1 + c->namelen];
1092 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
1094 /* .ifdef and .ifndef push the current state onto the stack, then set
1095 a new one from the table. Stack overflow is an error */
1099 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
1100 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1101 ".%s nested too deeply", c->name);
1102 cstate_stack[++cstate_stack_ptr] = cstate;
1103 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
1106 /* For any of the others, stack underflow is an error. The next state
1107 comes either from the stack (.endif) or from the table. */
1111 if (cstate_stack_ptr < 0)
1112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1113 ".%s without matching .ifdef", c->name);
1114 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
1115 next_cstate[cstate][macro_found? c->action1 : c->action2];
1118 /* Having dealt with a directive, break the loop */
1123 /* If we have handled a conditional directive, continue with the next
1124 physical line. Otherwise, fall through. */
1126 if (i < cond_list_size) continue;
1129 /* If the conditional state is not 0 (actively using these lines), ignore
1132 if (cstate != 0) continue; /* Conditional skip */
1134 /* Handle .include lines - these are also physical lines. */
1136 if (Ustrncmp(ss, ".include", 8) == 0 &&
1138 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
1141 int include_if_exists = isspace(ss[8])? 0 : 10;
1142 config_file_item *save;
1143 struct stat statbuf;
1145 ss += 9 + include_if_exists;
1146 while (isspace(*ss)) ss++;
1147 t = ss + Ustrlen(ss);
1148 while (t > ss && isspace(t[-1])) t--;
1149 if (*ss == '\"' && t[-1] == '\"')
1157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
1158 "absolute path \"%s\"", ss);
1160 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
1163 save_config_position(config_filename, config_lineno);
1164 save = store_get(sizeof(config_file_item));
1165 save->next = config_file_stack;
1166 config_file_stack = save;
1167 save->file = config_file;
1168 save->filename = config_filename;
1169 save->lineno = config_lineno;
1171 if (!(config_file = Ufopen(ss, "rb")))
1172 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
1173 "configuration file %s", ss);
1175 config_filename = string_copy(ss);
1180 /* If this is the start of the logical line, remember where the non-blank
1181 data starts. Otherwise shuffle down continuation lines to remove leading
1185 startoffset = ss - big_buffer;
1188 s = big_buffer + len;
1191 memmove(s, ss, (newlen - len) - (ss - s) + 1);
1196 /* Accept the new addition to the line. Remove trailing white space. */
1199 while (len > 0 && isspace(big_buffer[len-1])) len--;
1200 big_buffer[len] = 0;
1202 /* We are done if the line does not end in backslash and contains some data.
1203 Empty logical lines are ignored. For continuations, remove the backslash and
1204 go round the loop to read the continuation line. */
1208 if (big_buffer[len-1] != '\\') break; /* End of logical line */
1209 big_buffer[--len] = 0; /* Remove backslash */
1211 } /* Loop for reading multiple physical lines */
1213 /* We now have a logical line. Test for the end of a configuration section (or,
1214 more accurately, for the start of the next section). Place the name of the next
1215 section in next_section, and return NULL. If the name given is longer than
1216 next_section, truncate it. It will be unrecognized later, because all the known
1217 section names do fit. Leave space for pluralizing. */
1219 s = big_buffer + startoffset; /* First non-space character */
1222 save_config_line(s);
1224 if (strncmpic(s, US"begin ", 6) == 0)
1227 while (isspace(*s)) s++;
1228 if (big_buffer + len - s > sizeof(next_section) - 2)
1229 s[sizeof(next_section) - 2] = 0;
1230 Ustrcpy(next_section, s);
1234 /* Return the first non-blank character. */
1241 /*************************************************
1243 *************************************************/
1245 /* The yield is the pointer to the next uschar. Names longer than the
1246 output space are silently truncated. This function is also used from acl.c when
1250 name where to put the name
1254 Returns: new input pointer
1258 readconf_readname(uschar *name, int len, uschar *s)
1261 while (isspace(*s)) s++;
1264 while (isalnum(*s) || *s == '_')
1266 if (p < len-1) name[p++] = *s;
1271 while (isspace(*s)) s++;
1278 /*************************************************
1279 * Read a time value *
1280 *************************************************/
1282 /* This function is also called from outside, to read argument
1283 time values. The format of a time value is:
1285 [<n>w][<n>d][<n>h][<n>m][<n>s]
1287 as long as at least one is present. If a format error is encountered,
1288 return a negative value. The value must be terminated by the given
1293 terminator required terminating character
1294 return_msec if TRUE, allow fractional seconds and return milliseconds
1296 Returns: the time value, or -1 on syntax error
1297 value is seconds if return_msec is FALSE
1298 value is milliseconds if return_msec is TRUE
1302 readconf_readtime(const uschar *s, int terminator, BOOL return_msec)
1310 if (!isdigit(*s)) return -1;
1311 (void)sscanf(CCS s, "%d%n", &value, &count);
1316 case 'w': value *= 7;
1317 case 'd': value *= 24;
1318 case 'h': value *= 60;
1319 case 'm': value *= 60;
1324 if (!return_msec) return -1;
1325 (void)sscanf(CCS s, "%lf%n", &fraction, &count);
1327 if (*s++ != 's') return -1;
1328 yield += (int)(fraction * 1000.0);
1334 if (return_msec) value *= 1000;
1336 if (*s == terminator) return yield;
1338 /* Control never reaches here. */
1343 /*************************************************
1344 * Read a fixed point value *
1345 *************************************************/
1347 /* The value is returned *1000
1351 terminator required terminator
1353 Returns: the value, or -1 on error
1357 readconf_readfixed(const uschar *s, int terminator)
1361 if (!isdigit(*s)) return -1;
1362 (void)sscanf(CS s, "%d%n", &value, &count);
1364 yield = value * 1000;
1368 while (isdigit((*(++s))))
1370 yield += (*s - '0') * m;
1375 return (*s == terminator)? yield : (-1);
1380 /*************************************************
1381 * Find option in list *
1382 *************************************************/
1384 /* The lists are always in order, so binary chop can be used.
1387 name the option name to search for
1388 ol the first entry in the option list
1389 last one more than the offset of the last entry in the option list
1391 Returns: pointer to an option entry, or NULL if not found
1395 find_option(uschar *name, optionlist *ol, int last)
1398 while (last > first)
1400 int middle = (first + last)/2;
1401 int c = Ustrcmp(name, ol[middle].name);
1403 if (c == 0) return ol + middle;
1404 else if (c > 0) first = middle + 1;
1412 /*************************************************
1413 * Find a set flag in option list *
1414 *************************************************/
1416 /* Because some versions of Unix make no restrictions on the values of uids and
1417 gids (even negative ones), we cannot represent "unset" by a special value.
1418 There is therefore a separate boolean variable for each one indicating whether
1419 a value is set or not. This function returns a pointer to the boolean, given
1420 the original option name. It is a major disaster if the flag cannot be found.
1423 name the name of the uid or gid option
1424 oltop points to the start of the relevant option list
1425 last one more than the offset of the last item in the option list
1426 data_block NULL when reading main options => data values in the option
1427 list are absolute addresses; otherwise they are byte offsets
1428 in data_block (used for driver options)
1430 Returns: a pointer to the boolean flag.
1434 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1438 sprintf(CS name2, "*set_%.50s", name);
1439 ol = find_option(name2, oltop, last);
1440 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1441 "Exim internal error: missing set flag for %s", name);
1442 return (data_block == NULL)? (BOOL *)(ol->value) :
1443 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1449 /*************************************************
1450 * Output extra characters message and die *
1451 *************************************************/
1453 /* Called when an option line has junk on the end. Sometimes this is because
1454 the sysadmin thinks comments are permitted.
1457 s points to the extra characters
1458 t1..t3 strings to insert in the log message
1460 Returns: doesn't return; dies
1464 extra_chars_error(const uschar *s, const uschar *t1, const uschar *t2, const uschar *t3)
1466 uschar *comment = US"";
1467 if (*s == '#') comment = US" (# is comment only at line start)";
1468 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1469 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1474 /*************************************************
1475 * Read rewrite information *
1476 *************************************************/
1478 /* Each line of rewrite information contains:
1480 . A complete address in the form user@domain, possibly with
1481 leading * for each part; or alternatively, a regex.
1483 . A replacement string (which will be expanded).
1485 . An optional sequence of one-letter flags, indicating which
1486 headers etc. to apply this rule to.
1488 All this is decoded and placed into a control block. The OR of the flags is
1489 maintained in a common word.
1492 p points to the string that makes up the rule
1493 existflags points to the overall flag word
1494 isglobal TRUE if reading global rewrite rules
1496 Returns: the control block for the parsed rule.
1499 static rewrite_rule *
1500 readconf_one_rewrite(const uschar *p, int *existflags, BOOL isglobal)
1502 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1505 next->key = string_dequote(&p);
1507 while (isspace(*p)) p++;
1509 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1510 "missing rewrite replacement string");
1513 next->replacement = string_dequote(&p);
1515 while (*p != 0) switch (*p++)
1517 case ' ': case '\t': break;
1519 case 'q': next->flags |= rewrite_quit; break;
1520 case 'w': next->flags |= rewrite_whole; break;
1522 case 'h': next->flags |= rewrite_all_headers; break;
1523 case 's': next->flags |= rewrite_sender; break;
1524 case 'f': next->flags |= rewrite_from; break;
1525 case 't': next->flags |= rewrite_to; break;
1526 case 'c': next->flags |= rewrite_cc; break;
1527 case 'b': next->flags |= rewrite_bcc; break;
1528 case 'r': next->flags |= rewrite_replyto; break;
1530 case 'E': next->flags |= rewrite_all_envelope; break;
1531 case 'F': next->flags |= rewrite_envfrom; break;
1532 case 'T': next->flags |= rewrite_envto; break;
1534 case 'Q': next->flags |= rewrite_qualify; break;
1535 case 'R': next->flags |= rewrite_repeat; break;
1538 next->flags |= rewrite_smtp;
1539 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1540 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1541 "rewrite rule has the S flag but is not a regular expression");
1545 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1546 "unknown rewrite flag character '%c' "
1547 "(could be missing quotes round replacement item)", p[-1]);
1551 /* If no action flags are set, set all the "normal" rewrites. */
1553 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1554 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1556 /* Remember which exist, for optimization, and return the rule */
1558 *existflags |= next->flags;
1565 /*************************************************
1566 * Read global rewrite information *
1567 *************************************************/
1569 /* Each line is a single rewrite rule; it is parsed into a control block
1570 by readconf_one_rewrite(), and its flags are ORed into the global flag
1571 word rewrite_existflags. */
1574 readconf_rewrites(void)
1576 rewrite_rule **chain = &global_rewrite_rules;
1579 while ((p = get_config_line()) != NULL)
1581 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1583 chain = &(next->next);
1589 /*************************************************
1591 *************************************************/
1593 /* Strings are read into the normal store pool. As long we aren't too
1594 near the end of the current block, the string will just use what is necessary
1595 on the top of the stacking pool, because string_cat() uses the extension
1599 s the rest of the input line
1600 name the option name (for errors)
1602 Returns: pointer to the string
1606 read_string(const uschar *s, const uschar *name)
1611 if (*s != '\"') return string_copy(s);
1614 yield = string_dequote(&s);
1616 if (s == ss+1 || s[-1] != '\"')
1617 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1618 "missing quote at end of string value for %s", name);
1620 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1626 /*************************************************
1627 * Custom-handler options *
1628 *************************************************/
1630 fn_smtp_receive_timeout(const uschar * name, const uschar * str)
1633 smtp_receive_timeout_s = string_copy(str);
1636 /* "smtp_receive_timeout", opt_time, &smtp_receive_timeout */
1637 smtp_receive_timeout = readconf_readtime(str, 0, FALSE);
1638 if (smtp_receive_timeout < 0)
1639 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1644 /*************************************************
1645 * Handle option line *
1646 *************************************************/
1648 /* This function is called from several places to process a line containing the
1649 setting of an option. The first argument is the line to be decoded; it has been
1650 checked not to be empty and not to start with '#'. Trailing newlines and white
1651 space have been removed. The second argument is a pointer to the list of
1652 variable names that are to be recognized, together with their types and
1653 locations, and the third argument gives the number of entries in the list.
1655 The fourth argument is a pointer to a data block. If it is NULL, then the data
1656 values in the options list are absolute addresses. Otherwise, they are byte
1657 offsets in the data block.
1659 String option data may continue onto several lines; this function reads further
1660 data from config_file if necessary.
1662 The yield of this function is normally zero. If a string continues onto
1663 multiple lines, then the data value is permitted to be followed by a comma
1664 or a semicolon (for use in drivers) and the yield is that character.
1667 buffer contains the configuration line to be handled
1668 oltop points to the start of the relevant option list
1669 last one more than the offset of the last item in the option list
1670 data_block NULL when reading main options => data values in the option
1671 list are absolute addresses; otherwise they are byte offsets
1672 in data_block when they have opt_public set; otherwise
1673 they are byte offsets in data_block->options_block.
1674 unknown_txt format string to use in panic message for unknown option;
1675 must contain %s for option name
1676 if given as NULL, don't panic on unknown option
1678 Returns: TRUE if an option was read successfully,
1679 FALSE false for an unknown option if unknown_txt == NULL,
1680 otherwise panic and die on an unknown option
1684 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1685 void *data_block, uschar *unknown_txt)
1689 int n, count, type, value;
1693 BOOL boolvalue = TRUE;
1694 BOOL freesptr = TRUE;
1695 optionlist *ol, *ol2;
1699 uschar *inttype = US"";
1702 uschar **str_target;
1706 /* There may be leading spaces; thereafter, we expect an option name starting
1709 while (isspace(*s)) s++;
1711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1713 /* Read the name of the option, and skip any subsequent white space. If
1714 it turns out that what we read was "hide", set the flag indicating that
1715 this is a secure option, and loop to read the next word. */
1717 for (n = 0; n < 2; n++)
1719 while (isalnum(*s) || *s == '_')
1721 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1725 while (isspace(*s)) s++;
1726 if (Ustrcmp(name, "hide") != 0) break;
1727 issecure = opt_secure;
1731 /* Deal with "no_" or "not_" here for booleans */
1733 if (Ustrncmp(name, "no_", 3) == 0)
1739 if (Ustrncmp(name, "not_", 4) == 0)
1745 /* Search the list for the given name. A non-existent name, or an option that
1746 is set twice, is a disaster. */
1748 if (!(ol = find_option(name + offset, oltop, last)))
1750 if (unknown_txt == NULL) return FALSE;
1751 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1754 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1755 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1756 "\"%s\" option set for the second time", name);
1758 ol->type |= opt_set | issecure;
1759 type = ol->type & opt_mask;
1761 /* Types with data values must be followed by '='; the "no[t]_" prefix
1762 applies only to boolean values. */
1764 if (type < opt_bool || type > opt_bool_last)
1767 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1768 "negation prefix applied to a non-boolean option");
1770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1771 "unexpected end of line (data missing) after %s", name);
1773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1776 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1777 true/false/yes/no, or, in the case of opt_expand_bool, a general string that
1778 ultimately expands to one of those values. */
1780 else if (*s != 0 && (offset != 0 || *s != '='))
1781 extra_chars_error(s, US"boolean option ", name, US"");
1783 /* Skip white space after = */
1785 if (*s == '=') while (isspace((*(++s))));
1787 /* If there is a data block and the opt_public flag is not set, change
1788 the data block pointer to the private options block. */
1790 if (data_block != NULL && (ol->type & opt_public) == 0)
1791 data_block = (void *)(((driver_instance *)data_block)->options_block);
1793 /* Now get the data according to the type. */
1797 /* If a string value is not enclosed in quotes, it consists of
1798 the rest of the current line, verbatim. Otherwise, string escapes
1801 A transport is specified as a string, which is then looked up in the
1802 list of transports. A search type is specified as one of a number of
1805 A set or rewrite rules for a driver is specified as a string, which is
1806 then parsed into a suitable chain of control blocks.
1808 Uids and gids are specified as strings which are then looked up in the
1809 passwd file. Lists of uids and gids are similarly specified as colon-
1810 separated strings. */
1815 case opt_expand_uid:
1816 case opt_expand_gid:
1821 reset_point = sptr = read_string(s, name);
1823 /* Having read a string, we now have several different ways of using it,
1824 depending on the data type, so do another switch. If keeping the actual
1825 string is not required (because it is interpreted), freesptr is set TRUE,
1826 and at the end we reset the pool. */
1830 /* If this was a string, set the variable to point to the new string,
1831 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1832 rules, we still keep the string (for printing), and parse the rules into a
1833 control block and flags word. */
1836 str_target = data_block ? USS (US data_block + (long int)(ol->value))
1838 if (ol->type & opt_rep_con)
1840 uschar * saved_condition;
1841 /* We already have a condition, we're conducting a crude hack to let
1842 multiple condition rules be chained together, despite storing them in
1844 *str_target = string_copy_malloc( (saved_condition = *str_target)
1845 ? string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1846 saved_condition, sptr)
1848 /* TODO(pdp): there is a memory leak here and just below
1849 when we set 3 or more conditions; I still don't
1850 understand the store mechanism enough to know
1851 what's the safe way to free content from an earlier store.
1852 AFAICT, stores stack, so freeing an early stored item also stores
1853 all data alloc'd after it. If we knew conditions were adjacent,
1854 we could survive that, but we don't. So I *think* we need to take
1855 another bit from opt_type to indicate "malloced"; this seems like
1856 quite a hack, especially for this one case. It also means that
1857 we can't ever reclaim the store from the *first* condition.
1859 Because we only do this once, near process start-up, I'm prepared to
1860 let this slide for the time being, even though it rankles. */
1862 else if (ol->type & opt_rep_str)
1864 uschar sep_o = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1865 int sep_i = -(int)sep_o;
1866 const uschar * list = sptr;
1868 uschar * list_o = *str_target;
1870 while ((s = string_nextinlist(&list, &sep_i, NULL, 0)))
1871 list_o = string_append_listele(list_o, sep_o, s);
1873 *str_target = string_copy_malloc(list_o);
1884 *USS (US data_block + (long int)(ol->value)) = sptr;
1886 *USS (ol->value) = sptr;
1888 if (type == opt_rewrite)
1893 rewrite_rule **chain;
1896 sprintf(CS name2, "*%.50s_rules", name);
1897 ol2 = find_option(name2, oltop, last);
1898 sprintf(CS name2, "*%.50s_flags", name);
1899 ol3 = find_option(name2, oltop, last);
1901 if (ol2 == NULL || ol3 == NULL)
1902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1903 "rewrite rules not available for driver");
1905 if (data_block == NULL)
1907 chain = (rewrite_rule **)(ol2->value);
1908 flagptr = (int *)(ol3->value);
1912 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1913 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1916 while ((p = string_nextinlist(CUSS &sptr, &sep, big_buffer, BIG_BUFFER_SIZE)))
1918 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1920 chain = &(next->next);
1923 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1924 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1925 "non-header rewrite - not allowed at transport time -");
1929 /* If it was an expanded uid, see if there is any expansion to be
1930 done by checking for the presence of a $ character. If there is, save it
1931 in the corresponding *expand_user option field. Otherwise, fall through
1932 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1935 case opt_expand_uid:
1936 sprintf(CS name2, "*expand_%.50s", name);
1937 ol2 = find_option(name2, oltop, last);
1940 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1942 if (data_block == NULL)
1943 *((uschar **)(ol2->value)) = ss;
1945 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1949 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1955 /* Look up a fixed uid, and also make use of the corresponding gid
1956 if a passwd entry is returned and the gid has not been set. */
1959 if (!route_finduser(sptr, &pw, &uid))
1960 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1961 if (data_block == NULL)
1962 *((uid_t *)(ol->value)) = uid;
1964 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1966 /* Set the flag indicating a fixed value is set */
1968 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1970 /* Handle matching gid if we have a passwd entry: done by finding the
1971 same name with terminating "user" changed to "group"; if not found,
1972 ignore. Also ignore if the value is already set. */
1974 if (pw == NULL) break;
1975 Ustrcpy(name+Ustrlen(name)-4, "group");
1976 ol2 = find_option(name, oltop, last);
1977 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1978 (ol2->type & opt_mask) == opt_expand_gid))
1980 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1983 if (data_block == NULL)
1984 *((gid_t *)(ol2->value)) = pw->pw_gid;
1986 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1992 /* If it was an expanded gid, see if there is any expansion to be
1993 done by checking for the presence of a $ character. If there is, save it
1994 in the corresponding *expand_user option field. Otherwise, fall through
1995 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1998 case opt_expand_gid:
1999 sprintf(CS name2, "*expand_%.50s", name);
2000 ol2 = find_option(name2, oltop, last);
2003 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
2005 if (data_block == NULL)
2006 *((uschar **)(ol2->value)) = ss;
2008 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
2012 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
2018 /* Handle freestanding gid */
2021 if (!route_findgroup(sptr, &gid))
2022 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
2023 if (data_block == NULL)
2024 *((gid_t *)(ol->value)) = gid;
2026 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
2027 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
2030 /* If it was a uid list, look up each individual entry, and build
2031 a vector of uids, with a count in the first element. Put the vector
2032 in malloc store so we can free the string. (We are reading into
2033 permanent store already.) */
2041 const uschar *op = expand_string (sptr);
2044 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2045 name, expand_string_message);
2048 if (*p != 0) count++;
2049 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2050 list = store_malloc(count*sizeof(uid_t));
2051 list[ptr++] = (uid_t)(count - 1);
2053 if (data_block == NULL)
2054 *((uid_t **)(ol->value)) = list;
2056 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2062 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2063 if (!route_finduser(big_buffer, NULL, &uid))
2064 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
2071 /* If it was a gid list, look up each individual entry, and build
2072 a vector of gids, with a count in the first element. Put the vector
2073 in malloc store so we can free the string. (We are reading into permanent
2082 const uschar *op = expand_string (sptr);
2085 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
2086 name, expand_string_message);
2089 if (*p != 0) count++;
2090 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
2091 list = store_malloc(count*sizeof(gid_t));
2092 list[ptr++] = (gid_t)(count - 1);
2094 if (data_block == NULL)
2095 *((gid_t **)(ol->value)) = list;
2097 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
2103 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
2104 if (!route_findgroup(big_buffer, &gid))
2105 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
2113 /* Release store if the value of the string doesn't need to be kept. */
2115 if (freesptr) store_reset(reset_point);
2118 /* Expanded boolean: if no characters follow, or if there are no dollar
2119 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
2120 save the string for later expansion in the alternate place. */
2122 case opt_expand_bool:
2123 if (*s != 0 && Ustrchr(s, '$') != 0)
2125 sprintf(CS name2, "*expand_%.50s", name);
2126 ol2 = find_option(name2, oltop, last);
2129 reset_point = sptr = read_string(s, name);
2130 if (data_block == NULL)
2131 *((uschar **)(ol2->value)) = sptr;
2133 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
2140 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
2141 look for yes/not/true/false. Some booleans are stored in a single bit in
2142 a single int. There's a special fudge for verify settings; without a suffix
2143 they set both xx_sender and xx_recipient. The table points to the sender
2144 value; search subsequently for the recipient. There's another special case:
2145 opt_bool_set also notes when a boolean has been set. */
2149 case opt_bool_verify:
2153 s = readconf_readname(name2, 64, s);
2154 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
2156 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
2158 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2159 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
2160 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
2161 US"for boolean option ", name);
2164 /* Handle single-bit type. */
2166 if (type == opt_bit)
2168 int bit = 1 << ((ol->type >> 16) & 31);
2169 int *ptr = (data_block == NULL)?
2170 (int *)(ol->value) :
2171 (int *)((uschar *)data_block + (long int)ol->value);
2172 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
2176 /* Handle full BOOL types */
2178 if (data_block == NULL)
2179 *((BOOL *)(ol->value)) = boolvalue;
2181 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
2185 if (type == opt_bool_verify)
2187 sprintf(CS name2, "%.50s_recipient", name + offset);
2188 ol2 = find_option(name2, oltop, last);
2191 if (data_block == NULL)
2192 *((BOOL *)(ol2->value)) = boolvalue;
2194 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
2198 /* Note that opt_bool_set type is set, if there is somewhere to do so */
2200 else if (type == opt_bool_set)
2202 sprintf(CS name2, "*set_%.50s", name + offset);
2203 ol2 = find_option(name2, oltop, last);
2206 if (data_block == NULL)
2207 *((BOOL *)(ol2->value)) = TRUE;
2209 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
2218 inttype = US"octal ";
2220 /* Integer: a simple(ish) case; allow octal and hex formats, and
2221 suffixes K, M and G. The different types affect output, not input. */
2230 lvalue = strtol(CS s, CSS &endptr, intbase);
2233 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2236 if (errno != ERANGE)
2237 if (tolower(*endptr) == 'k')
2239 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
2240 else lvalue *= 1024;
2243 else if (tolower(*endptr) == 'm')
2245 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
2247 else lvalue *= 1024*1024;
2250 else if (tolower(*endptr) == 'g')
2252 if (lvalue > INT_MAX/(1024*1024*1024) || lvalue < INT_MIN/(1024*1024*1024))
2254 else lvalue *= 1024*1024*1024;
2258 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
2259 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2260 "absolute value of integer \"%s\" is too large (overflow)", s);
2262 while (isspace(*endptr)) endptr++;
2264 extra_chars_error(endptr, inttype, US"integer value for ", name);
2266 value = (int)lvalue;
2269 if (data_block == NULL)
2270 *((int *)(ol->value)) = value;
2272 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2275 /* Integer held in K: again, allow octal and hex formats, and suffixes K, M
2277 /*XXX consider moving to int_eximarith_t (but mind the overflow test 0415) */
2283 value = strtol(CS s, CSS &endptr, intbase);
2286 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
2289 if (errno != ERANGE)
2290 if (tolower(*endptr) == 'g')
2292 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
2298 else if (tolower(*endptr) == 'm')
2300 if (value > INT_MAX/1024 || value < INT_MIN/1024)
2306 else if (tolower(*endptr) == 'k')
2309 value = (value + 512)/1024;
2311 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2312 "absolute value of integer \"%s\" is too large (overflow)", s);
2314 while (isspace(*endptr)) endptr++;
2316 extra_chars_error(endptr, inttype, US"integer value for ", name);
2319 if (data_block == NULL)
2320 *((int *)(ol->value)) = value;
2322 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2325 /* Fixed-point number: held to 3 decimal places. */
2328 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2330 "fixed-point number expected for %s", name);
2332 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2333 "integer \"%s\" is too large (overflow)", s);
2337 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2338 "integer \"%s\" is too large (overflow)", s);
2340 /* We get a coverity error here for using count, as it derived
2341 from the tainted buffer pointed to by s, as parsed by sscanf().
2342 By the definition of sscanf we must be aceessing between start
2343 and end of s (assuming it is nul-terminated...) so ignore the error. */
2344 /* coverity[tainted_data] */
2345 if (s[count] == '.')
2348 while (isdigit(s[++count]))
2350 value += (s[count] - '0') * d;
2355 while (isspace(s[count])) count++;
2358 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2360 if (data_block == NULL)
2361 *((int *)(ol->value)) = value;
2363 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2366 /* There's a special routine to read time values. */
2369 value = readconf_readtime(s, 0, FALSE);
2371 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2373 if (data_block == NULL)
2374 *((int *)(ol->value)) = value;
2376 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2379 /* A time list is a list of colon-separated times, with the first
2380 element holding the size of the list and the second the number of
2386 int *list = (data_block == NULL)?
2387 (int *)(ol->value) :
2388 (int *)((uschar *)data_block + (long int)(ol->value));
2390 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2393 uschar *snext = Ustrchr(s, ':');
2397 while (ss > s && isspace(ss[-1])) ss--;
2400 value = readconf_readtime(s, terminator, FALSE);
2402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2404 if (count > 1 && value <= list[count])
2405 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2406 "time value out of order for %s", name);
2407 list[count+1] = value;
2408 if (snext == NULL) break;
2410 while (isspace(*s)) s++;
2413 if (count > list[0] - 2)
2414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2416 if (count > 0 && list[2] == 0) count = 0;
2423 void (*fn)() = ol->value;
2434 /*************************************************
2435 * Print a time value *
2436 *************************************************/
2439 Argument: a time value in seconds
2440 Returns: pointer to a fixed buffer containing the time as a string,
2441 in readconf_readtime() format
2445 readconf_printtime(int t)
2448 uschar *p = time_buffer;
2465 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2466 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2467 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2468 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2469 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2476 /*************************************************
2477 * Print an individual option value *
2478 *************************************************/
2480 /* This is used by the -bP option, so prints to the standard output.
2481 The entire options list is passed in as an argument, because some options come
2482 in pairs - typically uid/gid settings, which can either be explicit numerical
2483 values, or strings to be expanded later. If the numerical value is unset,
2484 search for "*expand_<name>" to see if there is a string equivalent.
2487 ol option entry, or NULL for an unknown option
2489 options_block NULL for main configuration options; otherwise points to
2490 a driver block; if the option doesn't have opt_public
2491 set, then options_block->options_block is where the item
2493 oltop points to the option list in which ol exists
2494 last one more than the offset of the last entry in optop
2495 no_labels do not show "foo = " at the start.
2501 print_ol(optionlist *ol, uschar *name, void *options_block,
2502 optionlist *oltop, int last, BOOL no_labels)
2515 printf("%s is not a known option\n", name);
2519 /* Non-admin callers cannot see options that have been flagged secure by the
2522 if (!admin_user && (ol->type & opt_secure) != 0)
2525 printf("%s\n", hidden);
2527 printf("%s = %s\n", name, hidden);
2531 /* Else show the value of the option */
2534 if (options_block != NULL)
2536 if ((ol->type & opt_public) == 0)
2537 options_block = (void *)(((driver_instance *)options_block)->options_block);
2538 value = (void *)((uschar *)options_block + (long int)value);
2541 switch(ol->type & opt_mask)
2544 case opt_rewrite: /* Show the text value */
2545 s = *((uschar **)value);
2546 if (!no_labels) printf("%s = ", name);
2547 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2551 if (!no_labels) printf("%s = ", name);
2552 printf("%d\n", *((int *)value));
2557 int x = *((int *)value);
2558 if (x != 0 && (x & 1023) == 0)
2562 if ((x & 1023) == 0)
2567 if (!no_labels) printf("%s = ", name);
2568 printf("%d%c\n", x, c);
2572 if (!no_labels) printf("%s = ", name);
2580 int x = *((int *)value);
2581 if (!no_labels) printf("%s = ", name);
2582 if (x == 0) printf("0\n");
2583 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2584 else printf("%dK\n", x);
2589 if (!no_labels) printf("%s = ", name);
2590 printf("%#o\n", *((int *)value));
2593 /* Can be negative only when "unset", in which case integer */
2597 int x = *((int *)value);
2600 if (x < 0) printf("%s =\n", name); else
2602 if (!no_labels) printf("%s = ", name);
2603 printf("%d.", x/1000);
2616 /* If the numerical value is unset, try for the string value */
2618 case opt_expand_uid:
2619 if (! *get_set_flag(name, oltop, last, options_block))
2621 sprintf(CS name2, "*expand_%.50s", name);
2622 ol2 = find_option(name2, oltop, last);
2625 void *value2 = ol2->value;
2626 if (options_block != NULL)
2627 value2 = (void *)((uschar *)options_block + (long int)value2);
2628 s = *((uschar **)value2);
2629 if (!no_labels) printf("%s = ", name);
2630 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2635 /* Else fall through */
2638 if (!no_labels) printf("%s = ", name);
2639 if (! *get_set_flag(name, oltop, last, options_block))
2643 pw = getpwuid(*((uid_t *)value));
2645 printf("%ld\n", (long int)(*((uid_t *)value)));
2646 else printf("%s\n", pw->pw_name);
2650 /* If the numerical value is unset, try for the string value */
2652 case opt_expand_gid:
2653 if (! *get_set_flag(name, oltop, last, options_block))
2655 sprintf(CS name2, "*expand_%.50s", name);
2656 ol2 = find_option(name2, oltop, last);
2657 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2659 void *value2 = ol2->value;
2660 if (options_block != NULL)
2661 value2 = (void *)((uschar *)options_block + (long int)value2);
2662 s = *((uschar **)value2);
2663 if (!no_labels) printf("%s = ", name);
2664 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2669 /* Else fall through */
2672 if (!no_labels) printf("%s = ", name);
2673 if (! *get_set_flag(name, oltop, last, options_block))
2677 gr = getgrgid(*((int *)value));
2679 printf("%ld\n", (long int)(*((int *)value)));
2680 else printf("%s\n", gr->gr_name);
2685 uidlist = *((uid_t **)value);
2686 if (!no_labels) printf("%s =", name);
2687 if (uidlist != NULL)
2691 if (no_labels) sep = '\0';
2692 for (i = 1; i <= (int)(uidlist[0]); i++)
2694 uschar *name = NULL;
2695 pw = getpwuid(uidlist[i]);
2696 if (pw != NULL) name = US pw->pw_name;
2697 if (sep != '\0') printf("%c", sep);
2698 if (name != NULL) printf("%s", name);
2699 else printf("%ld", (long int)(uidlist[i]));
2707 gidlist = *((gid_t **)value);
2708 if (!no_labels) printf("%s =", name);
2709 if (gidlist != NULL)
2713 if (no_labels) sep = '\0';
2714 for (i = 1; i <= (int)(gidlist[0]); i++)
2716 uschar *name = NULL;
2717 gr = getgrgid(gidlist[i]);
2718 if (gr != NULL) name = US gr->gr_name;
2719 if (sep != '\0') printf("%c", sep);
2720 if (name != NULL) printf("%s", name);
2721 else printf("%ld", (long int)(gidlist[i]));
2729 if (!no_labels) printf("%s = ", name);
2730 printf("%s\n", readconf_printtime(*((int *)value)));
2736 int *list = (int *)value;
2737 if (!no_labels) printf("%s = ", name);
2738 for (i = 0; i < list[1]; i++)
2739 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2745 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2749 case opt_expand_bool:
2750 sprintf(CS name2, "*expand_%.50s", name);
2751 ol2 = find_option(name2, oltop, last);
2752 if (ol2 != NULL && ol2->value != NULL)
2754 void *value2 = ol2->value;
2755 if (options_block != NULL)
2756 value2 = (void *)((uschar *)options_block + (long int)value2);
2757 s = *((uschar **)value2);
2760 if (!no_labels) printf("%s = ", name);
2761 printf("%s\n", string_printing(s));
2764 /* s == NULL => string not set; fall through */
2770 case opt_bool_verify:
2772 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2779 /*************************************************
2780 * Print value from main configuration *
2781 *************************************************/
2783 /* This function, called as a result of encountering the -bP option,
2784 causes the value of any main configuration variable to be output if the
2785 second argument is NULL. There are some special values:
2787 all print all main configuration options
2788 config_file print the name of the configuration file
2789 (configure_file will still work, for backward
2791 routers print the routers' configurations
2792 transports print the transports' configuration
2793 authenticators print the authenticators' configuration
2794 macros print the macros' configuration
2795 router_list print a list of router names
2796 transport_list print a list of transport names
2797 authenticator_list print a list of authentication mechanism names
2798 macro_list print a list of macro names
2799 +name print a named list item
2800 local_scan print the local_scan options
2801 config print the configuration as it is parsed
2802 environment print the used execution environment
2804 If the second argument is not NULL, it must be one of "router", "transport",
2805 "authenticator" or "macro" in which case the first argument identifies the
2806 driver whose options are to be printed.
2809 name option name if type == NULL; else driver name
2810 type NULL or driver type name, as described above
2811 no_labels avoid the "foo = " at the start of an item
2817 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2819 BOOL names_only = FALSE;
2821 optionlist *ol2 = NULL;
2822 driver_instance *d = NULL;
2833 static uschar *types[] = { US"address", US"domain", US"host",
2835 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2836 &hostlist_anchor, &localpartlist_anchor };
2838 for (i = 0; i < 4; i++)
2840 t = tree_search(*(anchors[i]), name+1);
2845 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2847 printf("%slist %s = %s\n", types[i], name+1,
2848 ((namedlist_block *)(t->data.ptr))->string);
2853 printf("no address, domain, host, or local part list called \"%s\" "
2854 "exists\n", name+1);
2859 if ( Ustrcmp(name, "configure_file") == 0
2860 || Ustrcmp(name, "config_file") == 0)
2862 printf("%s\n", CS config_main_filename);
2866 if (Ustrcmp(name, "all") == 0)
2868 for (ol = optionlist_config;
2869 ol < optionlist_config + nelem(optionlist_config); ol++)
2871 if ((ol->type & opt_hidden) == 0)
2872 print_ol(ol, US ol->name, NULL,
2873 optionlist_config, nelem(optionlist_config),
2879 if (Ustrcmp(name, "local_scan") == 0)
2881 #ifndef LOCAL_SCAN_HAS_OPTIONS
2882 printf("local_scan() options are not supported\n");
2884 for (ol = local_scan_options;
2885 ol < local_scan_options + local_scan_options_count; ol++)
2887 print_ol(ol, US ol->name, NULL, local_scan_options,
2888 local_scan_options_count, no_labels);
2894 if (Ustrcmp(name, "config") == 0)
2896 print_config(admin_user, no_labels);
2900 if (Ustrcmp(name, "routers") == 0)
2905 else if (Ustrcmp(name, "transports") == 0)
2907 type = US"transport";
2911 else if (Ustrcmp(name, "authenticators") == 0)
2913 type = US"authenticator";
2917 else if (Ustrcmp(name, "macros") == 0)
2923 else if (Ustrcmp(name, "router_list") == 0)
2930 else if (Ustrcmp(name, "transport_list") == 0)
2932 type = US"transport";
2937 else if (Ustrcmp(name, "authenticator_list") == 0)
2939 type = US"authenticator";
2944 else if (Ustrcmp(name, "macro_list") == 0)
2951 else if (Ustrcmp(name, "environment") == 0)
2956 for (p = USS environ; *p; p++) ;
2957 qsort(environ, p - USS environ, sizeof(*p), string_compare_by_pointer);
2959 for (p = USS environ; *p; p++)
2962 if (no_labels && (q = Ustrchr(*p, '='))) *q = '\0';
2971 print_ol(find_option(name, optionlist_config, nelem(optionlist_config)),
2972 name, NULL, optionlist_config, nelem(optionlist_config), no_labels);
2977 /* Handle the options for a router or transport. Skip options that are flagged
2978 as hidden. Some of these are options with names starting with '*', used for
2979 internal alternative representations of other options (which the printing
2980 function will sort out). Others are synonyms kept for backward compatibility.
2983 if (Ustrcmp(type, "router") == 0)
2985 d = (driver_instance *)routers;
2986 ol2 = optionlist_routers;
2987 size = optionlist_routers_size;
2989 else if (Ustrcmp(type, "transport") == 0)
2991 d = (driver_instance *)transports;
2992 ol2 = optionlist_transports;
2993 size = optionlist_transports_size;
2995 else if (Ustrcmp(type, "authenticator") == 0)
2997 d = (driver_instance *)auths;
2998 ol2 = optionlist_auths;
2999 size = optionlist_auths_size;
3002 else if (Ustrcmp(type, "macro") == 0)
3004 /* People store passwords in macros and they were previously not available
3005 for printing. So we have an admin_users restriction. */
3008 fprintf(stderr, "exim: permission denied\n");
3011 if (!macros_builtin_created) macros_create_builtin();
3012 for (m = macros; m; m = m->next)
3013 if (!name || Ustrcmp(name, m->name) == 0)
3016 printf("%s\n", CS m->name);
3018 printf("%s=%s\n", CS m->name, CS m->replacement);
3023 printf("%s %s not found\n", type, name);
3029 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
3033 /* Either search for a given driver, or print all of them */
3035 for (; d != NULL; d = d->next)
3038 printf("\n%s %s:\n", d->name, type);
3039 else if (Ustrcmp(d->name, name) != 0) continue;
3041 for (ol = ol2; ol < ol2 + size; ol++)
3043 if ((ol->type & opt_hidden) == 0)
3044 print_ol(ol, US ol->name, d, ol2, size, no_labels);
3047 for (ol = d->info->options;
3048 ol < d->info->options + *(d->info->options_count); ol++)
3050 if ((ol->type & opt_hidden) == 0)
3051 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
3053 if (name != NULL) return;
3055 if (name != NULL) printf("%s %s not found\n", type, name);
3060 /*************************************************
3061 * Read a named list item *
3062 *************************************************/
3064 /* This function reads a name and a list (i.e. string). The name is used to
3065 save the list in a tree, sorted by its name. Each entry also has a number,
3066 which can be used for caching tests, but if the string contains any expansion
3067 items other than $key, the number is set negative to inhibit caching. This
3068 mechanism is used for domain, host, and address lists that are referenced by
3072 anchorp points to the tree anchor
3073 numberp points to the current number for this tree
3074 max the maximum number permitted
3075 s the text of the option line, starting immediately after the name
3077 tname the name of the list type, for messages
3083 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
3086 BOOL forcecache = FALSE;
3089 namedlist_block *nb = store_get(sizeof(namedlist_block));
3091 if (Ustrncmp(s, "_cache", 6) == 0)
3098 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
3100 if (*numberp >= max)
3101 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
3104 while (isspace(*s)) s++;
3106 while (isalnum(*s) || *s == '_') s++;
3107 t = store_get(sizeof(tree_node) + s-ss);
3108 Ustrncpy(t->name, ss, s-ss);
3110 while (isspace(*s)) s++;
3112 if (!tree_insertnode(anchorp, t))
3113 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3114 "duplicate name \"%s\" for a named %s", t->name, tname);
3117 nb->number = *numberp;
3120 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3121 "missing '=' after \"%s\"", t->name);
3122 while (isspace(*s)) s++;
3123 nb->string = read_string(s, t->name);
3124 nb->cache_data = NULL;
3126 /* Check the string for any expansions; if any are found, mark this list
3127 uncacheable unless the user has explicited forced caching. */
3129 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
3135 /*************************************************
3136 * Unpick data for a rate limit *
3137 *************************************************/
3139 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
3143 s string, in the form t,b,f,l
3144 where t is the threshold (integer)
3145 b is the initial delay (time)
3146 f is the multiplicative factor (fixed point)
3147 k is the maximum time (time)
3148 threshold where to store threshold
3149 base where to store base in milliseconds
3150 factor where to store factor in milliseconds
3151 limit where to store limit
3153 Returns: nothing (panics on error)
3157 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
3160 uschar bstring[16], lstring[16];
3162 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
3163 factor, lstring) == 4)
3165 *base = readconf_readtime(bstring, 0, TRUE);
3166 *limit = readconf_readtime(lstring, 0, TRUE);
3167 if (*base >= 0 && *limit >= 0) return;
3169 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
3175 /*************************************************
3176 * Drop privs for checking TLS config *
3177 *************************************************/
3179 /* We want to validate TLS options during readconf, but do not want to be
3180 root when we call into the TLS library, in case of library linkage errors
3181 which cause segfaults; before this check, those were always done as the Exim
3182 runtime user and it makes sense to continue with that.
3184 Assumes: tls_require_ciphers has been set, if it will be
3185 exim_user has been set, if it will be
3186 exim_group has been set, if it will be
3188 Returns: bool for "okay"; false will cause caller to immediately exit.
3193 tls_dropprivs_validate_require_cipher(BOOL nowarn)
3195 const uschar *errmsg;
3198 void (*oldsignal)(int);
3200 /* If TLS will never be used, no point checking ciphers */
3202 if ( !tls_advertise_hosts
3203 || !*tls_advertise_hosts
3204 || Ustrcmp(tls_advertise_hosts, ":") == 0
3207 else if (!nowarn && !tls_certificate)
3208 log_write(0, LOG_MAIN,
3209 "Warning: No server certificate defined; will use a selfsigned one.\n"
3210 " Suggested action: either install a certificate or change tls_advertise_hosts option");
3212 oldsignal = signal(SIGCHLD, SIG_DFL);
3215 if ((pid = fork()) < 0)
3216 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
3220 /* in some modes, will have dropped privilege already */
3222 exim_setugid(exim_uid, exim_gid, FALSE,
3223 US"calling tls_validate_require_cipher");
3225 errmsg = tls_validate_require_cipher();
3228 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3229 "tls_require_ciphers invalid: %s", errmsg);
3236 rc = waitpid(pid, &status, 0);
3237 } while (rc < 0 && errno == EINTR);
3240 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
3243 signal(SIGCHLD, oldsignal);
3247 #endif /* SUPPORT_TLS */
3252 /*************************************************
3253 * Read main configuration options *
3254 *************************************************/
3256 /* This function is the first to be called for configuration reading. It
3257 opens the configuration file and reads general configuration settings until
3258 it reaches the end of the configuration section. The file is then left open so
3259 that the remaining configuration data can subsequently be read if needed for
3262 The configuration file must be owned either by root or exim, and be writeable
3263 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
3264 in the config file, so the test is done on the compiled in values. A slight
3265 anomaly, to be carefully documented.
3267 The name of the configuration file is taken from a list that is included in the
3268 binary of Exim. It can be altered from the command line, but if that is done,
3269 root privilege is immediately withdrawn unless the caller is root or exim.
3270 The first file on the list that exists is used.
3272 For use on multiple systems that share file systems, first look for a
3273 configuration file whose name has the current node name on the end. If that is
3274 not found, try the generic name. For really contorted configurations, that run
3275 multiple Exims with different uid settings, first try adding the effective uid
3276 before the node name. These complications are going to waste resources on most
3277 systems. Therefore they are available only when requested by compile-time
3281 readconf_main(BOOL nowarn)
3284 struct stat statbuf;
3285 uschar *s, *filename;
3286 const uschar *list = config_main_filelist;
3288 /* Loop through the possible file names */
3290 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
3293 /* Cut out all the fancy processing unless specifically wanted */
3295 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
3296 uschar *suffix = filename + Ustrlen(filename);
3298 /* Try for the node-specific file if a node name exists */
3300 #ifdef CONFIGURE_FILE_USE_NODE
3302 if (uname(&uts) >= 0)
3304 #ifdef CONFIGURE_FILE_USE_EUID
3305 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
3306 config_file = Ufopen(filename, "rb");
3307 if (config_file == NULL)
3308 #endif /* CONFIGURE_FILE_USE_EUID */
3310 sprintf(CS suffix, ".%.256s", uts.nodename);
3311 config_file = Ufopen(filename, "rb");
3314 #endif /* CONFIGURE_FILE_USE_NODE */
3316 /* Otherwise, try the generic name, possibly with the euid added */
3318 #ifdef CONFIGURE_FILE_USE_EUID
3319 if (config_file == NULL)
3321 sprintf(CS suffix, ".%ld", (long int)original_euid);
3322 config_file = Ufopen(filename, "rb");
3324 #endif /* CONFIGURE_FILE_USE_EUID */
3326 /* Finally, try the unadorned name */
3328 if (config_file == NULL)
3331 config_file = Ufopen(filename, "rb");
3333 #else /* if neither defined */
3335 /* This is the common case when the fancy processing is not included. */
3337 config_file = Ufopen(filename, "rb");
3340 /* If the file does not exist, continue to try any others. For any other
3341 error, break out (and die). */
3343 if (config_file != NULL || errno != ENOENT) break;
3346 /* Now, once we found and opened our configuration file, we change the directory
3347 to a safe place. Later we change to $spool_directory. */
3349 if (Uchdir("/") < 0)
3351 perror("exim: chdir `/': ");
3355 /* On success, save the name for verification; config_filename is used when
3356 logging configuration errors (it changes for .included files) whereas
3357 config_main_filename is the name shown by -bP. Failure to open a configuration
3358 file is a serious disaster. */
3360 if (config_file != NULL)
3363 config_filename = config_main_filename = string_copy(filename);
3365 p = Ustrrchr(filename, '/');
3366 config_main_directory = p ? string_copyn(filename, p - filename)
3367 : string_copy(US".");
3371 if (filename == NULL)
3372 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3373 "%s", config_main_filelist);
3375 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3376 "configuration file %s", filename));
3379 /* Check the status of the file we have opened, if we have retained root
3380 privileges and the file isn't /dev/null (which *should* be 0666). */
3382 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3384 if (fstat(fileno(config_file), &statbuf) != 0)
3385 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3388 if ((statbuf.st_uid != root_uid /* owner not root */
3389 #ifdef CONFIGURE_OWNER
3390 && statbuf.st_uid != config_uid /* owner not the special one */
3393 (statbuf.st_gid != root_gid /* group not root & */
3394 #ifdef CONFIGURE_GROUP
3395 && statbuf.st_gid != config_gid /* group not the special one */
3397 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3399 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3401 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3402 "wrong owner, group, or mode", big_buffer);
3405 /* Process the main configuration settings. They all begin with a lower case
3406 letter. If we see something starting with an upper case letter, it is taken as
3407 a macro definition. */
3409 while ((s = get_config_line()) != NULL)
3411 if (isupper(s[0])) read_macro_assignment(s);
3413 else if (Ustrncmp(s, "domainlist", 10) == 0)
3414 read_named_list(&domainlist_anchor, &domainlist_count,
3415 MAX_NAMED_LIST, s+10, US"domain list");
3417 else if (Ustrncmp(s, "hostlist", 8) == 0)
3418 read_named_list(&hostlist_anchor, &hostlist_count,
3419 MAX_NAMED_LIST, s+8, US"host list");
3421 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3422 read_named_list(&addresslist_anchor, &addresslist_count,
3423 MAX_NAMED_LIST, s+11, US"address list");
3425 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3426 read_named_list(&localpartlist_anchor, &localpartlist_count,
3427 MAX_NAMED_LIST, s+13, US"local part list");
3430 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3431 NULL, US"main option \"%s\" unknown");
3435 /* If local_sender_retain is set, local_from_check must be unset. */
3437 if (local_sender_retain && local_from_check)
3438 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3439 "local_sender_retain are set; this combination is not allowed");
3441 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3444 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3446 /* The max retry interval must not be greater than 24 hours. */
3448 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3450 /* remote_max_parallel must be > 0 */
3452 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3454 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3455 start of a new SMTP message. */
3457 freeze_tell_config = freeze_tell;
3459 /* The primary host name may be required for expansion of spool_directory
3460 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3461 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3462 canonize it. Some people like upper case letters in their host names, so we
3463 don't force the case. */
3465 if (primary_hostname == NULL)
3467 const uschar *hostname;
3469 if (uname(&uts) < 0)
3470 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3471 hostname = US uts.nodename;
3473 if (Ustrchr(hostname, '.') == NULL)
3476 struct hostent *hostdata;
3479 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3480 match_isinlist(hostname, CUSS &dns_ipv4_lookup, 0, NULL, NULL,
3481 MCL_DOMAIN, TRUE, NULL) != OK))
3490 #if HAVE_GETIPNODEBYNAME
3492 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3494 hostdata = gethostbyname2(CS hostname, af);
3497 hostdata = gethostbyname(CS hostname);
3500 if (hostdata != NULL)
3502 hostname = US hostdata->h_name;
3506 if (af == AF_INET) break;
3511 primary_hostname = string_copy(hostname);
3514 /* Set up default value for smtp_active_hostname */
3516 smtp_active_hostname = primary_hostname;
3518 /* If spool_directory wasn't set in the build-time configuration, it must have
3519 got set above. Of course, writing to the log may not work if log_file_path is
3520 not set, but it will at least get to syslog or somewhere, with any luck. */
3522 if (*spool_directory == 0)
3523 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3526 /* Expand the spool directory name; it may, for example, contain the primary
3527 host name. Same comment about failure. */
3529 s = expand_string(spool_directory);
3531 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3532 "\"%s\": %s", spool_directory, expand_string_message);
3533 spool_directory = s;
3535 /* Expand log_file_path, which must contain "%s" in any component that isn't
3536 the null string or "syslog". It is also allowed to contain one instance of %D
3537 or %M. However, it must NOT contain % followed by anything else. */
3539 if (*log_file_path != 0)
3541 const uschar *ss, *sss;
3542 int sep = ':'; /* Fixed for log file path */
3543 s = expand_string(log_file_path);
3545 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3546 "\"%s\": %s", log_file_path, expand_string_message);
3549 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3552 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3553 t = Ustrstr(sss, "%s");
3555 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3556 "contain \"%%s\"", sss);
3558 t = Ustrchr(sss, '%');
3561 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3562 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3563 "unexpected \"%%\" character", s);
3570 /* Interpret syslog_facility into an integer argument for 'ident' param to
3571 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3574 if (syslog_facility_str != NULL)
3577 uschar *s = syslog_facility_str;
3579 if ((Ustrlen(syslog_facility_str) >= 4) &&
3580 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3583 for (i = 0; i < syslog_list_size; i++)
3585 if (strcmpic(s, syslog_list[i].name) == 0)
3587 syslog_facility = syslog_list[i].value;
3592 if (i >= syslog_list_size)
3594 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3595 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3599 /* Expand pid_file_path */
3601 if (*pid_file_path != 0)
3603 s = expand_string(pid_file_path);
3605 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3606 "\"%s\": %s", pid_file_path, expand_string_message);
3610 /* Set default value of process_log_path */
3612 if (process_log_path == NULL || *process_log_path =='\0')
3613 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3615 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3618 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3620 /* Unpick the SMTP rate limiting options, if set */
3622 if (smtp_ratelimit_mail != NULL)
3624 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3625 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3628 if (smtp_ratelimit_rcpt != NULL)
3630 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3631 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3634 /* The qualify domains default to the primary host name */
3636 if (qualify_domain_sender == NULL)
3637 qualify_domain_sender = primary_hostname;
3638 if (qualify_domain_recipient == NULL)
3639 qualify_domain_recipient = qualify_domain_sender;
3641 /* Setting system_filter_user in the configuration sets the gid as well if a
3642 name is given, but a numerical value does not. */
3644 if (system_filter_uid_set && !system_filter_gid_set)
3646 struct passwd *pw = getpwuid(system_filter_uid);
3648 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3649 (long int)system_filter_uid);
3650 system_filter_gid = pw->pw_gid;
3651 system_filter_gid_set = TRUE;
3654 /* If the errors_reply_to field is set, check that it is syntactically valid
3655 and ensure it contains a domain. */
3657 if (errors_reply_to != NULL)
3660 int start, end, domain;
3661 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3662 &start, &end, &domain, FALSE);
3664 if (recipient == NULL)
3665 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3666 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3670 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3673 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3674 smtp_accept_max must also be set. */
3676 if (smtp_accept_max == 0 &&
3677 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3678 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3679 "smtp_accept_max must be set if smtp_accept_queue or "
3680 "smtp_accept_max_per_host is set");
3682 /* Set up the host number if anything is specified. It is an expanded string
3683 so that it can be computed from the host name, for example. We do this last
3684 so as to ensure that everything else is set up before the expansion. */
3686 if (host_number_string != NULL)
3690 uschar *s = expand_string(host_number_string);
3692 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3693 "failed to expand localhost_number \"%s\": %s",
3694 host_number_string, expand_string_message);
3695 n = Ustrtol(s, &end, 0);
3696 while (isspace(*end)) end++;
3698 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3699 "localhost_number value is not a number: %s", s);
3700 if (n > LOCALHOST_MAX)
3701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3702 "localhost_number is greater than the maximum allowed value (%d)",
3708 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3710 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3711 tls_verify_certificates == NULL)
3712 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3713 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3714 (tls_verify_hosts != NULL)? "" : "try_");
3716 /* This also checks that the library linkage is working and we can call
3717 routines in it, so call even if tls_require_ciphers is unset */
3718 if (!tls_dropprivs_validate_require_cipher(nowarn))
3721 /* Magic number: at time of writing, 1024 has been the long-standing value
3722 used by so many clients, and what Exim used to use always, that it makes
3723 sense to just min-clamp this max-clamp at that. */
3724 if (tls_dh_max_bits < 1024)
3725 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3726 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3728 /* If openssl_options is set, validate it */
3729 if (openssl_options != NULL)
3732 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3733 "openssl_options is set but we're using GnuTLS");
3736 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3737 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3738 "openssl_options parse error: %s", openssl_options);
3741 #endif /*SUPPORT_TLS*/
3743 if (!nowarn && !keep_environment && environ && *environ)
3744 log_write(0, LOG_MAIN,
3745 "Warning: purging the environment.\n"
3746 " Suggested action: use keep_environment.");
3751 /*************************************************
3752 * Initialize one driver *
3753 *************************************************/
3755 /* This is called once the driver's generic options, if any, have been read.
3756 We can now find the driver, set up defaults for the private options, and
3757 unset any "set" bits in the private options table (which might have been
3758 set by another incarnation of the same driver).
3761 d pointer to driver instance block, with generic
3763 drivers_available vector of available drivers
3764 size_of_info size of each block in drivers_available
3765 class class of driver, for error message
3767 Returns: pointer to the driver info block
3770 static driver_info *
3771 init_driver(driver_instance *d, driver_info *drivers_available,
3772 int size_of_info, uschar *class)
3776 for (dd = drivers_available; dd->driver_name[0] != 0;
3777 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3779 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3782 int len = dd->options_len;
3784 d->options_block = store_get(len);
3785 memcpy(d->options_block, dd->options_block, len);
3786 for (i = 0; i < *(dd->options_count); i++)
3787 dd->options[i].type &= ~opt_set;
3792 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3793 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3795 return NULL; /* never obeyed */
3801 /*************************************************
3802 * Initialize driver list *
3803 *************************************************/
3805 /* This function is called for routers, transports, and authentication
3806 mechanisms. It reads the data from the current point in the configuration file
3807 up to the end of the section, and sets up a chain of instance blocks according
3808 to the file's contents. The file will already have been opened by a call to
3809 readconf_main, and must be left open for subsequent reading of further data.
3811 Any errors cause a panic crash. Note that the blocks with names driver_info and
3812 driver_instance must map the first portions of all the _info and _instance
3813 blocks for this shared code to work.
3816 class "router", "transport", or "authenticator"
3817 anchor &routers, &transports, &auths
3818 drivers_available available drivers
3819 size_of_info size of each info block
3820 instance_default points to default data for an instance
3821 instance_size size of instance block
3822 driver_optionlist generic option list
3823 driver_optionlist_count count of generic option list
3829 readconf_driver_init(
3831 driver_instance **anchor,
3832 driver_info *drivers_available,
3834 void *instance_default,
3836 optionlist *driver_optionlist,
3837 int driver_optionlist_count)
3839 driver_instance **p = anchor;
3840 driver_instance *d = NULL;
3843 while ((buffer = get_config_line()) != NULL)
3848 /* Read the first name on the line and test for the start of a new driver. A
3849 macro definition indicates the end of the previous driver. If this isn't the
3850 start of a new driver, the line will be re-read. */
3852 s = readconf_readname(name, sizeof(name), buffer);
3854 /* Handle macro definition, first finishing off the initialization of the
3855 previous driver, if any. */
3857 if (isupper(*name) && *s == '=')
3861 if (!d->driver_name)
3862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3863 "no driver defined for %s \"%s\"", class, d->name);
3867 read_macro_assignment(buffer);
3871 /* If the line starts with a name terminated by a colon, we are at the
3872 start of the definition of a new driver. The rest of the line must be
3879 /* Finish off initializing the previous driver. */
3883 if (!d->driver_name)
3884 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3885 "no driver defined for %s \"%s\"", class, d->name);
3889 /* Check that we haven't already got a driver of this name */
3891 for (d = *anchor; d; d = d->next)
3892 if (Ustrcmp(name, d->name) == 0)
3893 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3894 "there are two %ss called \"%s\"", class, name);
3896 /* Set up a new driver instance data block on the chain, with
3897 its default values installed. */
3899 d = store_get(instance_size);
3900 memcpy(d, instance_default, instance_size);
3903 d->name = string_copy(name);
3905 /* Clear out the "set" bits in the generic options */
3907 for (i = 0; i < driver_optionlist_count; i++)
3908 driver_optionlist[i].type &= ~opt_set;
3910 /* Check nothing more on this line, then do the next loop iteration. */
3912 while (isspace(*s)) s++;
3913 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3917 /* Not the start of a new driver. Give an error if we have not set up a
3918 current driver yet. */
3921 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s name missing", class);
3923 /* First look to see if this is a generic option; if it is "driver",
3924 initialize the driver. If is it not a generic option, we can look for a
3925 private option provided that the driver has been previously set up. */
3927 if (readconf_handle_option(buffer, driver_optionlist,
3928 driver_optionlist_count, d, NULL))
3930 if (!d->info && d->driver_name)
3931 init_driver(d, drivers_available, size_of_info, class);
3934 /* Handle private options - pass the generic block because some may
3935 live therein. A flag with each option indicates if it is in the public
3939 readconf_handle_option(buffer, d->info->options,
3940 *(d->info->options_count), d, US"option \"%s\" unknown");
3942 /* The option is not generic and the driver name has not yet been given. */
3944 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3945 "(\"driver\" must be specified before any private options)", name);
3948 /* Run the initialization function for the final driver. */
3952 if (!d->driver_name)
3953 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3954 "no driver defined for %s \"%s\"", class, d->name);
3961 /*************************************************
3962 * Check driver dependency *
3963 *************************************************/
3965 /* This function is passed a driver instance and a string. It checks whether
3966 any of the string options for the driver contains the given string as an
3970 d points to a driver instance block
3971 s the string to search for
3973 Returns: TRUE if a dependency is found
3977 readconf_depends(driver_instance *d, uschar *s)
3979 int count = *(d->info->options_count);
3983 for (ol = d->info->options; ol < d->info->options + count; ol++)
3985 void *options_block;
3987 int type = ol->type & opt_mask;
3988 if (type != opt_stringptr) continue;
3989 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3990 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3991 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3993 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3994 isalnum(ss[Ustrlen(s)])) continue;
3995 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3996 d->name, ol->name, s);
4001 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
4008 /*************************************************
4009 * Decode an error type for retries *
4010 *************************************************/
4012 /* This function is global because it is also called from the main
4013 program when testing retry information. It decodes strings such as "quota_7d"
4014 into numerical error codes.
4017 pp points to start of text
4018 p points past end of text
4019 basic_errno points to an int to receive the main error number
4020 more_errno points to an int to receive the secondary error data
4022 Returns: NULL if decoded correctly; else points to error text
4026 readconf_retry_error(const uschar *pp, const uschar *p,
4027 int *basic_errno, int *more_errno)
4030 const uschar *q = pp;
4031 while (q < p && *q != '_') q++;
4034 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
4036 *basic_errno = ERRNO_EXIMQUOTA;
4037 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
4038 return US"bad time value";
4041 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
4043 *basic_errno = ECONNREFUSED;
4046 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
4047 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
4048 else return US"A or MX expected after \"refused\"";
4052 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
4054 *basic_errno = ETIMEDOUT;
4058 int xlen = p - q - 1;
4059 const uschar *x = q + 1;
4061 static uschar *extras[] =
4062 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
4063 static int values[] =
4064 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
4066 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
4067 if (strncmpic(x, extras[i], xlen) == 0)
4069 *more_errno = values[i];
4073 if (i >= sizeof(extras)/sizeof(uschar *))
4074 if (strncmpic(x, US"DNS", xlen) == 0)
4075 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
4076 "available in retry rules (it has never worked) - treated as "
4079 return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
4083 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
4084 strncmpic(pp, US"rcpt_4", 6) == 0 ||
4085 strncmpic(pp, US"data_4", 6) == 0)
4088 int x = 255; /* means "any 4xx code" */
4089 if (p != pp + 8) bad = TRUE; else
4091 int a = pp[6], b = pp[7];
4095 if (isdigit(b)) x += b - '0';
4096 else if (b == 'x') x += 100;
4099 else if (a != 'x' || b != 'x') bad = TRUE;
4103 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
4104 "x is literal and d is any digit", pp);
4106 *basic_errno = *pp == 'm' ? ERRNO_MAIL4XX :
4107 *pp == 'r' ? ERRNO_RCPT4XX : ERRNO_DATA4XX;
4108 *more_errno = x << 8;
4111 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
4112 strncmpic(q+1, US"failed", p-q-1) == 0)
4113 *basic_errno = ERRNO_AUTHFAIL;
4115 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
4116 *basic_errno = ERRNO_SMTPCLOSED;
4118 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
4119 *basic_errno = ERRNO_TLSREQUIRED;
4121 else if (strncmpic(pp, US"lookup", p - pp) == 0)
4122 *basic_errno = ERRNO_UNKNOWNHOST;
4124 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
4125 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
4133 /*************************************************
4134 * Read retry information *
4135 *************************************************/
4137 /* Each line of retry information contains:
4139 . A domain name pattern or an address pattern;
4141 . An error name, possibly with additional data, or *;
4143 . An optional sequence of retry items, each consisting of an identifying
4144 letter, a cutoff time, and optional parameters.
4146 All this is decoded and placed into a control block. */
4149 /* Subroutine to read an argument, preceded by a comma and terminated
4150 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
4151 1 = fixed point number (returned *1000).
4154 paddr pointer to pointer to current character; updated
4155 type 0 => read a time; 1 => read a fixed point number
4157 Returns: time in seconds or fixed point number * 1000
4161 retry_arg(const uschar **paddr, int type)
4163 const uschar *p = *paddr;
4166 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
4168 while (isspace(*p)) p++;
4170 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
4172 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
4173 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
4178 case 0: return readconf_readtime(pp, *p, FALSE);
4179 case 1: return readconf_readfixed(pp, *p);
4181 return 0; /* Keep picky compilers happy */
4184 /* The function proper */
4187 readconf_retries(void)
4189 retry_config **chain = &retries;
4193 while ((p = get_config_line()))
4195 retry_rule **rchain;
4199 next = store_get(sizeof(retry_config));
4202 chain = &(next->next);
4203 next->basic_errno = next->more_errno = 0;
4204 next->senders = NULL;
4206 rchain = &(next->rules);
4208 next->pattern = string_dequote(&p);
4209 while (isspace(*p)) p++;
4211 while (mac_isgraph(*p)) p++;
4212 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4213 "missing error type in retry rule");
4215 /* Test error names for things we understand. */
4217 if ((error = readconf_retry_error(pp, p, &next->basic_errno,
4218 &next->more_errno)))
4219 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
4221 /* There may be an optional address list of senders to be used as another
4222 constraint on the rule. This was added later, so the syntax is a bit of a
4223 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
4226 while (isspace(*p)) p++;
4227 if (Ustrncmp(p, "senders", 7) == 0)
4230 while (isspace(*p)) p++;
4231 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4232 "\"=\" expected after \"senders\" in retry rule");
4233 while (isspace(*p)) p++;
4234 next->senders = string_dequote(&p);
4237 /* Now the retry rules. Keep the maximum timeout encountered. */
4239 while (isspace(*p)) p++;
4243 retry_rule *rule = store_get(sizeof(retry_rule));
4245 rchain = &(rule->next);
4247 rule->rule = toupper(*p++);
4248 rule->timeout = retry_arg(&p, 0);
4249 if (rule->timeout > retry_maximum_timeout)
4250 retry_maximum_timeout = rule->timeout;
4254 case 'F': /* Fixed interval */
4255 rule->p1 = retry_arg(&p, 0);
4258 case 'G': /* Geometrically increasing intervals */
4259 case 'H': /* Ditto, but with randomness */
4260 rule->p1 = retry_arg(&p, 0);
4261 rule->p2 = retry_arg(&p, 1);
4265 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
4269 if (rule->timeout <= 0 || rule->p1 <= 0 ||
4270 (rule->rule != 'F' && rule->p2 < 1000))
4271 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4272 "bad parameters for retry rule");
4274 while (isspace(*p)) p++;
4278 while (isspace(*p)) p++;
4281 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
4288 /*************************************************
4289 * Initialize authenticators *
4290 *************************************************/
4293 readconf_options_auths(void)
4295 struct auth_info * ai;
4297 readconf_options_from_list(optionlist_auths, optionlist_auths_size, US"AU");
4299 for (ai = auths_available; ai->driver_name[0]; ai++)
4301 macro_create(string_sprintf("_DRVR_AUTH_%T", ai->driver_name), US"y", FALSE, TRUE);
4302 readconf_options_from_list(ai->options, (unsigned)*ai->options_count, ai->driver_name);
4307 /* Read the authenticators section of the configuration file.
4316 auth_instance *au, *bu;
4318 readconf_driver_init(US"authenticator",
4319 (driver_instance **)(&auths), /* chain anchor */
4320 (driver_info *)auths_available, /* available drivers */
4321 sizeof(auth_info), /* size of info block */
4322 &auth_defaults, /* default values for generic options */
4323 sizeof(auth_instance), /* size of instance block */
4324 optionlist_auths, /* generic options */
4325 optionlist_auths_size);
4327 for (au = auths; au; au = au->next)
4329 if (!au->public_name)
4330 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
4331 "the %s authenticator", au->name);
4333 for (bu = au->next; bu; bu = bu->next)
4334 if (strcmpic(au->public_name, bu->public_name) == 0)
4335 if ((au->client && bu->client) || (au->server && bu->server))
4336 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
4337 "(%s and %s) have the same public name (%s)",
4338 au->client ? US"client" : US"server", au->name, bu->name,
4346 /*************************************************
4347 * Read ACL information *
4348 *************************************************/
4350 /* If this run of Exim is not doing something that involves receiving a
4351 message, we can just skip over the ACL information. No need to parse it.
4353 First, we have a function for acl_read() to call back to get the next line. We
4354 need to remember the line we passed, because at the end it will contain the
4355 name of the next ACL. */
4357 static uschar *acl_line;
4362 acl_line = get_config_line();
4367 /* Now the main function:
4378 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4381 acl_line = get_config_line();
4383 while(acl_line != NULL)
4389 p = readconf_readname(name, sizeof(name), acl_line);
4390 if (isupper(*name) && *p == '=')
4392 read_macro_assignment(acl_line);
4393 acl_line = get_config_line();
4397 if (*p != ':' || name[0] == 0)
4398 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4400 node = store_get(sizeof(tree_node) + Ustrlen(name));
4401 Ustrcpy(node->name, name);
4402 if (!tree_insertnode(&acl_anchor, node))
4403 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4404 "there are two ACLs called \"%s\"", name);
4406 node->data.ptr = acl_read(acl_callback, &error);
4408 if (node->data.ptr == NULL && error != NULL)
4409 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4415 /*************************************************
4416 * Read configuration for local_scan() *
4417 *************************************************/
4419 /* This function is called after "begin local_scan" is encountered in the
4420 configuration file. If the local_scan() function allows for configuration
4421 options, we can process them. Otherwise, we expire in a panic.
4428 local_scan_init(void)
4430 #ifndef LOCAL_SCAN_HAS_OPTIONS
4431 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4432 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4436 while ((p = get_config_line()) != NULL)
4438 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4439 NULL, US"local_scan option \"%s\" unknown");
4446 /*************************************************
4447 * Read rest of configuration (after main) *
4448 *************************************************/
4450 /* This function reads the rest of the runtime configuration, after the main
4451 configuration. It is called only when actually needed. Each subsequent section
4452 of the configuration starts with a line of the form
4456 where the name is "routers", "transports", etc. A section is terminated by
4457 hitting the next "begin" line, and the next name is left in next_section.
4458 Because it may confuse people as to whether the names are singular or plural,
4459 we add "s" if it's missing. There is always enough room in next_section for
4460 this. This function is basically just a switch.
4466 static uschar *section_list[] = {
4480 while(next_section[0] != 0)
4484 int last = sizeof(section_list) / sizeof(uschar *);
4486 int n = Ustrlen(next_section);
4488 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4492 int c = strcmpic(next_section, section_list[mid]);
4494 if (c > 0) first = mid + 1; else last = mid;
4496 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4497 "\"%.*s\" is not a known configuration section name", n, next_section);
4498 mid = (last + first)/2;
4502 if (((had ^= bit) & bit) == 0)
4503 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4504 "\"%.*s\" section is repeated in the configuration file", n,
4509 case 0: readconf_acl(); break;
4510 case 1: auths_init(); break;
4511 case 2: local_scan_init(); break;
4512 case 3: readconf_retries(); break;
4513 case 4: readconf_rewrites(); break;
4514 case 5: route_init(); break;
4515 case 6: transport_init(); break;
4519 (void)fclose(config_file);
4522 /* Init the storage for the pre-parsed config lines */
4524 readconf_save_config(const uschar *s)
4526 save_config_line(string_sprintf("# Exim Configuration (%s)",
4527 running_in_test_harness ? US"X" : s));
4531 save_config_position(const uschar *file, int line)
4533 save_config_line(string_sprintf("# %d \"%s\"", line, file));
4536 /* Append a pre-parsed logical line to the config lines store,
4537 this operates on a global (static) list that holds all the pre-parsed
4538 config lines, we do no further processing here, output formatting and
4539 honouring of <hide> or macros will be done during output */
4541 save_config_line(const uschar* line)
4543 static config_line_item *current;
4544 config_line_item *next;
4546 next = (config_line_item*) store_get(sizeof(config_line_item));
4547 next->line = string_copy(line);
4550 if (!config_lines) config_lines = next;
4551 else current->next = next;
4556 /* List the parsed config lines, care about nice formatting and
4557 hide the <hide> values unless we're the admin user */
4559 print_config(BOOL admin, BOOL terse)
4561 config_line_item *i;
4562 const int TS = terse ? 0 : 2;
4565 for (i = config_lines; i; i = i->next)
4570 /* skip over to the first non-space */
4571 for (current = i->line; *current && isspace(*current); ++current)
4574 if (*current == '\0')
4577 /* Collapse runs of spaces. We stop this if we encounter one of the
4578 * following characters: "'$, as this may indicate careful formatting */
4579 for (p = current; *p; ++p)
4582 if (!isspace(*p)) continue;
4583 if (*p != ' ') *p = ' ';
4585 for (next = p; isspace(*next); ++next)
4589 memmove(p+1, next, Ustrlen(next)+1);
4591 if (*next == '"' || *next == '\'' || *next == '$')
4596 if (current[0] == '#')
4599 /* begin lines are left aligned */
4600 else if (Ustrncmp(current, "begin", 5) == 0 && isspace(current[5]))
4602 if (!terse) puts("");
4607 /* router/acl/transport block names */
4608 else if (current[Ustrlen(current)-1] == ':' && !Ustrchr(current, '='))
4610 if (!terse) puts("");
4611 printf("%*s%s\n", TS, "", current);
4615 /* hidden lines (all MACROS or lines prefixed with "hide") */
4617 && ( isupper(*current)
4618 || Ustrncmp(current, "hide", 4) == 0 && isspace(current[4])
4622 if ((p = Ustrchr(current, '=')))
4625 printf("%*s%s= %s\n", indent, "", current, hidden);
4627 /* e.g.: hide split_spool_directory */
4629 printf("%*s\n", indent, hidden);
4633 /* rest is public */
4634 printf("%*s%s\n", indent, "", current);
4640 /* End of readconf.c */