1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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 #define CSTATE_STACK_SIZE 10
17 /* Structure for chain (stack) of .included files */
19 typedef struct config_file_item {
20 struct config_file_item *next;
26 /* Structure of table of conditional words and their state transitions */
28 typedef struct cond_item {
36 /* Structure of table of syslog facility names and values */
38 typedef struct syslog_fac_item {
44 /* Static variables */
46 static config_file_item *config_file_stack = NULL; /* For includes */
48 static uschar *syslog_facility_str = NULL;
49 static uschar next_section[24];
50 static uschar time_buffer[24];
52 /* State variables for conditional loading (.ifdef / .else / .endif) */
54 static int cstate = 0;
55 static int cstate_stack_ptr = -1;
56 static int cstate_stack[CSTATE_STACK_SIZE];
58 /* Table of state transitions for handling conditional inclusions. There are
59 four possible state transitions:
63 .elifdef true (or .else)
66 .endif just causes the previous cstate to be popped off the stack */
68 static int next_cstate[3][4] =
70 /* State 0: reading from file, or reading until next .else or .endif */
72 /* State 1: condition failed, skipping until next .else or .endif */
74 /* State 2: skipping until .endif */
78 /* Table of conditionals and the states to set. For each name, there are four
79 values: the length of the name (to save computing it each time), the state to
80 set if a macro was found in the line, the state to set if a macro was not found
81 in the line, and a stack manipulation setting which is:
83 -1 pull state value off the stack
84 0 don't alter the stack
85 +1 push value onto stack, before setting new state
88 static cond_item cond_list[] = {
89 { US"ifdef", 5, 0, 1, 1 },
90 { US"ifndef", 6, 1, 0, 1 },
91 { US"elifdef", 7, 2, 3, 0 },
92 { US"elifndef", 8, 3, 2, 0 },
93 { US"else", 4, 2, 2, 0 },
94 { US"endif", 5, 0, 0, -1 }
97 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
99 /* Table of syslog facility names and their values */
101 static syslog_fac_item syslog_list[] = {
102 { US"mail", LOG_MAIL },
103 { US"user", LOG_USER },
104 { US"news", LOG_NEWS },
105 { US"uucp", LOG_UUCP },
106 { US"local0", LOG_LOCAL0 },
107 { US"local1", LOG_LOCAL1 },
108 { US"local2", LOG_LOCAL2 },
109 { US"local3", LOG_LOCAL3 },
110 { US"local4", LOG_LOCAL4 },
111 { US"local5", LOG_LOCAL5 },
112 { US"local6", LOG_LOCAL6 },
113 { US"local7", LOG_LOCAL7 },
114 { US"daemon", LOG_DAEMON }
117 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
122 /*************************************************
123 * Main configuration options *
124 *************************************************/
126 /* The list of options that can be set in the main configuration file. This
127 must be in alphabetic order because it is searched by binary chop. */
129 static optionlist optionlist_config[] = {
130 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
131 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
132 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
133 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
134 { "accept_8bitmime", opt_bool, &accept_8bitmime },
135 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
136 #ifdef WITH_CONTENT_SCAN
137 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
139 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
140 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
141 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
142 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
144 { "acl_smtp_data_prdr", opt_stringptr, &acl_smtp_data_prdr },
147 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
149 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
150 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
151 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
152 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
153 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
154 #ifdef WITH_CONTENT_SCAN
155 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
157 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
158 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
159 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
160 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
162 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
164 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
165 { "admin_groups", opt_gidlist, &admin_groups },
166 { "allow_domain_literals", opt_bool, &allow_domain_literals },
167 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
168 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
169 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
170 { "auto_thaw", opt_time, &auto_thaw },
171 #ifdef WITH_CONTENT_SCAN
172 { "av_scanner", opt_stringptr, &av_scanner },
174 { "bi_command", opt_stringptr, &bi_command },
175 #ifdef EXPERIMENTAL_BRIGHTMAIL
176 { "bmi_config_file", opt_stringptr, &bmi_config_file },
178 { "bounce_message_file", opt_stringptr, &bounce_message_file },
179 { "bounce_message_text", opt_stringptr, &bounce_message_text },
180 { "bounce_return_body", opt_bool, &bounce_return_body },
181 { "bounce_return_message", opt_bool, &bounce_return_message },
182 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
183 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
184 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
185 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
186 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
187 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
188 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
189 { "check_log_inodes", opt_int, &check_log_inodes },
190 { "check_log_space", opt_Kint, &check_log_space },
191 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
192 { "check_spool_inodes", opt_int, &check_spool_inodes },
193 { "check_spool_space", opt_Kint, &check_spool_space },
194 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
195 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
196 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
197 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
198 #ifdef EXPERIMENTAL_DCC
199 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
200 { "dccifd_address", opt_stringptr, &dccifd_address },
201 { "dccifd_options", opt_stringptr, &dccifd_options },
203 { "delay_warning", opt_timelist, &delay_warning },
204 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
205 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
206 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
207 { "delivery_date_remove", opt_bool, &delivery_date_remove },
208 #ifdef ENABLE_DISABLE_FSYNC
209 { "disable_fsync", opt_bool, &disable_fsync },
211 { "disable_ipv6", opt_bool, &disable_ipv6 },
213 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
215 #ifdef EXPERIMENTAL_DMARC
216 { "dmarc_forensic_sender", opt_stringptr, &dmarc_forensic_sender },
217 { "dmarc_history_file", opt_stringptr, &dmarc_history_file },
218 { "dmarc_tld_file", opt_stringptr, &dmarc_tld_file },
220 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
221 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
222 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
223 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
224 { "dns_dnssec_ok", opt_int, &dns_dnssec_ok },
225 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
226 { "dns_retrans", opt_time, &dns_retrans },
227 { "dns_retry", opt_int, &dns_retry },
228 { "dns_use_edns0", opt_int, &dns_use_edns0 },
229 /* This option is now a no-op, retained for compability */
230 { "drop_cr", opt_bool, &drop_cr },
231 /*********************************************************/
232 #ifdef EXPERIMENTAL_DSN
233 { "dsn_advertise_hosts", opt_stringptr, &dsn_advertise_hosts },
235 { "dsn_from", opt_stringptr, &dsn_from },
236 { "envelope_to_remove", opt_bool, &envelope_to_remove },
237 { "errors_copy", opt_stringptr, &errors_copy },
238 { "errors_reply_to", opt_stringptr, &errors_reply_to },
239 { "exim_group", opt_gid, &exim_gid },
240 { "exim_path", opt_stringptr, &exim_path },
241 { "exim_user", opt_uid, &exim_uid },
242 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
243 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
244 { "finduser_retries", opt_int, &finduser_retries },
245 { "freeze_tell", opt_stringptr, &freeze_tell },
246 { "gecos_name", opt_stringptr, &gecos_name },
247 { "gecos_pattern", opt_stringptr, &gecos_pattern },
249 { "gnutls_allow_auto_pkcs11", opt_bool, &gnutls_allow_auto_pkcs11 },
250 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
251 /* These three gnutls_require_* options stopped working in Exim 4.80 */
252 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
253 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
254 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
256 { "header_line_maxsize", opt_int, &header_line_maxsize },
257 { "header_maxsize", opt_int, &header_maxsize },
258 { "headers_charset", opt_stringptr, &headers_charset },
259 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
260 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
261 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
262 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
263 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
264 { "hold_domains", opt_stringptr, &hold_domains },
265 { "host_lookup", opt_stringptr, &host_lookup },
266 { "host_lookup_order", opt_stringptr, &host_lookup_order },
267 { "host_reject_connection", opt_stringptr, &host_reject_connection },
268 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
269 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
271 { "ibase_servers", opt_stringptr, &ibase_servers },
273 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
274 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
275 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
276 { "keep_malformed", opt_time, &keep_malformed },
278 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
279 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
280 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
281 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
282 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
283 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
284 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
285 { "ldap_start_tls", opt_bool, &eldap_start_tls },
286 { "ldap_version", opt_int, &eldap_version },
288 { "local_from_check", opt_bool, &local_from_check },
289 { "local_from_prefix", opt_stringptr, &local_from_prefix },
290 { "local_from_suffix", opt_stringptr, &local_from_suffix },
291 { "local_interfaces", opt_stringptr, &local_interfaces },
292 { "local_scan_timeout", opt_time, &local_scan_timeout },
293 { "local_sender_retain", opt_bool, &local_sender_retain },
294 { "localhost_number", opt_stringptr, &host_number_string },
295 { "log_file_path", opt_stringptr, &log_file_path },
296 { "log_selector", opt_stringptr, &log_selector_string },
297 { "log_timezone", opt_bool, &log_timezone },
298 { "lookup_open_max", opt_int, &lookup_open_max },
299 { "max_username_length", opt_int, &max_username_length },
300 { "message_body_newlines", opt_bool, &message_body_newlines },
301 { "message_body_visible", opt_mkint, &message_body_visible },
302 { "message_id_header_domain", opt_stringptr, &message_id_domain },
303 { "message_id_header_text", opt_stringptr, &message_id_text },
304 { "message_logs", opt_bool, &message_logs },
305 { "message_size_limit", opt_stringptr, &message_size_limit },
306 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
307 { "move_frozen_messages", opt_bool, &move_frozen_messages },
309 { "mua_wrapper", opt_bool, &mua_wrapper },
311 { "mysql_servers", opt_stringptr, &mysql_servers },
313 { "never_users", opt_uidlist, &never_users },
315 { "openssl_options", opt_stringptr, &openssl_options },
318 { "oracle_servers", opt_stringptr, &oracle_servers },
320 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
322 { "perl_at_start", opt_bool, &opt_perl_at_start },
323 { "perl_startup", opt_stringptr, &opt_perl_startup },
326 { "pgsql_servers", opt_stringptr, &pgsql_servers },
328 { "pid_file_path", opt_stringptr, &pid_file_path },
329 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
331 { "prdr_enable", opt_bool, &prdr_enable },
333 { "preserve_message_logs", opt_bool, &preserve_message_logs },
334 { "primary_hostname", opt_stringptr, &primary_hostname },
335 { "print_topbitchars", opt_bool, &print_topbitchars },
336 { "process_log_path", opt_stringptr, &process_log_path },
337 { "prod_requires_admin", opt_bool, &prod_requires_admin },
338 #ifdef EXPERIMENTAL_PROXY
339 { "proxy_required_hosts", opt_stringptr, &proxy_required_hosts },
341 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
342 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
343 { "queue_domains", opt_stringptr, &queue_domains },
344 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
345 { "queue_only", opt_bool, &queue_only },
346 { "queue_only_file", opt_stringptr, &queue_only_file },
347 { "queue_only_load", opt_fixed, &queue_only_load },
348 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
349 { "queue_only_override", opt_bool, &queue_only_override },
350 { "queue_run_in_order", opt_bool, &queue_run_in_order },
351 { "queue_run_max", opt_int, &queue_run_max },
352 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
353 { "receive_timeout", opt_time, &receive_timeout },
354 { "received_header_text", opt_stringptr, &received_header_text },
355 { "received_headers_max", opt_int, &received_headers_max },
356 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
357 { "recipients_max", opt_int, &recipients_max },
358 { "recipients_max_reject", opt_bool, &recipients_max_reject },
359 #ifdef EXPERIMENTAL_REDIS
360 { "redis_servers", opt_stringptr, &redis_servers },
362 { "remote_max_parallel", opt_int, &remote_max_parallel },
363 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
364 { "retry_data_expire", opt_time, &retry_data_expire },
365 { "retry_interval_max", opt_time, &retry_interval_max },
366 { "return_path_remove", opt_bool, &return_path_remove },
367 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
368 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
369 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
370 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
371 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
372 { "smtp_accept_max", opt_int, &smtp_accept_max },
373 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
374 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
375 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
376 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
377 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
378 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
379 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
380 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
381 { "smtp_banner", opt_stringptr, &smtp_banner },
382 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
383 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
384 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
385 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
386 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
387 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
388 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
389 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
390 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
391 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
392 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
393 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
394 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
395 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
396 #ifdef WITH_CONTENT_SCAN
397 { "spamd_address", opt_stringptr, &spamd_address },
399 #ifdef EXPERIMENTAL_SPF
400 { "spf_guess", opt_stringptr, &spf_guess },
402 { "split_spool_directory", opt_bool, &split_spool_directory },
403 { "spool_directory", opt_stringptr, &spool_directory },
405 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
407 #ifdef EXPERIMENTAL_SRS
408 { "srs_config", opt_stringptr, &srs_config },
409 { "srs_hashlength", opt_int, &srs_hashlength },
410 { "srs_hashmin", opt_int, &srs_hashmin },
411 { "srs_maxage", opt_int, &srs_maxage },
412 { "srs_secrets", opt_stringptr, &srs_secrets },
413 { "srs_usehash", opt_bool, &srs_usehash },
414 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
416 { "strict_acl_vars", opt_bool, &strict_acl_vars },
417 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
418 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
419 { "syslog_duplication", opt_bool, &syslog_duplication },
420 { "syslog_facility", opt_stringptr, &syslog_facility_str },
421 { "syslog_processname", opt_stringptr, &syslog_processname },
422 { "syslog_timestamp", opt_bool, &syslog_timestamp },
423 { "system_filter", opt_stringptr, &system_filter },
424 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
425 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
426 { "system_filter_group", opt_gid, &system_filter_gid },
427 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
428 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
429 { "system_filter_user", opt_uid, &system_filter_uid },
430 { "tcp_nodelay", opt_bool, &tcp_nodelay },
431 #ifdef USE_TCP_WRAPPERS
432 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
434 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
435 { "timezone", opt_stringptr, &timezone_string },
437 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
438 { "tls_certificate", opt_stringptr, &tls_certificate },
439 { "tls_crl", opt_stringptr, &tls_crl },
440 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
441 { "tls_dhparam", opt_stringptr, &tls_dhparam },
442 # ifndef DISABLE_OCSP
443 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
445 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
446 { "tls_privatekey", opt_stringptr, &tls_privatekey },
447 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
448 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
449 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
450 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
451 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
453 { "trusted_groups", opt_gidlist, &trusted_groups },
454 { "trusted_users", opt_uidlist, &trusted_users },
455 { "unknown_login", opt_stringptr, &unknown_login },
456 { "unknown_username", opt_stringptr, &unknown_username },
457 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
458 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
459 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
460 { "warn_message_file", opt_stringptr, &warn_message_file },
461 { "write_rejectlog", opt_bool, &write_rejectlog }
464 static int optionlist_config_size =
465 sizeof(optionlist_config)/sizeof(optionlist);
469 /*************************************************
470 * Find the name of an option *
471 *************************************************/
473 /* This function is to aid debugging. Various functions take arguments that are
474 pointer variables in the options table or in option tables for various drivers.
475 For debugging output, it is useful to be able to find the name of the option
476 which is currently being processed. This function finds it, if it exists, by
477 searching the table(s).
479 Arguments: a value that is presumed to be in the table above
480 Returns: the option name, or an empty string
484 readconf_find_option(void *p)
488 transport_instance *t;
490 for (i = 0; i < optionlist_config_size; i++)
491 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
493 for (r = routers; r != NULL; r = r->next)
495 router_info *ri = r->info;
496 for (i = 0; i < ri->options_count[0]; i++)
498 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
499 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
500 return US ri->options[i].name;
504 for (t = transports; t != NULL; t = t->next)
506 transport_info *ti = t->info;
507 for (i = 0; i < ti->options_count[0]; i++)
509 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
510 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
511 return US ti->options[i].name;
521 /*************************************************
522 * Deal with an assignment to a macro *
523 *************************************************/
525 /* This function is called when a line that starts with an upper case letter is
526 encountered. The argument "line" should contain a complete logical line, and
527 start with the first letter of the macro name. The macro name and the
528 replacement text are extracted and stored. Redefinition of existing,
529 non-command line, macros is permitted using '==' instead of '='.
532 s points to the start of the logical line
538 read_macro_assignment(uschar *s)
544 macro_item *mlast = NULL;
546 while (isalnum(*s) || *s == '_')
548 if (namelen >= sizeof(name) - 1)
549 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
550 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
551 name[namelen++] = *s++;
555 while (isspace(*s)) s++;
557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
564 while (isspace(*s)) s++;
566 /* If an existing macro of the same name was defined on the command line, we
567 just skip this definition. It's an error to attempt to redefine a macro without
568 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
569 It is also an error to define a macro whose name begins with the name of a
570 previously defined macro. Note: it is documented that the other way round
573 for (m = macros; m != NULL; m = m->next)
575 int len = Ustrlen(m->name);
577 if (Ustrcmp(m->name, name) == 0)
579 if (!m->command_line && !redef)
580 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
581 "defined (use \"==\" if you want to redefine it", name);
585 if (len < namelen && Ustrstr(name, m->name) != NULL)
586 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
587 "a macro because previously defined macro \"%s\" is a substring",
590 /* We cannot have this test, because it is documented that a substring
591 macro is permitted (there is even an example).
593 * if (len > namelen && Ustrstr(m->name, name) != NULL)
594 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
595 * "a macro because it is a substring of previously defined macro \"%s\"",
602 /* Check for an overriding command-line definition. */
604 if (m != NULL && m->command_line) return;
606 /* Redefinition must refer to an existing macro. */
611 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
615 /* We have a new definition. The macro_item structure includes a final vector
616 called "name" which is one byte long. Thus, adding "namelen" gives us enough
617 room to store the "name" string. */
621 m = store_get(sizeof(macro_item) + namelen);
622 if (macros == NULL) macros = m; else mlast->next = m;
623 Ustrncpy(m->name, name, namelen);
624 m->name[namelen] = 0;
626 m->command_line = FALSE;
629 /* Set the value of the new or redefined macro */
631 m->replacement = string_copy(s);
638 /*************************************************
639 * Read configuration line *
640 *************************************************/
642 /* A logical line of text is read from the configuration file into the big
643 buffer, taking account of macros, .includes, and continuations. The size of
644 big_buffer is increased if necessary. The count of configuration lines is
645 maintained. Physical input lines starting with # (ignoring leading white space,
646 and after macro replacement) and empty logical lines are always ignored.
647 Leading and trailing spaces are removed.
649 If we hit a line of the form "begin xxxx", the xxxx is placed in the
650 next_section vector, and the function returns NULL, indicating the end of a
651 configuration section. On end-of-file, NULL is returned with next_section
656 Returns: a pointer to the first non-blank in the line,
657 or NULL if eof or end of section is reached
661 get_config_line(void)
663 int startoffset = 0; /* To first non-blank char in logical line */
664 int len = 0; /* Of logical line so far */
670 /* Loop for handling continuation lines, skipping comments, and dealing with
675 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
677 if (config_file_stack != NULL) /* EOF inside .include */
679 (void)fclose(config_file);
680 config_file = config_file_stack->file;
681 config_filename = config_file_stack->filename;
682 config_lineno = config_file_stack->lineno;
683 config_file_stack = config_file_stack->next;
687 /* EOF at top level */
689 if (cstate_stack_ptr >= 0)
690 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
691 "Unexpected end of configuration file: .endif missing");
693 if (len != 0) break; /* EOF after continuation */
694 next_section[0] = 0; /* EOF at start of logical line */
699 newlen = len + Ustrlen(big_buffer + len);
701 /* Handle pathologically long physical lines - yes, it did happen - by
702 extending big_buffer at this point. The code also copes with very long
705 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
708 big_buffer_size += BIG_BUFFER_SIZE;
709 newbuffer = store_malloc(big_buffer_size);
711 /* This use of strcpy is OK because we know that the string in the old
712 buffer is shorter than the new buffer. */
714 Ustrcpy(newbuffer, big_buffer);
715 store_free(big_buffer);
716 big_buffer = newbuffer;
717 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
719 newlen += Ustrlen(big_buffer + newlen);
722 /* Find the true start of the physical line - leading spaces are always
725 ss = big_buffer + len;
726 while (isspace(*ss)) ss++;
728 /* Process the physical line for macros. If this is the start of the logical
729 line, skip over initial text at the start of the line if it starts with an
730 upper case character followed by a sequence of name characters and an equals
731 sign, because that is the definition of a new macro, and we don't do
732 replacement therein. */
735 if (len == 0 && isupper(*s))
737 while (isalnum(*s) || *s == '_') s++;
738 while (isspace(*s)) s++;
739 if (*s != '=') s = ss; /* Not a macro definition */
742 /* For each defined macro, scan the line (from after XXX= if present),
743 replacing all occurrences of the macro. */
746 for (m = macros; m != NULL; m = m->next)
751 while ((p = Ustrstr(t, m->name)) != NULL)
754 int namelen = Ustrlen(m->name);
755 int replen = Ustrlen(m->replacement);
757 /* Expand the buffer if necessary */
759 while (newlen - namelen + replen + 1 > big_buffer_size)
761 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
762 uschar *newbuffer = store_malloc(newsize);
763 memcpy(newbuffer, big_buffer, newlen + 1);
764 p = newbuffer + (p - big_buffer);
765 s = newbuffer + (s - big_buffer);
766 ss = newbuffer + (ss - big_buffer);
767 t = newbuffer + (t - big_buffer);
768 big_buffer_size = newsize;
769 store_free(big_buffer);
770 big_buffer = newbuffer;
773 /* Shuffle the remaining characters up or down in the buffer before
774 copying in the replacement text. Don't rescan the replacement for this
778 moveby = replen - namelen;
781 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
784 Ustrncpy(p, m->replacement, replen);
790 /* An empty macro replacement at the start of a line could mean that ss no
791 longer points to the first non-blank character. */
793 while (isspace(*ss)) ss++;
795 /* Check for comment lines - these are physical lines. */
797 if (*ss == '#') continue;
799 /* Handle conditionals, which are also applied to physical lines. Conditions
800 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
801 expansion occured on the rest of the line. A preliminary test for the leading
802 '.' saves effort on most lines. */
808 /* Search the list of conditional directives */
810 for (i = 0; i < cond_list_size; i++)
813 cond_item *c = cond_list+i;
814 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
816 /* The following character must be white space or end of string */
818 n = ss[1 + c->namelen];
819 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
821 /* .ifdef and .ifndef push the current state onto the stack, then set
822 a new one from the table. Stack overflow is an error */
826 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
827 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
828 ".%s nested too deeply", c->name);
829 cstate_stack[++cstate_stack_ptr] = cstate;
830 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
833 /* For any of the others, stack underflow is an error. The next state
834 comes either from the stack (.endif) or from the table. */
838 if (cstate_stack_ptr < 0)
839 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
840 ".%s without matching .ifdef", c->name);
841 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
842 next_cstate[cstate][macro_found? c->action1 : c->action2];
845 /* Having dealt with a directive, break the loop */
850 /* If we have handled a conditional directive, continue with the next
851 physical line. Otherwise, fall through. */
853 if (i < cond_list_size) continue;
856 /* If the conditional state is not 0 (actively using these lines), ignore
859 if (cstate != 0) continue; /* Conditional skip */
861 /* Handle .include lines - these are also physical lines. */
863 if (Ustrncmp(ss, ".include", 8) == 0 &&
865 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
868 int include_if_exists = isspace(ss[8])? 0 : 10;
869 config_file_item *save;
872 ss += 9 + include_if_exists;
873 while (isspace(*ss)) ss++;
874 t = ss + Ustrlen(ss);
875 while (t > ss && isspace(t[-1])) t--;
876 if (*ss == '\"' && t[-1] == '\"')
884 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
885 "absolute path \"%s\"", ss);
887 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
889 save = store_get(sizeof(config_file_item));
890 save->next = config_file_stack;
891 config_file_stack = save;
892 save->file = config_file;
893 save->filename = config_filename;
894 save->lineno = config_lineno;
896 config_file = Ufopen(ss, "rb");
897 if (config_file == NULL)
898 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
899 "configuration file %s", ss);
900 config_filename = string_copy(ss);
905 /* If this is the start of the logical line, remember where the non-blank
906 data starts. Otherwise shuffle down continuation lines to remove leading
910 startoffset = ss - big_buffer;
913 s = big_buffer + len;
916 memmove(s, ss, (newlen - len) - (ss - s) + 1);
921 /* Accept the new addition to the line. Remove trailing white space. */
924 while (len > 0 && isspace(big_buffer[len-1])) len--;
927 /* We are done if the line does not end in backslash and contains some data.
928 Empty logical lines are ignored. For continuations, remove the backslash and
929 go round the loop to read the continuation line. */
933 if (big_buffer[len-1] != '\\') break; /* End of logical line */
934 big_buffer[--len] = 0; /* Remove backslash */
936 } /* Loop for reading multiple physical lines */
938 /* We now have a logical line. Test for the end of a configuration section (or,
939 more accurately, for the start of the next section). Place the name of the next
940 section in next_section, and return NULL. If the name given is longer than
941 next_section, truncate it. It will be unrecognized later, because all the known
942 section names do fit. Leave space for pluralizing. */
944 s = big_buffer + startoffset; /* First non-space character */
945 if (strncmpic(s, US"begin ", 6) == 0)
948 while (isspace(*s)) s++;
949 if (big_buffer + len - s > sizeof(next_section) - 2)
950 s[sizeof(next_section) - 2] = 0;
951 Ustrcpy(next_section, s);
955 /* Return the first non-blank character. */
962 /*************************************************
964 *************************************************/
966 /* The yield is the pointer to the next uschar. Names longer than the
967 output space are silently truncated. This function is also used from acl.c when
971 name where to put the name
975 Returns: new input pointer
979 readconf_readname(uschar *name, int len, uschar *s)
982 while (isspace(*s)) s++;
985 while (isalnum(*s) || *s == '_')
987 if (p < len-1) name[p++] = *s;
992 while (isspace(*s)) s++;
999 /*************************************************
1000 * Read a time value *
1001 *************************************************/
1003 /* This function is also called from outside, to read argument
1004 time values. The format of a time value is:
1006 [<n>w][<n>d][<n>h][<n>m][<n>s]
1008 as long as at least one is present. If a format error is encountered,
1009 return a negative value. The value must be terminated by the given
1014 terminator required terminating character
1015 return_msec if TRUE, allow fractional seconds and return milliseconds
1017 Returns: the time value, or -1 on syntax error
1018 value is seconds if return_msec is FALSE
1019 value is milliseconds if return_msec is TRUE
1023 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1031 if (!isdigit(*s)) return -1;
1032 (void)sscanf(CS s, "%d%n", &value, &count);
1037 case 'w': value *= 7;
1038 case 'd': value *= 24;
1039 case 'h': value *= 60;
1040 case 'm': value *= 60;
1045 if (!return_msec) return -1;
1046 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1048 if (*s++ != 's') return -1;
1049 yield += (int)(fraction * 1000.0);
1055 if (return_msec) value *= 1000;
1057 if (*s == terminator) return yield;
1059 /* Control never reaches here. */
1064 /*************************************************
1065 * Read a fixed point value *
1066 *************************************************/
1068 /* The value is returned *1000
1072 terminator required terminator
1074 Returns: the value, or -1 on error
1078 readconf_readfixed(uschar *s, int terminator)
1082 if (!isdigit(*s)) return -1;
1083 (void)sscanf(CS s, "%d%n", &value, &count);
1085 yield = value * 1000;
1089 while (isdigit((*(++s))))
1091 yield += (*s - '0') * m;
1096 return (*s == terminator)? yield : (-1);
1101 /*************************************************
1102 * Find option in list *
1103 *************************************************/
1105 /* The lists are always in order, so binary chop can be used.
1108 name the option name to search for
1109 ol the first entry in the option list
1110 last one more than the offset of the last entry in the option list
1112 Returns: pointer to an option entry, or NULL if not found
1116 find_option(uschar *name, optionlist *ol, int last)
1119 while (last > first)
1121 int middle = (first + last)/2;
1122 int c = Ustrcmp(name, ol[middle].name);
1123 if (c == 0) return ol + middle;
1124 else if (c > 0) first = middle + 1;
1132 /*************************************************
1133 * Find a set flag in option list *
1134 *************************************************/
1136 /* Because some versions of Unix make no restrictions on the values of uids and
1137 gids (even negative ones), we cannot represent "unset" by a special value.
1138 There is therefore a separate boolean variable for each one indicating whether
1139 a value is set or not. This function returns a pointer to the boolean, given
1140 the original option name. It is a major disaster if the flag cannot be found.
1143 name the name of the uid or gid option
1144 oltop points to the start of the relevant option list
1145 last one more than the offset of the last item in the option list
1146 data_block NULL when reading main options => data values in the option
1147 list are absolute addresses; otherwise they are byte offsets
1148 in data_block (used for driver options)
1150 Returns: a pointer to the boolean flag.
1154 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1158 sprintf(CS name2, "*set_%.50s", name);
1159 ol = find_option(name2, oltop, last);
1160 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1161 "Exim internal error: missing set flag for %s", name);
1162 return (data_block == NULL)? (BOOL *)(ol->value) :
1163 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1169 /*************************************************
1170 * Output extra characters message and die *
1171 *************************************************/
1173 /* Called when an option line has junk on the end. Sometimes this is because
1174 the sysadmin thinks comments are permitted.
1177 s points to the extra characters
1178 t1..t3 strings to insert in the log message
1180 Returns: doesn't return; dies
1184 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1186 uschar *comment = US"";
1187 if (*s == '#') comment = US" (# is comment only at line start)";
1188 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1189 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1194 /*************************************************
1195 * Read rewrite information *
1196 *************************************************/
1198 /* Each line of rewrite information contains:
1200 . A complete address in the form user@domain, possibly with
1201 leading * for each part; or alternatively, a regex.
1203 . A replacement string (which will be expanded).
1205 . An optional sequence of one-letter flags, indicating which
1206 headers etc. to apply this rule to.
1208 All this is decoded and placed into a control block. The OR of the flags is
1209 maintained in a common word.
1212 p points to the string that makes up the rule
1213 existflags points to the overall flag word
1214 isglobal TRUE if reading global rewrite rules
1216 Returns: the control block for the parsed rule.
1219 static rewrite_rule *
1220 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1222 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1225 next->key = string_dequote(&p);
1227 while (isspace(*p)) p++;
1229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1230 "missing rewrite replacement string");
1233 next->replacement = string_dequote(&p);
1235 while (*p != 0) switch (*p++)
1237 case ' ': case '\t': break;
1239 case 'q': next->flags |= rewrite_quit; break;
1240 case 'w': next->flags |= rewrite_whole; break;
1242 case 'h': next->flags |= rewrite_all_headers; break;
1243 case 's': next->flags |= rewrite_sender; break;
1244 case 'f': next->flags |= rewrite_from; break;
1245 case 't': next->flags |= rewrite_to; break;
1246 case 'c': next->flags |= rewrite_cc; break;
1247 case 'b': next->flags |= rewrite_bcc; break;
1248 case 'r': next->flags |= rewrite_replyto; break;
1250 case 'E': next->flags |= rewrite_all_envelope; break;
1251 case 'F': next->flags |= rewrite_envfrom; break;
1252 case 'T': next->flags |= rewrite_envto; break;
1254 case 'Q': next->flags |= rewrite_qualify; break;
1255 case 'R': next->flags |= rewrite_repeat; break;
1258 next->flags |= rewrite_smtp;
1259 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1260 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1261 "rewrite rule has the S flag but is not a regular expression");
1265 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1266 "unknown rewrite flag character '%c' "
1267 "(could be missing quotes round replacement item)", p[-1]);
1271 /* If no action flags are set, set all the "normal" rewrites. */
1273 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1274 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1276 /* Remember which exist, for optimization, and return the rule */
1278 *existflags |= next->flags;
1285 /*************************************************
1286 * Read global rewrite information *
1287 *************************************************/
1289 /* Each line is a single rewrite rule; it is parsed into a control block
1290 by readconf_one_rewrite(), and its flags are ORed into the global flag
1291 word rewrite_existflags. */
1294 readconf_rewrites(void)
1296 rewrite_rule **chain = &global_rewrite_rules;
1299 while ((p = get_config_line()) != NULL)
1301 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1303 chain = &(next->next);
1309 /*************************************************
1311 *************************************************/
1313 /* Strings are read into the normal store pool. As long we aren't too
1314 near the end of the current block, the string will just use what is necessary
1315 on the top of the stacking pool, because string_cat() uses the extension
1319 s the rest of the input line
1320 name the option name (for errors)
1322 Returns: pointer to the string
1326 read_string(uschar *s, uschar *name)
1331 if (*s != '\"') return string_copy(s);
1334 yield = string_dequote(&s);
1336 if (s == ss+1 || s[-1] != '\"')
1337 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1338 "missing quote at end of string value for %s", name);
1340 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1346 /*************************************************
1347 * Handle option line *
1348 *************************************************/
1350 /* This function is called from several places to process a line containing the
1351 setting of an option. The first argument is the line to be decoded; it has been
1352 checked not to be empty and not to start with '#'. Trailing newlines and white
1353 space have been removed. The second argument is a pointer to the list of
1354 variable names that are to be recognized, together with their types and
1355 locations, and the third argument gives the number of entries in the list.
1357 The fourth argument is a pointer to a data block. If it is NULL, then the data
1358 values in the options list are absolute addresses. Otherwise, they are byte
1359 offsets in the data block.
1361 String option data may continue onto several lines; this function reads further
1362 data from config_file if necessary.
1364 The yield of this function is normally zero. If a string continues onto
1365 multiple lines, then the data value is permitted to be followed by a comma
1366 or a semicolon (for use in drivers) and the yield is that character.
1369 buffer contains the configuration line to be handled
1370 oltop points to the start of the relevant option list
1371 last one more than the offset of the last item in the option list
1372 data_block NULL when reading main options => data values in the option
1373 list are absolute addresses; otherwise they are byte offsets
1374 in data_block when they have opt_public set; otherwise
1375 they are byte offsets in data_block->options_block.
1376 unknown_txt format string to use in panic message for unknown option;
1377 must contain %s for option name
1378 if given as NULL, don't panic on unknown option
1380 Returns: TRUE if an option was read successfully,
1381 FALSE false for an unknown option if unknown_txt == NULL,
1382 otherwise panic and die on an unknown option
1386 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1387 void *data_block, uschar *unknown_txt)
1391 int n, count, type, value;
1395 BOOL boolvalue = TRUE;
1396 BOOL freesptr = TRUE;
1397 optionlist *ol, *ol2;
1401 uschar *inttype = US"";
1404 uschar *saved_condition, *strtemp;
1405 uschar **str_target;
1409 /* There may be leading spaces; thereafter, we expect an option name starting
1412 while (isspace(*s)) s++;
1414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1416 /* Read the name of the option, and skip any subsequent white space. If
1417 it turns out that what we read was "hide", set the flag indicating that
1418 this is a secure option, and loop to read the next word. */
1420 for (n = 0; n < 2; n++)
1422 while (isalnum(*s) || *s == '_')
1424 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1428 while (isspace(*s)) s++;
1429 if (Ustrcmp(name, "hide") != 0) break;
1430 issecure = opt_secure;
1434 /* Deal with "no_" or "not_" here for booleans */
1436 if (Ustrncmp(name, "no_", 3) == 0)
1442 if (Ustrncmp(name, "not_", 4) == 0)
1448 /* Search the list for the given name. A non-existent name, or an option that
1449 is set twice, is a disaster. */
1451 ol = find_option(name + offset, oltop, last);
1455 if (unknown_txt == NULL) return FALSE;
1456 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1459 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1460 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1461 "\"%s\" option set for the second time", name);
1463 ol->type |= opt_set | issecure;
1464 type = ol->type & opt_mask;
1466 /* Types with data values must be followed by '='; the "no[t]_" prefix
1467 applies only to boolean values. */
1469 if (type < opt_bool || type > opt_bool_last)
1472 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1473 "negation prefix applied to a non-boolean option");
1475 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1476 "unexpected end of line (data missing) after %s", name);
1478 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1481 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1482 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1483 ultimately expands to one of those values. */
1485 else if (*s != 0 && (offset != 0 || *s != '='))
1486 extra_chars_error(s, US"boolean option ", name, US"");
1488 /* Skip white space after = */
1490 if (*s == '=') while (isspace((*(++s))));
1492 /* If there is a data block and the opt_public flag is not set, change
1493 the data block pointer to the private options block. */
1495 if (data_block != NULL && (ol->type & opt_public) == 0)
1496 data_block = (void *)(((driver_instance *)data_block)->options_block);
1498 /* Now get the data according to the type. */
1502 /* If a string value is not enclosed in quotes, it consists of
1503 the rest of the current line, verbatim. Otherwise, string escapes
1506 A transport is specified as a string, which is then looked up in the
1507 list of transports. A search type is specified as one of a number of
1510 A set or rewrite rules for a driver is specified as a string, which is
1511 then parsed into a suitable chain of control blocks.
1513 Uids and gids are specified as strings which are then looked up in the
1514 passwd file. Lists of uids and gids are similarly specified as colon-
1515 separated strings. */
1520 case opt_expand_uid:
1521 case opt_expand_gid:
1526 reset_point = sptr = read_string(s, name);
1528 /* Having read a string, we now have several different ways of using it,
1529 depending on the data type, so do another switch. If keeping the actual
1530 string is not required (because it is interpreted), freesptr is set TRUE,
1531 and at the end we reset the pool. */
1535 /* If this was a string, set the variable to point to the new string,
1536 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1537 rules, we still keep the string (for printing), and parse the rules into a
1538 control block and flags word. */
1541 if (data_block == NULL)
1542 str_target = (uschar **)(ol->value);
1544 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1545 if (ol->type & opt_rep_con)
1547 /* We already have a condition, we're conducting a crude hack to let
1548 multiple condition rules be chained together, despite storing them in
1550 saved_condition = *str_target;
1551 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1552 saved_condition, sptr);
1553 *str_target = string_copy_malloc(strtemp);
1554 /* TODO(pdp): there is a memory leak here and just below
1555 when we set 3 or more conditions; I still don't
1556 understand the store mechanism enough to know
1557 what's the safe way to free content from an earlier store.
1558 AFAICT, stores stack, so freeing an early stored item also stores
1559 all data alloc'd after it. If we knew conditions were adjacent,
1560 we could survive that, but we don't. So I *think* we need to take
1561 another bit from opt_type to indicate "malloced"; this seems like
1562 quite a hack, especially for this one case. It also means that
1563 we can't ever reclaim the store from the *first* condition.
1565 Because we only do this once, near process start-up, I'm prepared to
1566 let this slide for the time being, even though it rankles. */
1568 else if (ol->type & opt_rep_str)
1570 uschar sep = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1573 /* Strip trailing whitespace and seperators */
1574 for (cp = sptr + Ustrlen(sptr) - 1;
1575 cp >= sptr && (*cp == '\n' || *cp == '\t' || *cp == ' ' || *cp == sep);
1579 *str_target = string_copy_malloc(
1580 *str_target ? string_sprintf("%s%c%s", *str_target, sep, sptr)
1591 if (data_block == NULL)
1592 *((uschar **)(ol->value)) = sptr;
1594 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1596 if (type == opt_rewrite)
1601 rewrite_rule **chain;
1604 sprintf(CS name2, "*%.50s_rules", name);
1605 ol2 = find_option(name2, oltop, last);
1606 sprintf(CS name2, "*%.50s_flags", name);
1607 ol3 = find_option(name2, oltop, last);
1609 if (ol2 == NULL || ol3 == NULL)
1610 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1611 "rewrite rules not available for driver");
1613 if (data_block == NULL)
1615 chain = (rewrite_rule **)(ol2->value);
1616 flagptr = (int *)(ol3->value);
1620 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1621 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1624 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1627 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1629 chain = &(next->next);
1632 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1633 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1634 "non-header rewrite - not allowed at transport time -");
1638 /* If it was an expanded uid, see if there is any expansion to be
1639 done by checking for the presence of a $ character. If there is, save it
1640 in the corresponding *expand_user option field. Otherwise, fall through
1641 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1644 case opt_expand_uid:
1645 sprintf(CS name2, "*expand_%.50s", name);
1646 ol2 = find_option(name2, oltop, last);
1649 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1651 if (data_block == NULL)
1652 *((uschar **)(ol2->value)) = ss;
1654 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1658 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1664 /* Look up a fixed uid, and also make use of the corresponding gid
1665 if a passwd entry is returned and the gid has not been set. */
1668 if (!route_finduser(sptr, &pw, &uid))
1669 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1670 if (data_block == NULL)
1671 *((uid_t *)(ol->value)) = uid;
1673 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1675 /* Set the flag indicating a fixed value is set */
1677 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1679 /* Handle matching gid if we have a passwd entry: done by finding the
1680 same name with terminating "user" changed to "group"; if not found,
1681 ignore. Also ignore if the value is already set. */
1683 if (pw == NULL) break;
1684 Ustrcpy(name+Ustrlen(name)-4, "group");
1685 ol2 = find_option(name, oltop, last);
1686 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1687 (ol2->type & opt_mask) == opt_expand_gid))
1689 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1692 if (data_block == NULL)
1693 *((gid_t *)(ol2->value)) = pw->pw_gid;
1695 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1701 /* If it was an expanded gid, see if there is any expansion to be
1702 done by checking for the presence of a $ character. If there is, save it
1703 in the corresponding *expand_user option field. Otherwise, fall through
1704 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1707 case opt_expand_gid:
1708 sprintf(CS name2, "*expand_%.50s", name);
1709 ol2 = find_option(name2, oltop, last);
1712 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1714 if (data_block == NULL)
1715 *((uschar **)(ol2->value)) = ss;
1717 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1721 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1727 /* Handle freestanding gid */
1730 if (!route_findgroup(sptr, &gid))
1731 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1732 if (data_block == NULL)
1733 *((gid_t *)(ol->value)) = gid;
1735 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1736 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1739 /* If it was a uid list, look up each individual entry, and build
1740 a vector of uids, with a count in the first element. Put the vector
1741 in malloc store so we can free the string. (We are reading into
1742 permanent store already.) */
1750 uschar *op = expand_string (sptr);
1753 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1754 name, expand_string_message);
1757 if (*p != 0) count++;
1758 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1759 list = store_malloc(count*sizeof(uid_t));
1760 list[ptr++] = (uid_t)(count - 1);
1762 if (data_block == NULL)
1763 *((uid_t **)(ol->value)) = list;
1765 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1771 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1772 if (!route_finduser(big_buffer, NULL, &uid))
1773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1780 /* If it was a gid list, look up each individual entry, and build
1781 a vector of gids, with a count in the first element. Put the vector
1782 in malloc store so we can free the string. (We are reading into permanent
1791 uschar *op = expand_string (sptr);
1794 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1795 name, expand_string_message);
1798 if (*p != 0) count++;
1799 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1800 list = store_malloc(count*sizeof(gid_t));
1801 list[ptr++] = (gid_t)(count - 1);
1803 if (data_block == NULL)
1804 *((gid_t **)(ol->value)) = list;
1806 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1812 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1813 if (!route_findgroup(big_buffer, &gid))
1814 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1822 /* Release store if the value of the string doesn't need to be kept. */
1824 if (freesptr) store_reset(reset_point);
1827 /* Expanded boolean: if no characters follow, or if there are no dollar
1828 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1829 save the string for later expansion in the alternate place. */
1831 case opt_expand_bool:
1832 if (*s != 0 && Ustrchr(s, '$') != 0)
1834 sprintf(CS name2, "*expand_%.50s", name);
1835 ol2 = find_option(name2, oltop, last);
1838 reset_point = sptr = read_string(s, name);
1839 if (data_block == NULL)
1840 *((uschar **)(ol2->value)) = sptr;
1842 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1849 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1850 look for yes/not/true/false. Some booleans are stored in a single bit in
1851 a single int. There's a special fudge for verify settings; without a suffix
1852 they set both xx_sender and xx_recipient. The table points to the sender
1853 value; search subsequently for the recipient. There's another special case:
1854 opt_bool_set also notes when a boolean has been set. */
1858 case opt_bool_verify:
1862 s = readconf_readname(name2, 64, s);
1863 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1865 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1867 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1868 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1869 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1870 US"for boolean option ", name);
1873 /* Handle single-bit type. */
1875 if (type == opt_bit)
1877 int bit = 1 << ((ol->type >> 16) & 31);
1878 int *ptr = (data_block == NULL)?
1879 (int *)(ol->value) :
1880 (int *)((uschar *)data_block + (long int)ol->value);
1881 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1885 /* Handle full BOOL types */
1887 if (data_block == NULL)
1888 *((BOOL *)(ol->value)) = boolvalue;
1890 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1894 if (type == opt_bool_verify)
1896 sprintf(CS name2, "%.50s_recipient", name + offset);
1897 ol2 = find_option(name2, oltop, last);
1900 if (data_block == NULL)
1901 *((BOOL *)(ol2->value)) = boolvalue;
1903 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1907 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1909 else if (type == opt_bool_set)
1911 sprintf(CS name2, "*set_%.50s", name + offset);
1912 ol2 = find_option(name2, oltop, last);
1915 if (data_block == NULL)
1916 *((BOOL *)(ol2->value)) = TRUE;
1918 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1927 inttype = US"octal ";
1929 /* Integer: a simple(ish) case; allow octal and hex formats, and
1930 suffixes K and M. The different types affect output, not input. */
1939 lvalue = strtol(CS s, CSS &endptr, intbase);
1942 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1945 if (errno != ERANGE)
1947 if (tolower(*endptr) == 'k')
1949 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1950 else lvalue *= 1024;
1953 else if (tolower(*endptr) == 'm')
1955 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1957 else lvalue *= 1024*1024;
1962 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1963 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1964 "absolute value of integer \"%s\" is too large (overflow)", s);
1966 while (isspace(*endptr)) endptr++;
1968 extra_chars_error(endptr, inttype, US"integer value for ", name);
1970 value = (int)lvalue;
1973 if (data_block == NULL)
1974 *((int *)(ol->value)) = value;
1976 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1979 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1986 value = strtol(CS s, CSS &endptr, intbase);
1989 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1992 if (errno != ERANGE)
1994 if (tolower(*endptr) == 'm')
1996 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
2000 else if (tolower(*endptr) == 'k')
2006 value = (value + 512)/1024;
2010 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2011 "absolute value of integer \"%s\" is too large (overflow)", s);
2013 while (isspace(*endptr)) endptr++;
2015 extra_chars_error(endptr, inttype, US"integer value for ", name);
2018 if (data_block == NULL)
2019 *((int *)(ol->value)) = value;
2021 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2024 /* Fixed-point number: held to 3 decimal places. */
2027 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2028 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2029 "fixed-point number expected for %s", name);
2031 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2032 "integer \"%s\" is too large (overflow)", s);
2036 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2037 "integer \"%s\" is too large (overflow)", s);
2039 if (s[count] == '.')
2042 while (isdigit(s[++count]))
2044 value += (s[count] - '0') * d;
2049 while (isspace(s[count])) count++;
2052 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2054 if (data_block == NULL)
2055 *((int *)(ol->value)) = value;
2057 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2060 /* There's a special routine to read time values. */
2063 value = readconf_readtime(s, 0, FALSE);
2065 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2067 if (data_block == NULL)
2068 *((int *)(ol->value)) = value;
2070 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2073 /* A time list is a list of colon-separated times, with the first
2074 element holding the size of the list and the second the number of
2080 int *list = (data_block == NULL)?
2081 (int *)(ol->value) :
2082 (int *)((uschar *)data_block + (long int)(ol->value));
2084 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2087 uschar *snext = Ustrchr(s, ':');
2091 while (ss > s && isspace(ss[-1])) ss--;
2094 value = readconf_readtime(s, terminator, FALSE);
2096 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2098 if (count > 1 && value <= list[count])
2099 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2100 "time value out of order for %s", name);
2101 list[count+1] = value;
2102 if (snext == NULL) break;
2104 while (isspace(*s)) s++;
2107 if (count > list[0] - 2)
2108 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2110 if (count > 0 && list[2] == 0) count = 0;
2122 /*************************************************
2123 * Print a time value *
2124 *************************************************/
2127 Argument: a time value in seconds
2128 Returns: pointer to a fixed buffer containing the time as a string,
2129 in readconf_readtime() format
2133 readconf_printtime(int t)
2136 uschar *p = time_buffer;
2153 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2154 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2155 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2156 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2157 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2164 /*************************************************
2165 * Print an individual option value *
2166 *************************************************/
2168 /* This is used by the -bP option, so prints to the standard output.
2169 The entire options list is passed in as an argument, because some options come
2170 in pairs - typically uid/gid settings, which can either be explicit numerical
2171 values, or strings to be expanded later. If the numerical value is unset,
2172 search for "*expand_<name>" to see if there is a string equivalent.
2175 ol option entry, or NULL for an unknown option
2177 options_block NULL for main configuration options; otherwise points to
2178 a driver block; if the option doesn't have opt_public
2179 set, then options_block->options_block is where the item
2181 oltop points to the option list in which ol exists
2182 last one more than the offset of the last entry in optop
2183 no_labels do not show "foo = " at the start.
2189 print_ol(optionlist *ol, uschar *name, void *options_block,
2190 optionlist *oltop, int last, BOOL no_labels)
2203 printf("%s is not a known option\n", name);
2207 /* Non-admin callers cannot see options that have been flagged secure by the
2210 if (!admin_user && (ol->type & opt_secure) != 0)
2212 const char * const hidden = "<value not displayable>";
2214 printf("%s\n", hidden);
2216 printf("%s = %s\n", name, hidden);
2220 /* Else show the value of the option */
2223 if (options_block != NULL)
2225 if ((ol->type & opt_public) == 0)
2226 options_block = (void *)(((driver_instance *)options_block)->options_block);
2227 value = (void *)((uschar *)options_block + (long int)value);
2230 switch(ol->type & opt_mask)
2233 case opt_rewrite: /* Show the text value */
2234 s = *((uschar **)value);
2235 if (!no_labels) printf("%s = ", name);
2236 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2240 if (!no_labels) printf("%s = ", name);
2241 printf("%d\n", *((int *)value));
2246 int x = *((int *)value);
2247 if (x != 0 && (x & 1023) == 0)
2251 if ((x & 1023) == 0)
2256 if (!no_labels) printf("%s = ", name);
2257 printf("%d%c\n", x, c);
2261 if (!no_labels) printf("%s = ", name);
2269 int x = *((int *)value);
2270 if (!no_labels) printf("%s = ", name);
2271 if (x == 0) printf("0\n");
2272 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2273 else printf("%dK\n", x);
2278 if (!no_labels) printf("%s = ", name);
2279 printf("%#o\n", *((int *)value));
2282 /* Can be negative only when "unset", in which case integer */
2286 int x = *((int *)value);
2289 if (x < 0) printf("%s =\n", name); else
2291 if (!no_labels) printf("%s = ", name);
2292 printf("%d.", x/1000);
2305 /* If the numerical value is unset, try for the string value */
2307 case opt_expand_uid:
2308 if (! *get_set_flag(name, oltop, last, options_block))
2310 sprintf(CS name2, "*expand_%.50s", name);
2311 ol2 = find_option(name2, oltop, last);
2314 void *value2 = ol2->value;
2315 if (options_block != NULL)
2316 value2 = (void *)((uschar *)options_block + (long int)value2);
2317 s = *((uschar **)value2);
2318 if (!no_labels) printf("%s = ", name);
2319 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2324 /* Else fall through */
2327 if (!no_labels) printf("%s = ", name);
2328 if (! *get_set_flag(name, oltop, last, options_block))
2332 pw = getpwuid(*((uid_t *)value));
2334 printf("%ld\n", (long int)(*((uid_t *)value)));
2335 else printf("%s\n", pw->pw_name);
2339 /* If the numerical value is unset, try for the string value */
2341 case opt_expand_gid:
2342 if (! *get_set_flag(name, oltop, last, options_block))
2344 sprintf(CS name2, "*expand_%.50s", name);
2345 ol2 = find_option(name2, oltop, last);
2346 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2348 void *value2 = ol2->value;
2349 if (options_block != NULL)
2350 value2 = (void *)((uschar *)options_block + (long int)value2);
2351 s = *((uschar **)value2);
2352 if (!no_labels) printf("%s = ", name);
2353 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2358 /* Else fall through */
2361 if (!no_labels) printf("%s = ", name);
2362 if (! *get_set_flag(name, oltop, last, options_block))
2366 gr = getgrgid(*((int *)value));
2368 printf("%ld\n", (long int)(*((int *)value)));
2369 else printf("%s\n", gr->gr_name);
2374 uidlist = *((uid_t **)value);
2375 if (!no_labels) printf("%s =", name);
2376 if (uidlist != NULL)
2380 if (no_labels) sep = '\0';
2381 for (i = 1; i <= (int)(uidlist[0]); i++)
2383 uschar *name = NULL;
2384 pw = getpwuid(uidlist[i]);
2385 if (pw != NULL) name = US pw->pw_name;
2386 if (sep != '\0') printf("%c", sep);
2387 if (name != NULL) printf("%s", name);
2388 else printf("%ld", (long int)(uidlist[i]));
2396 gidlist = *((gid_t **)value);
2397 if (!no_labels) printf("%s =", name);
2398 if (gidlist != NULL)
2402 if (no_labels) sep = '\0';
2403 for (i = 1; i <= (int)(gidlist[0]); i++)
2405 uschar *name = NULL;
2406 gr = getgrgid(gidlist[i]);
2407 if (gr != NULL) name = US gr->gr_name;
2408 if (sep != '\0') printf("%c", sep);
2409 if (name != NULL) printf("%s", name);
2410 else printf("%ld", (long int)(gidlist[i]));
2418 if (!no_labels) printf("%s = ", name);
2419 printf("%s\n", readconf_printtime(*((int *)value)));
2425 int *list = (int *)value;
2426 if (!no_labels) printf("%s = ", name);
2427 for (i = 0; i < list[1]; i++)
2428 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2434 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2438 case opt_expand_bool:
2439 sprintf(CS name2, "*expand_%.50s", name);
2440 ol2 = find_option(name2, oltop, last);
2441 if (ol2 != NULL && ol2->value != NULL)
2443 void *value2 = ol2->value;
2444 if (options_block != NULL)
2445 value2 = (void *)((uschar *)options_block + (long int)value2);
2446 s = *((uschar **)value2);
2449 if (!no_labels) printf("%s = ", name);
2450 printf("%s\n", string_printing(s));
2453 /* s == NULL => string not set; fall through */
2459 case opt_bool_verify:
2461 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2468 /*************************************************
2469 * Print value from main configuration *
2470 *************************************************/
2472 /* This function, called as a result of encountering the -bP option,
2473 causes the value of any main configuration variable to be output if the
2474 second argument is NULL. There are some special values:
2476 all print all main configuration options
2477 configure_file print the name of the configuration file
2478 routers print the routers' configurations
2479 transports print the transports' configuration
2480 authenticators print the authenticators' configuration
2481 macros print the macros' configuration
2482 router_list print a list of router names
2483 transport_list print a list of transport names
2484 authenticator_list print a list of authentication mechanism names
2485 macro_list print a list of macro names
2486 +name print a named list item
2487 local_scan print the local_scan options
2489 If the second argument is not NULL, it must be one of "router", "transport",
2490 "authenticator" or "macro" in which case the first argument identifies the
2491 driver whose options are to be printed.
2494 name option name if type == NULL; else driver name
2495 type NULL or driver type name, as described above
2496 no_labels avoid the "foo = " at the start of an item
2502 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2504 BOOL names_only = FALSE;
2506 optionlist *ol2 = NULL;
2507 driver_instance *d = NULL;
2518 static uschar *types[] = { US"address", US"domain", US"host",
2520 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2521 &hostlist_anchor, &localpartlist_anchor };
2523 for (i = 0; i < 4; i++)
2525 t = tree_search(*(anchors[i]), name+1);
2530 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2532 printf("%slist %s = %s\n", types[i], name+1,
2533 ((namedlist_block *)(t->data.ptr))->string);
2538 printf("no address, domain, host, or local part list called \"%s\" "
2539 "exists\n", name+1);
2544 if (Ustrcmp(name, "configure_file") == 0)
2546 printf("%s\n", CS config_main_filename);
2550 if (Ustrcmp(name, "all") == 0)
2552 for (ol = optionlist_config;
2553 ol < optionlist_config + optionlist_config_size; ol++)
2555 if ((ol->type & opt_hidden) == 0)
2556 print_ol(ol, US ol->name, NULL,
2557 optionlist_config, optionlist_config_size,
2563 if (Ustrcmp(name, "local_scan") == 0)
2565 #ifndef LOCAL_SCAN_HAS_OPTIONS
2566 printf("local_scan() options are not supported\n");
2568 for (ol = local_scan_options;
2569 ol < local_scan_options + local_scan_options_count; ol++)
2571 print_ol(ol, US ol->name, NULL, local_scan_options,
2572 local_scan_options_count, no_labels);
2578 if (Ustrcmp(name, "routers") == 0)
2583 else if (Ustrcmp(name, "transports") == 0)
2585 type = US"transport";
2589 else if (Ustrcmp(name, "authenticators") == 0)
2591 type = US"authenticator";
2595 else if (Ustrcmp(name, "macros") == 0)
2601 else if (Ustrcmp(name, "router_list") == 0)
2608 else if (Ustrcmp(name, "transport_list") == 0)
2610 type = US"transport";
2615 else if (Ustrcmp(name, "authenticator_list") == 0)
2617 type = US"authenticator";
2622 else if (Ustrcmp(name, "macro_list") == 0)
2631 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2632 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2637 /* Handle the options for a router or transport. Skip options that are flagged
2638 as hidden. Some of these are options with names starting with '*', used for
2639 internal alternative representations of other options (which the printing
2640 function will sort out). Others are synonyms kept for backward compatibility.
2643 if (Ustrcmp(type, "router") == 0)
2645 d = (driver_instance *)routers;
2646 ol2 = optionlist_routers;
2647 size = optionlist_routers_size;
2649 else if (Ustrcmp(type, "transport") == 0)
2651 d = (driver_instance *)transports;
2652 ol2 = optionlist_transports;
2653 size = optionlist_transports_size;
2655 else if (Ustrcmp(type, "authenticator") == 0)
2657 d = (driver_instance *)auths;
2658 ol2 = optionlist_auths;
2659 size = optionlist_auths_size;
2662 else if (Ustrcmp(type, "macro") == 0)
2664 /* People store passwords in macros and they were previously not available
2665 for printing. So we have an admin_users restriction. */
2668 fprintf(stderr, "exim: permission denied\n");
2671 for (m = macros; m != NULL; m = m->next)
2673 if (name == NULL || Ustrcmp(name, m->name) == 0)
2676 printf("%s\n", CS m->name);
2678 printf("%s=%s\n", CS m->name, CS m->replacement);
2684 printf("%s %s not found\n", type, name);
2690 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2694 /* Either search for a given driver, or print all of them */
2696 for (; d != NULL; d = d->next)
2699 printf("\n%s %s:\n", d->name, type);
2700 else if (Ustrcmp(d->name, name) != 0) continue;
2702 for (ol = ol2; ol < ol2 + size; ol++)
2704 if ((ol->type & opt_hidden) == 0)
2705 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2708 for (ol = d->info->options;
2709 ol < d->info->options + *(d->info->options_count); ol++)
2711 if ((ol->type & opt_hidden) == 0)
2712 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2714 if (name != NULL) return;
2716 if (name != NULL) printf("%s %s not found\n", type, name);
2721 /*************************************************
2722 * Read a named list item *
2723 *************************************************/
2725 /* This function reads a name and a list (i.e. string). The name is used to
2726 save the list in a tree, sorted by its name. Each entry also has a number,
2727 which can be used for caching tests, but if the string contains any expansion
2728 items other than $key, the number is set negative to inhibit caching. This
2729 mechanism is used for domain, host, and address lists that are referenced by
2733 anchorp points to the tree anchor
2734 numberp points to the current number for this tree
2735 max the maximum number permitted
2736 s the text of the option line, starting immediately after the name
2738 tname the name of the list type, for messages
2744 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2747 BOOL forcecache = FALSE;
2750 namedlist_block *nb = store_get(sizeof(namedlist_block));
2752 if (Ustrncmp(s, "_cache", 6) == 0)
2759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2761 if (*numberp >= max)
2762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2765 while (isspace(*s)) s++;
2767 while (isalnum(*s) || *s == '_') s++;
2768 t = store_get(sizeof(tree_node) + s-ss);
2769 Ustrncpy(t->name, ss, s-ss);
2771 while (isspace(*s)) s++;
2773 if (!tree_insertnode(anchorp, t))
2774 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2775 "duplicate name \"%s\" for a named %s", t->name, tname);
2778 nb->number = *numberp;
2781 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2782 "missing '=' after \"%s\"", t->name);
2783 while (isspace(*s)) s++;
2784 nb->string = read_string(s, t->name);
2785 nb->cache_data = NULL;
2787 /* Check the string for any expansions; if any are found, mark this list
2788 uncacheable unless the user has explicited forced caching. */
2790 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2796 /*************************************************
2797 * Unpick data for a rate limit *
2798 *************************************************/
2800 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2804 s string, in the form t,b,f,l
2805 where t is the threshold (integer)
2806 b is the initial delay (time)
2807 f is the multiplicative factor (fixed point)
2808 k is the maximum time (time)
2809 threshold where to store threshold
2810 base where to store base in milliseconds
2811 factor where to store factor in milliseconds
2812 limit where to store limit
2814 Returns: nothing (panics on error)
2818 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2821 uschar bstring[16], lstring[16];
2823 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2824 factor, lstring) == 4)
2826 *base = readconf_readtime(bstring, 0, TRUE);
2827 *limit = readconf_readtime(lstring, 0, TRUE);
2828 if (*base >= 0 && *limit >= 0) return;
2830 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2836 /*************************************************
2837 * Drop privs for checking TLS config *
2838 *************************************************/
2840 /* We want to validate TLS options during readconf, but do not want to be
2841 root when we call into the TLS library, in case of library linkage errors
2842 which cause segfaults; before this check, those were always done as the Exim
2843 runtime user and it makes sense to continue with that.
2845 Assumes: tls_require_ciphers has been set, if it will be
2846 exim_user has been set, if it will be
2847 exim_group has been set, if it will be
2849 Returns: bool for "okay"; false will cause caller to immediately exit.
2854 tls_dropprivs_validate_require_cipher(void)
2856 const uschar *errmsg;
2859 void (*oldsignal)(int);
2861 oldsignal = signal(SIGCHLD, SIG_DFL);
2864 if ((pid = fork()) < 0)
2865 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2869 /* in some modes, will have dropped privilege already */
2871 exim_setugid(exim_uid, exim_gid, FALSE,
2872 US"calling tls_validate_require_cipher");
2874 errmsg = tls_validate_require_cipher();
2877 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2878 "tls_require_ciphers invalid: %s", errmsg);
2885 rc = waitpid(pid, &status, 0);
2886 } while (rc < 0 && errno == EINTR);
2889 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2892 signal(SIGCHLD, oldsignal);
2896 #endif /* SUPPORT_TLS */
2901 /*************************************************
2902 * Read main configuration options *
2903 *************************************************/
2905 /* This function is the first to be called for configuration reading. It
2906 opens the configuration file and reads general configuration settings until
2907 it reaches the end of the configuration section. The file is then left open so
2908 that the remaining configuration data can subsequently be read if needed for
2911 The configuration file must be owned either by root or exim, and be writeable
2912 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2913 in the config file, so the test is done on the compiled in values. A slight
2914 anomaly, to be carefully documented.
2916 The name of the configuration file is taken from a list that is included in the
2917 binary of Exim. It can be altered from the command line, but if that is done,
2918 root privilege is immediately withdrawn unless the caller is root or exim.
2919 The first file on the list that exists is used.
2921 For use on multiple systems that share file systems, first look for a
2922 configuration file whose name has the current node name on the end. If that is
2923 not found, try the generic name. For really contorted configurations, that run
2924 multiple Exims with different uid settings, first try adding the effective uid
2925 before the node name. These complications are going to waste resources on most
2926 systems. Therefore they are available only when requested by compile-time
2933 struct stat statbuf;
2934 uschar *s, *filename;
2935 uschar *list = config_main_filelist;
2937 /* Loop through the possible file names */
2939 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2942 /* Cut out all the fancy processing unless specifically wanted */
2944 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2945 uschar *suffix = filename + Ustrlen(filename);
2947 /* Try for the node-specific file if a node name exists */
2949 #ifdef CONFIGURE_FILE_USE_NODE
2951 if (uname(&uts) >= 0)
2953 #ifdef CONFIGURE_FILE_USE_EUID
2954 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2955 config_file = Ufopen(filename, "rb");
2956 if (config_file == NULL)
2957 #endif /* CONFIGURE_FILE_USE_EUID */
2959 sprintf(CS suffix, ".%.256s", uts.nodename);
2960 config_file = Ufopen(filename, "rb");
2963 #endif /* CONFIGURE_FILE_USE_NODE */
2965 /* Otherwise, try the generic name, possibly with the euid added */
2967 #ifdef CONFIGURE_FILE_USE_EUID
2968 if (config_file == NULL)
2970 sprintf(CS suffix, ".%ld", (long int)original_euid);
2971 config_file = Ufopen(filename, "rb");
2973 #endif /* CONFIGURE_FILE_USE_EUID */
2975 /* Finally, try the unadorned name */
2977 if (config_file == NULL)
2980 config_file = Ufopen(filename, "rb");
2982 #else /* if neither defined */
2984 /* This is the common case when the fancy processing is not included. */
2986 config_file = Ufopen(filename, "rb");
2989 /* If the file does not exist, continue to try any others. For any other
2990 error, break out (and die). */
2992 if (config_file != NULL || errno != ENOENT) break;
2995 /* On success, save the name for verification; config_filename is used when
2996 logging configuration errors (it changes for .included files) whereas
2997 config_main_filename is the name shown by -bP. Failure to open a configuration
2998 file is a serious disaster. */
3000 if (config_file != NULL)
3002 config_filename = config_main_filename = string_copy(filename);
3006 if (filename == NULL)
3007 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
3008 "%s", config_main_filelist);
3010 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
3011 "configuration file %s", filename));
3014 /* Check the status of the file we have opened, if we have retained root
3015 privileges and the file isn't /dev/null (which *should* be 0666). */
3017 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3019 if (fstat(fileno(config_file), &statbuf) != 0)
3020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3023 if ((statbuf.st_uid != root_uid /* owner not root */
3024 #ifdef CONFIGURE_OWNER
3025 && statbuf.st_uid != config_uid /* owner not the special one */
3028 (statbuf.st_gid != root_gid /* group not root & */
3029 #ifdef CONFIGURE_GROUP
3030 && statbuf.st_gid != config_gid /* group not the special one */
3032 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3034 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3036 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3037 "wrong owner, group, or mode", big_buffer);
3040 /* Process the main configuration settings. They all begin with a lower case
3041 letter. If we see something starting with an upper case letter, it is taken as
3042 a macro definition. */
3044 while ((s = get_config_line()) != NULL)
3046 if (isupper(s[0])) read_macro_assignment(s);
3048 else if (Ustrncmp(s, "domainlist", 10) == 0)
3049 read_named_list(&domainlist_anchor, &domainlist_count,
3050 MAX_NAMED_LIST, s+10, US"domain list");
3052 else if (Ustrncmp(s, "hostlist", 8) == 0)
3053 read_named_list(&hostlist_anchor, &hostlist_count,
3054 MAX_NAMED_LIST, s+8, US"host list");
3056 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3057 read_named_list(&addresslist_anchor, &addresslist_count,
3058 MAX_NAMED_LIST, s+11, US"address list");
3060 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3061 read_named_list(&localpartlist_anchor, &localpartlist_count,
3062 MAX_NAMED_LIST, s+13, US"local part list");
3065 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3066 NULL, US"main option \"%s\" unknown");
3070 /* If local_sender_retain is set, local_from_check must be unset. */
3072 if (local_sender_retain && local_from_check)
3073 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3074 "local_sender_retain are set; this combination is not allowed");
3076 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3079 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3081 /* The max retry interval must not be greater than 24 hours. */
3083 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3085 /* remote_max_parallel must be > 0 */
3087 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3089 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3090 start of a new SMTP message. */
3092 freeze_tell_config = freeze_tell;
3094 /* The primary host name may be required for expansion of spool_directory
3095 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3096 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3097 canonize it. Some people like upper case letters in their host names, so we
3098 don't force the case. */
3100 if (primary_hostname == NULL)
3104 if (uname(&uts) < 0)
3105 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3106 hostname = US uts.nodename;
3108 if (Ustrchr(hostname, '.') == NULL)
3111 struct hostent *hostdata;
3114 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3115 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3125 #if HAVE_GETIPNODEBYNAME
3127 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3129 hostdata = gethostbyname2(CS hostname, af);
3132 hostdata = gethostbyname(CS hostname);
3135 if (hostdata != NULL)
3137 hostname = US hostdata->h_name;
3141 if (af == AF_INET) break;
3146 primary_hostname = string_copy(hostname);
3149 /* Set up default value for smtp_active_hostname */
3151 smtp_active_hostname = primary_hostname;
3153 /* If spool_directory wasn't set in the build-time configuration, it must have
3154 got set above. Of course, writing to the log may not work if log_file_path is
3155 not set, but it will at least get to syslog or somewhere, with any luck. */
3157 if (*spool_directory == 0)
3158 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3161 /* Expand the spool directory name; it may, for example, contain the primary
3162 host name. Same comment about failure. */
3164 s = expand_string(spool_directory);
3166 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3167 "\"%s\": %s", spool_directory, expand_string_message);
3168 spool_directory = s;
3170 /* Expand log_file_path, which must contain "%s" in any component that isn't
3171 the null string or "syslog". It is also allowed to contain one instance of %D
3172 or %M. However, it must NOT contain % followed by anything else. */
3174 if (*log_file_path != 0)
3177 int sep = ':'; /* Fixed for log file path */
3178 s = expand_string(log_file_path);
3180 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3181 "\"%s\": %s", log_file_path, expand_string_message);
3184 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3187 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3188 t = Ustrstr(sss, "%s");
3190 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3191 "contain \"%%s\"", sss);
3193 t = Ustrchr(sss, '%');
3196 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3197 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3198 "unexpected \"%%\" character", s);
3205 /* Interpret syslog_facility into an integer argument for 'ident' param to
3206 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3209 if (syslog_facility_str != NULL)
3212 uschar *s = syslog_facility_str;
3214 if ((Ustrlen(syslog_facility_str) >= 4) &&
3215 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3218 for (i = 0; i < syslog_list_size; i++)
3220 if (strcmpic(s, syslog_list[i].name) == 0)
3222 syslog_facility = syslog_list[i].value;
3227 if (i >= syslog_list_size)
3229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3230 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3234 /* Expand pid_file_path */
3236 if (*pid_file_path != 0)
3238 s = expand_string(pid_file_path);
3240 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3241 "\"%s\": %s", pid_file_path, expand_string_message);
3245 /* Set default value of process_log_path */
3247 if (process_log_path == NULL || *process_log_path =='\0')
3248 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3250 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3253 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3255 /* Unpick the SMTP rate limiting options, if set */
3257 if (smtp_ratelimit_mail != NULL)
3259 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3260 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3263 if (smtp_ratelimit_rcpt != NULL)
3265 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3266 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3269 /* The qualify domains default to the primary host name */
3271 if (qualify_domain_sender == NULL)
3272 qualify_domain_sender = primary_hostname;
3273 if (qualify_domain_recipient == NULL)
3274 qualify_domain_recipient = qualify_domain_sender;
3276 /* Setting system_filter_user in the configuration sets the gid as well if a
3277 name is given, but a numerical value does not. */
3279 if (system_filter_uid_set && !system_filter_gid_set)
3281 struct passwd *pw = getpwuid(system_filter_uid);
3283 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3284 (long int)system_filter_uid);
3285 system_filter_gid = pw->pw_gid;
3286 system_filter_gid_set = TRUE;
3289 /* If the errors_reply_to field is set, check that it is syntactically valid
3290 and ensure it contains a domain. */
3292 if (errors_reply_to != NULL)
3295 int start, end, domain;
3296 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3297 &start, &end, &domain, FALSE);
3299 if (recipient == NULL)
3300 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3301 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3304 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3305 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3308 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3309 smtp_accept_max must also be set. */
3311 if (smtp_accept_max == 0 &&
3312 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3313 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3314 "smtp_accept_max must be set if smtp_accept_queue or "
3315 "smtp_accept_max_per_host is set");
3317 /* Set up the host number if anything is specified. It is an expanded string
3318 so that it can be computed from the host name, for example. We do this last
3319 so as to ensure that everything else is set up before the expansion. */
3321 if (host_number_string != NULL)
3325 uschar *s = expand_string(host_number_string);
3327 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3328 "failed to expand localhost_number \"%s\": %s",
3329 host_number_string, expand_string_message);
3330 n = Ustrtol(s, &end, 0);
3331 while (isspace(*end)) end++;
3333 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3334 "localhost_number value is not a number: %s", s);
3335 if (n > LOCALHOST_MAX)
3336 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3337 "localhost_number is greater than the maximum allowed value (%d)",
3343 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3345 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3346 tls_verify_certificates == NULL)
3347 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3348 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3349 (tls_verify_hosts != NULL)? "" : "try_");
3351 /* This also checks that the library linkage is working and we can call
3352 routines in it, so call even if tls_require_ciphers is unset */
3353 if (!tls_dropprivs_validate_require_cipher())
3356 /* Magic number: at time of writing, 1024 has been the long-standing value
3357 used by so many clients, and what Exim used to use always, that it makes
3358 sense to just min-clamp this max-clamp at that. */
3359 if (tls_dh_max_bits < 1024)
3360 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3361 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3363 /* If openssl_options is set, validate it */
3364 if (openssl_options != NULL)
3367 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3368 "openssl_options is set but we're using GnuTLS");
3371 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3372 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3373 "openssl_options parse error: %s", openssl_options);
3381 /*************************************************
3382 * Initialize one driver *
3383 *************************************************/
3385 /* This is called once the driver's generic options, if any, have been read.
3386 We can now find the driver, set up defaults for the private options, and
3387 unset any "set" bits in the private options table (which might have been
3388 set by another incarnation of the same driver).
3391 d pointer to driver instance block, with generic
3393 drivers_available vector of available drivers
3394 size_of_info size of each block in drivers_available
3395 class class of driver, for error message
3397 Returns: pointer to the driver info block
3400 static driver_info *
3401 init_driver(driver_instance *d, driver_info *drivers_available,
3402 int size_of_info, uschar *class)
3406 for (dd = drivers_available; dd->driver_name[0] != 0;
3407 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3409 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3412 int len = dd->options_len;
3414 d->options_block = store_get(len);
3415 memcpy(d->options_block, dd->options_block, len);
3416 for (i = 0; i < *(dd->options_count); i++)
3417 dd->options[i].type &= ~opt_set;
3422 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3423 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3425 return NULL; /* never obeyed */
3431 /*************************************************
3432 * Initialize driver list *
3433 *************************************************/
3435 /* This function is called for routers, transports, and authentication
3436 mechanisms. It reads the data from the current point in the configuration file
3437 up to the end of the section, and sets up a chain of instance blocks according
3438 to the file's contents. The file will already have been opened by a call to
3439 readconf_main, and must be left open for subsequent reading of further data.
3441 Any errors cause a panic crash. Note that the blocks with names driver_info and
3442 driver_instance must map the first portions of all the _info and _instance
3443 blocks for this shared code to work.
3446 class "router", "transport", or "authenticator"
3447 anchor &routers, &transports, &auths
3448 drivers_available available drivers
3449 size_of_info size of each info block
3450 instance_default points to default data for an instance
3451 instance_size size of instance block
3452 driver_optionlist generic option list
3453 driver_optionlist_count count of generic option list
3459 readconf_driver_init(
3461 driver_instance **anchor,
3462 driver_info *drivers_available,
3464 void *instance_default,
3466 optionlist *driver_optionlist,
3467 int driver_optionlist_count)
3469 driver_instance **p = anchor;
3470 driver_instance *d = NULL;
3473 while ((buffer = get_config_line()) != NULL)
3478 /* Read the first name on the line and test for the start of a new driver. A
3479 macro definition indicates the end of the previous driver. If this isn't the
3480 start of a new driver, the line will be re-read. */
3482 s = readconf_readname(name, sizeof(name), buffer);
3484 /* Handle macro definition, first finishing off the initialization of the
3485 previous driver, if any. */
3487 if (isupper(*name) && *s == '=')
3491 if (d->driver_name == NULL)
3492 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3493 "no driver defined for %s \"%s\"", class, d->name);
3497 read_macro_assignment(buffer);
3501 /* If the line starts with a name terminated by a colon, we are at the
3502 start of the definition of a new driver. The rest of the line must be
3509 /* Finish off initializing the previous driver. */
3513 if (d->driver_name == NULL)
3514 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3515 "no driver defined for %s \"%s\"", class, d->name);
3519 /* Check that we haven't already got a driver of this name */
3521 for (d = *anchor; d != NULL; d = d->next)
3522 if (Ustrcmp(name, d->name) == 0)
3523 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3524 "there are two %ss called \"%s\"", class, name);
3526 /* Set up a new driver instance data block on the chain, with
3527 its default values installed. */
3529 d = store_get(instance_size);
3530 memcpy(d, instance_default, instance_size);
3533 d->name = string_copy(name);
3535 /* Clear out the "set" bits in the generic options */
3537 for (i = 0; i < driver_optionlist_count; i++)
3538 driver_optionlist[i].type &= ~opt_set;
3540 /* Check nothing more on this line, then do the next loop iteration. */
3542 while (isspace(*s)) s++;
3543 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3547 /* Not the start of a new driver. Give an error if we have not set up a
3548 current driver yet. */
3550 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3551 "%s name missing", class);
3553 /* First look to see if this is a generic option; if it is "driver",
3554 initialize the driver. If is it not a generic option, we can look for a
3555 private option provided that the driver has been previously set up. */
3557 if (readconf_handle_option(buffer, driver_optionlist,
3558 driver_optionlist_count, d, NULL))
3560 if (d->info == NULL && d->driver_name != NULL)
3561 init_driver(d, drivers_available, size_of_info, class);
3564 /* Handle private options - pass the generic block because some may
3565 live therein. A flag with each option indicates if it is in the public
3568 else if (d->info != NULL)
3570 readconf_handle_option(buffer, d->info->options,
3571 *(d->info->options_count), d, US"option \"%s\" unknown");
3574 /* The option is not generic and the driver name has not yet been given. */
3576 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3577 "(\"driver\" must be specified before any private options)", name);
3580 /* Run the initialization function for the final driver. */
3584 if (d->driver_name == NULL)
3585 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3586 "no driver defined for %s \"%s\"", class, d->name);
3593 /*************************************************
3594 * Check driver dependency *
3595 *************************************************/
3597 /* This function is passed a driver instance and a string. It checks whether
3598 any of the string options for the driver contains the given string as an
3602 d points to a driver instance block
3603 s the string to search for
3605 Returns: TRUE if a dependency is found
3609 readconf_depends(driver_instance *d, uschar *s)
3611 int count = *(d->info->options_count);
3615 for (ol = d->info->options; ol < d->info->options + count; ol++)
3617 void *options_block;
3619 int type = ol->type & opt_mask;
3620 if (type != opt_stringptr) continue;
3621 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3622 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3623 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3625 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3626 isalnum(ss[Ustrlen(s)])) continue;
3627 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3628 d->name, ol->name, s);
3633 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3640 /*************************************************
3641 * Decode an error type for retries *
3642 *************************************************/
3644 /* This function is global because it is also called from the main
3645 program when testing retry information. It decodes strings such as "quota_7d"
3646 into numerical error codes.
3649 pp points to start of text
3650 p points past end of text
3651 basic_errno points to an int to receive the main error number
3652 more_errno points to an int to receive the secondary error data
3654 Returns: NULL if decoded correctly; else points to error text
3658 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3662 while (q < p && *q != '_') q++;
3665 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3667 *basic_errno = ERRNO_EXIMQUOTA;
3668 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3669 return US"bad time value";
3672 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3674 *basic_errno = ECONNREFUSED;
3677 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3678 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3679 else return US"A or MX expected after \"refused\"";
3683 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3685 *basic_errno = ETIMEDOUT;
3689 int xlen = p - q - 1;
3692 static uschar *extras[] =
3693 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3694 static int values[] =
3695 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3697 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3699 if (strncmpic(x, extras[i], xlen) == 0)
3701 *more_errno = values[i];
3706 if (i >= sizeof(extras)/sizeof(uschar *))
3708 if (strncmpic(x, US"DNS", xlen) == 0)
3710 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3711 "available in retry rules (it has never worked) - treated as "
3714 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3719 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3720 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3721 strncmpic(pp, US"data_4", 6) == 0)
3724 int x = 255; /* means "any 4xx code" */
3725 if (p != pp + 8) bad = TRUE; else
3727 int a = pp[6], b = pp[7];
3731 if (isdigit(b)) x += b - '0';
3732 else if (b == 'x') x += 100;
3735 else if (a != 'x' || b != 'x') bad = TRUE;
3739 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3740 "x is literal and d is any digit", pp);
3742 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3743 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3744 *more_errno = x << 8;
3747 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3748 strncmpic(q+1, US"failed", p-q-1) == 0)
3749 *basic_errno = ERRNO_AUTHFAIL;
3751 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3752 *basic_errno = ERRNO_SMTPCLOSED;
3754 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3755 *basic_errno = ERRNO_TLSREQUIRED;
3757 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3758 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3766 /*************************************************
3767 * Read retry information *
3768 *************************************************/
3770 /* Each line of retry information contains:
3772 . A domain name pattern or an address pattern;
3774 . An error name, possibly with additional data, or *;
3776 . An optional sequence of retry items, each consisting of an identifying
3777 letter, a cutoff time, and optional parameters.
3779 All this is decoded and placed into a control block. */
3782 /* Subroutine to read an argument, preceded by a comma and terminated
3783 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3784 1 = fixed point number (returned *1000).
3787 paddr pointer to pointer to current character; updated
3788 type 0 => read a time; 1 => read a fixed point number
3790 Returns: time in seconds or fixed point number * 1000
3794 retry_arg(uschar **paddr, int type)
3799 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3801 while (isspace(*p)) p++;
3803 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3805 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3806 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3812 return readconf_readtime(pp, *p, FALSE);
3814 return readconf_readfixed(pp, *p);
3816 return 0; /* Keep picky compilers happy */
3819 /* The function proper */
3822 readconf_retries(void)
3824 retry_config **chain = &retries;
3828 while ((p = get_config_line()) != NULL)
3830 retry_rule **rchain;
3833 next = store_get(sizeof(retry_config));
3836 chain = &(next->next);
3837 next->basic_errno = next->more_errno = 0;
3838 next->senders = NULL;
3840 rchain = &(next->rules);
3842 next->pattern = string_dequote(&p);
3843 while (isspace(*p)) p++;
3845 while (mac_isgraph(*p)) p++;
3846 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3847 "missing error type in retry rule");
3849 /* Test error names for things we understand. */
3851 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3852 &(next->more_errno))) != NULL)
3853 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3855 /* There may be an optional address list of senders to be used as another
3856 constraint on the rule. This was added later, so the syntax is a bit of a
3857 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3860 while (isspace(*p)) p++;
3861 if (Ustrncmp(p, "senders", 7) == 0)
3864 while (isspace(*p)) p++;
3865 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3866 "\"=\" expected after \"senders\" in retry rule");
3867 while (isspace(*p)) p++;
3868 next->senders = string_dequote(&p);
3871 /* Now the retry rules. Keep the maximum timeout encountered. */
3873 while (isspace(*p)) p++;
3877 retry_rule *rule = store_get(sizeof(retry_rule));
3879 rchain = &(rule->next);
3881 rule->rule = toupper(*p++);
3882 rule->timeout = retry_arg(&p, 0);
3883 if (rule->timeout > retry_maximum_timeout)
3884 retry_maximum_timeout = rule->timeout;
3888 case 'F': /* Fixed interval */
3889 rule->p1 = retry_arg(&p, 0);
3892 case 'G': /* Geometrically increasing intervals */
3893 case 'H': /* Ditto, but with randomness */
3894 rule->p1 = retry_arg(&p, 0);
3895 rule->p2 = retry_arg(&p, 1);
3899 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3903 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3904 (rule->rule != 'F' && rule->p2 < 1000))
3905 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3906 "bad parameters for retry rule");
3908 while (isspace(*p)) p++;
3912 while (isspace(*p)) p++;
3915 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3922 /*************************************************
3923 * Initialize authenticators *
3924 *************************************************/
3926 /* Read the authenticators section of the configuration file.
3935 auth_instance *au, *bu;
3936 readconf_driver_init(US"authenticator",
3937 (driver_instance **)(&auths), /* chain anchor */
3938 (driver_info *)auths_available, /* available drivers */
3939 sizeof(auth_info), /* size of info block */
3940 &auth_defaults, /* default values for generic options */
3941 sizeof(auth_instance), /* size of instance block */
3942 optionlist_auths, /* generic options */
3943 optionlist_auths_size);
3945 for (au = auths; au != NULL; au = au->next)
3947 if (au->public_name == NULL)
3948 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3949 "the %s authenticator", au->name);
3950 for (bu = au->next; bu != NULL; bu = bu->next)
3952 if (strcmpic(au->public_name, bu->public_name) == 0)
3954 if ((au->client && bu->client) || (au->server && bu->server))
3955 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3956 "(%s and %s) have the same public name (%s)",
3957 (au->client)? US"client" : US"server", au->name, bu->name,
3967 /*************************************************
3968 * Read ACL information *
3969 *************************************************/
3971 /* If this run of Exim is not doing something that involves receiving a
3972 message, we can just skip over the ACL information. No need to parse it.
3974 First, we have a function for acl_read() to call back to get the next line. We
3975 need to remember the line we passed, because at the end it will contain the
3976 name of the next ACL. */
3978 static uschar *acl_line;
3983 acl_line = get_config_line();
3988 /* Now the main function:
3999 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
4002 acl_line = get_config_line();
4004 while(acl_line != NULL)
4010 p = readconf_readname(name, sizeof(name), acl_line);
4011 if (isupper(*name) && *p == '=')
4013 read_macro_assignment(acl_line);
4014 acl_line = get_config_line();
4018 if (*p != ':' || name[0] == 0)
4019 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4021 node = store_get(sizeof(tree_node) + Ustrlen(name));
4022 Ustrcpy(node->name, name);
4023 if (!tree_insertnode(&acl_anchor, node))
4024 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4025 "there are two ACLs called \"%s\"", name);
4027 node->data.ptr = acl_read(acl_callback, &error);
4029 if (node->data.ptr == NULL && error != NULL)
4030 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4036 /*************************************************
4037 * Read configuration for local_scan() *
4038 *************************************************/
4040 /* This function is called after "begin local_scan" is encountered in the
4041 configuration file. If the local_scan() function allows for configuration
4042 options, we can process them. Otherwise, we expire in a panic.
4049 local_scan_init(void)
4051 #ifndef LOCAL_SCAN_HAS_OPTIONS
4052 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4053 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4057 while ((p = get_config_line()) != NULL)
4059 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4060 NULL, US"local_scan option \"%s\" unknown");
4067 /*************************************************
4068 * Read rest of configuration (after main) *
4069 *************************************************/
4071 /* This function reads the rest of the runtime configuration, after the main
4072 configuration. It is called only when actually needed. Each subsequent section
4073 of the configuration starts with a line of the form
4077 where the name is "routers", "transports", etc. A section is terminated by
4078 hitting the next "begin" line, and the next name is left in next_section.
4079 Because it may confuse people as to whether the names are singular or plural,
4080 we add "s" if it's missing. There is always enough room in next_section for
4081 this. This function is basically just a switch.
4087 static uschar *section_list[] = {
4101 while(next_section[0] != 0)
4105 int last = sizeof(section_list) / sizeof(uschar *);
4107 int n = Ustrlen(next_section);
4109 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4113 int c = strcmpic(next_section, section_list[mid]);
4115 if (c > 0) first = mid + 1; else last = mid;
4117 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4118 "\"%.*s\" is not a known configuration section name", n, next_section);
4119 mid = (last + first)/2;
4123 if (((had ^= bit) & bit) == 0)
4124 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4125 "\"%.*s\" section is repeated in the configuration file", n,
4130 case 0: readconf_acl(); break;
4131 case 1: auths_init(); break;
4132 case 2: local_scan_init(); break;
4133 case 3: readconf_retries(); break;
4134 case 4: readconf_rewrites(); break;
4135 case 5: route_init(); break;
4136 case 6: transport_init(); break;
4140 (void)fclose(config_file);
4145 /* End of readconf.c */