1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
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 },
143 #ifdef EXPERIMENTAL_PRDR
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 { "dsn_from", opt_stringptr, &dsn_from },
233 { "envelope_to_remove", opt_bool, &envelope_to_remove },
234 { "errors_copy", opt_stringptr, &errors_copy },
235 { "errors_reply_to", opt_stringptr, &errors_reply_to },
236 { "exim_group", opt_gid, &exim_gid },
237 { "exim_path", opt_stringptr, &exim_path },
238 { "exim_user", opt_uid, &exim_uid },
239 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
240 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
241 { "finduser_retries", opt_int, &finduser_retries },
242 { "freeze_tell", opt_stringptr, &freeze_tell },
243 { "gecos_name", opt_stringptr, &gecos_name },
244 { "gecos_pattern", opt_stringptr, &gecos_pattern },
246 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
247 { "gnutls_enable_pkcs11", opt_bool, &gnutls_enable_pkcs11 },
248 /* These three gnutls_require_* options stopped working in Exim 4.80 */
249 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
250 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
251 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
253 { "header_line_maxsize", opt_int, &header_line_maxsize },
254 { "header_maxsize", opt_int, &header_maxsize },
255 { "headers_charset", opt_stringptr, &headers_charset },
256 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
257 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
258 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
259 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
260 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
261 { "hold_domains", opt_stringptr, &hold_domains },
262 { "host_lookup", opt_stringptr, &host_lookup },
263 { "host_lookup_order", opt_stringptr, &host_lookup_order },
264 { "host_reject_connection", opt_stringptr, &host_reject_connection },
265 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
266 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
268 { "ibase_servers", opt_stringptr, &ibase_servers },
270 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
271 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
272 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
273 { "keep_malformed", opt_time, &keep_malformed },
275 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
276 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
277 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
278 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
279 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
280 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
281 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
282 { "ldap_start_tls", opt_bool, &eldap_start_tls },
283 { "ldap_version", opt_int, &eldap_version },
285 { "local_from_check", opt_bool, &local_from_check },
286 { "local_from_prefix", opt_stringptr, &local_from_prefix },
287 { "local_from_suffix", opt_stringptr, &local_from_suffix },
288 { "local_interfaces", opt_stringptr, &local_interfaces },
289 { "local_scan_timeout", opt_time, &local_scan_timeout },
290 { "local_sender_retain", opt_bool, &local_sender_retain },
291 { "localhost_number", opt_stringptr, &host_number_string },
292 { "log_file_path", opt_stringptr, &log_file_path },
293 { "log_selector", opt_stringptr, &log_selector_string },
294 { "log_timezone", opt_bool, &log_timezone },
295 { "lookup_open_max", opt_int, &lookup_open_max },
296 { "max_username_length", opt_int, &max_username_length },
297 { "message_body_newlines", opt_bool, &message_body_newlines },
298 { "message_body_visible", opt_mkint, &message_body_visible },
299 { "message_id_header_domain", opt_stringptr, &message_id_domain },
300 { "message_id_header_text", opt_stringptr, &message_id_text },
301 { "message_logs", opt_bool, &message_logs },
302 { "message_size_limit", opt_stringptr, &message_size_limit },
303 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
304 { "move_frozen_messages", opt_bool, &move_frozen_messages },
306 { "mua_wrapper", opt_bool, &mua_wrapper },
308 { "mysql_servers", opt_stringptr, &mysql_servers },
310 { "never_users", opt_uidlist, &never_users },
312 { "openssl_options", opt_stringptr, &openssl_options },
315 { "oracle_servers", opt_stringptr, &oracle_servers },
317 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
319 { "perl_at_start", opt_bool, &opt_perl_at_start },
320 { "perl_startup", opt_stringptr, &opt_perl_startup },
323 { "pgsql_servers", opt_stringptr, &pgsql_servers },
325 { "pid_file_path", opt_stringptr, &pid_file_path },
326 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
327 #ifdef EXPERIMENTAL_PRDR
328 { "prdr_enable", opt_bool, &prdr_enable },
330 { "preserve_message_logs", opt_bool, &preserve_message_logs },
331 { "primary_hostname", opt_stringptr, &primary_hostname },
332 { "print_topbitchars", opt_bool, &print_topbitchars },
333 { "process_log_path", opt_stringptr, &process_log_path },
334 { "prod_requires_admin", opt_bool, &prod_requires_admin },
335 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
336 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
337 { "queue_domains", opt_stringptr, &queue_domains },
338 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
339 { "queue_only", opt_bool, &queue_only },
340 { "queue_only_file", opt_stringptr, &queue_only_file },
341 { "queue_only_load", opt_fixed, &queue_only_load },
342 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
343 { "queue_only_override", opt_bool, &queue_only_override },
344 { "queue_run_in_order", opt_bool, &queue_run_in_order },
345 { "queue_run_max", opt_int, &queue_run_max },
346 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
347 { "receive_timeout", opt_time, &receive_timeout },
348 { "received_header_text", opt_stringptr, &received_header_text },
349 { "received_headers_max", opt_int, &received_headers_max },
350 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
351 { "recipients_max", opt_int, &recipients_max },
352 { "recipients_max_reject", opt_bool, &recipients_max_reject },
353 { "remote_max_parallel", opt_int, &remote_max_parallel },
354 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
355 { "retry_data_expire", opt_time, &retry_data_expire },
356 { "retry_interval_max", opt_time, &retry_interval_max },
357 { "return_path_remove", opt_bool, &return_path_remove },
358 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
359 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
360 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
361 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
362 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
363 { "smtp_accept_max", opt_int, &smtp_accept_max },
364 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
365 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
366 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
367 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
368 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
369 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
370 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
371 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
372 { "smtp_banner", opt_stringptr, &smtp_banner },
373 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
374 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
375 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
376 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
377 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
378 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
379 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
380 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
381 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
382 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
383 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
384 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
385 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
386 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
387 #ifdef WITH_CONTENT_SCAN
388 { "spamd_address", opt_stringptr, &spamd_address },
390 #ifdef EXPERIMENTAL_SPF
391 { "spf_guess", opt_stringptr, &spf_guess },
393 { "split_spool_directory", opt_bool, &split_spool_directory },
394 { "spool_directory", opt_stringptr, &spool_directory },
396 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
398 #ifdef EXPERIMENTAL_SRS
399 { "srs_config", opt_stringptr, &srs_config },
400 { "srs_hashlength", opt_int, &srs_hashlength },
401 { "srs_hashmin", opt_int, &srs_hashmin },
402 { "srs_maxage", opt_int, &srs_maxage },
403 { "srs_secrets", opt_stringptr, &srs_secrets },
404 { "srs_usehash", opt_bool, &srs_usehash },
405 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
407 { "strict_acl_vars", opt_bool, &strict_acl_vars },
408 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
409 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
410 { "syslog_duplication", opt_bool, &syslog_duplication },
411 { "syslog_facility", opt_stringptr, &syslog_facility_str },
412 { "syslog_processname", opt_stringptr, &syslog_processname },
413 { "syslog_timestamp", opt_bool, &syslog_timestamp },
414 { "system_filter", opt_stringptr, &system_filter },
415 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
416 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
417 { "system_filter_group", opt_gid, &system_filter_gid },
418 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
419 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
420 { "system_filter_user", opt_uid, &system_filter_uid },
421 { "tcp_nodelay", opt_bool, &tcp_nodelay },
422 #ifdef USE_TCP_WRAPPERS
423 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
425 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
426 { "timezone", opt_stringptr, &timezone_string },
428 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
429 { "tls_certificate", opt_stringptr, &tls_certificate },
430 { "tls_crl", opt_stringptr, &tls_crl },
431 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
432 { "tls_dhparam", opt_stringptr, &tls_dhparam },
433 # if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
434 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
436 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
437 { "tls_privatekey", opt_stringptr, &tls_privatekey },
438 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
439 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
440 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
441 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
442 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
444 { "trusted_groups", opt_gidlist, &trusted_groups },
445 { "trusted_users", opt_uidlist, &trusted_users },
446 { "unknown_login", opt_stringptr, &unknown_login },
447 { "unknown_username", opt_stringptr, &unknown_username },
448 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
449 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
450 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
451 { "warn_message_file", opt_stringptr, &warn_message_file },
452 { "write_rejectlog", opt_bool, &write_rejectlog }
455 static int optionlist_config_size =
456 sizeof(optionlist_config)/sizeof(optionlist);
460 /*************************************************
461 * Find the name of an option *
462 *************************************************/
464 /* This function is to aid debugging. Various functions take arguments that are
465 pointer variables in the options table or in option tables for various drivers.
466 For debugging output, it is useful to be able to find the name of the option
467 which is currently being processed. This function finds it, if it exists, by
468 searching the table(s).
470 Arguments: a value that is presumed to be in the table above
471 Returns: the option name, or an empty string
475 readconf_find_option(void *p)
479 transport_instance *t;
481 for (i = 0; i < optionlist_config_size; i++)
482 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
484 for (r = routers; r != NULL; r = r->next)
486 router_info *ri = r->info;
487 for (i = 0; i < ri->options_count[0]; i++)
489 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
490 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
491 return US ri->options[i].name;
495 for (t = transports; t != NULL; t = t->next)
497 transport_info *ti = t->info;
498 for (i = 0; i < ti->options_count[0]; i++)
500 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
501 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
502 return US ti->options[i].name;
512 /*************************************************
513 * Deal with an assignment to a macro *
514 *************************************************/
516 /* This function is called when a line that starts with an upper case letter is
517 encountered. The argument "line" should contain a complete logical line, and
518 start with the first letter of the macro name. The macro name and the
519 replacement text are extracted and stored. Redefinition of existing,
520 non-command line, macros is permitted using '==' instead of '='.
523 s points to the start of the logical line
529 read_macro_assignment(uschar *s)
535 macro_item *mlast = NULL;
537 while (isalnum(*s) || *s == '_')
539 if (namelen >= sizeof(name) - 1)
540 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
541 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
542 name[namelen++] = *s++;
546 while (isspace(*s)) s++;
548 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
555 while (isspace(*s)) s++;
557 /* If an existing macro of the same name was defined on the command line, we
558 just skip this definition. It's an error to attempt to redefine a macro without
559 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
560 It is also an error to define a macro whose name begins with the name of a
561 previously defined macro. Note: it is documented that the other way round
564 for (m = macros; m != NULL; m = m->next)
566 int len = Ustrlen(m->name);
568 if (Ustrcmp(m->name, name) == 0)
570 if (!m->command_line && !redef)
571 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
572 "defined (use \"==\" if you want to redefine it", name);
576 if (len < namelen && Ustrstr(name, m->name) != NULL)
577 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
578 "a macro because previously defined macro \"%s\" is a substring",
581 /* We cannot have this test, because it is documented that a substring
582 macro is permitted (there is even an example).
584 * if (len > namelen && Ustrstr(m->name, name) != NULL)
585 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
586 * "a macro because it is a substring of previously defined macro \"%s\"",
593 /* Check for an overriding command-line definition. */
595 if (m != NULL && m->command_line) return;
597 /* Redefinition must refer to an existing macro. */
602 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
606 /* We have a new definition. The macro_item structure includes a final vector
607 called "name" which is one byte long. Thus, adding "namelen" gives us enough
608 room to store the "name" string. */
612 m = store_get(sizeof(macro_item) + namelen);
613 if (macros == NULL) macros = m; else mlast->next = m;
614 Ustrncpy(m->name, name, namelen);
615 m->name[namelen] = 0;
617 m->command_line = FALSE;
620 /* Set the value of the new or redefined macro */
622 m->replacement = string_copy(s);
629 /*************************************************
630 * Read configuration line *
631 *************************************************/
633 /* A logical line of text is read from the configuration file into the big
634 buffer, taking account of macros, .includes, and continuations. The size of
635 big_buffer is increased if necessary. The count of configuration lines is
636 maintained. Physical input lines starting with # (ignoring leading white space,
637 and after macro replacement) and empty logical lines are always ignored.
638 Leading and trailing spaces are removed.
640 If we hit a line of the form "begin xxxx", the xxxx is placed in the
641 next_section vector, and the function returns NULL, indicating the end of a
642 configuration section. On end-of-file, NULL is returned with next_section
647 Returns: a pointer to the first non-blank in the line,
648 or NULL if eof or end of section is reached
652 get_config_line(void)
654 int startoffset = 0; /* To first non-blank char in logical line */
655 int len = 0; /* Of logical line so far */
661 /* Loop for handling continuation lines, skipping comments, and dealing with
666 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
668 if (config_file_stack != NULL) /* EOF inside .include */
670 (void)fclose(config_file);
671 config_file = config_file_stack->file;
672 config_filename = config_file_stack->filename;
673 config_lineno = config_file_stack->lineno;
674 config_file_stack = config_file_stack->next;
678 /* EOF at top level */
680 if (cstate_stack_ptr >= 0)
681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
682 "Unexpected end of configuration file: .endif missing");
684 if (len != 0) break; /* EOF after continuation */
685 next_section[0] = 0; /* EOF at start of logical line */
690 newlen = len + Ustrlen(big_buffer + len);
692 /* Handle pathologically long physical lines - yes, it did happen - by
693 extending big_buffer at this point. The code also copes with very long
696 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
699 big_buffer_size += BIG_BUFFER_SIZE;
700 newbuffer = store_malloc(big_buffer_size);
702 /* This use of strcpy is OK because we know that the string in the old
703 buffer is shorter than the new buffer. */
705 Ustrcpy(newbuffer, big_buffer);
706 store_free(big_buffer);
707 big_buffer = newbuffer;
708 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
710 newlen += Ustrlen(big_buffer + newlen);
713 /* Find the true start of the physical line - leading spaces are always
716 ss = big_buffer + len;
717 while (isspace(*ss)) ss++;
719 /* Process the physical line for macros. If this is the start of the logical
720 line, skip over initial text at the start of the line if it starts with an
721 upper case character followed by a sequence of name characters and an equals
722 sign, because that is the definition of a new macro, and we don't do
723 replacement therein. */
726 if (len == 0 && isupper(*s))
728 while (isalnum(*s) || *s == '_') s++;
729 while (isspace(*s)) s++;
730 if (*s != '=') s = ss; /* Not a macro definition */
733 /* For each defined macro, scan the line (from after XXX= if present),
734 replacing all occurrences of the macro. */
737 for (m = macros; m != NULL; m = m->next)
742 while ((p = Ustrstr(t, m->name)) != NULL)
745 int namelen = Ustrlen(m->name);
746 int replen = Ustrlen(m->replacement);
748 /* Expand the buffer if necessary */
750 while (newlen - namelen + replen + 1 > big_buffer_size)
752 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
753 uschar *newbuffer = store_malloc(newsize);
754 memcpy(newbuffer, big_buffer, newlen + 1);
755 p = newbuffer + (p - big_buffer);
756 s = newbuffer + (s - big_buffer);
757 ss = newbuffer + (ss - big_buffer);
758 t = newbuffer + (t - big_buffer);
759 big_buffer_size = newsize;
760 store_free(big_buffer);
761 big_buffer = newbuffer;
764 /* Shuffle the remaining characters up or down in the buffer before
765 copying in the replacement text. Don't rescan the replacement for this
769 moveby = replen - namelen;
772 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
775 Ustrncpy(p, m->replacement, replen);
781 /* An empty macro replacement at the start of a line could mean that ss no
782 longer points to the first non-blank character. */
784 while (isspace(*ss)) ss++;
786 /* Check for comment lines - these are physical lines. */
788 if (*ss == '#') continue;
790 /* Handle conditionals, which are also applied to physical lines. Conditions
791 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
792 expansion occured on the rest of the line. A preliminary test for the leading
793 '.' saves effort on most lines. */
799 /* Search the list of conditional directives */
801 for (i = 0; i < cond_list_size; i++)
804 cond_item *c = cond_list+i;
805 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
807 /* The following character must be white space or end of string */
809 n = ss[1 + c->namelen];
810 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
812 /* .ifdef and .ifndef push the current state onto the stack, then set
813 a new one from the table. Stack overflow is an error */
817 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
818 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
819 ".%s nested too deeply", c->name);
820 cstate_stack[++cstate_stack_ptr] = cstate;
821 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
824 /* For any of the others, stack underflow is an error. The next state
825 comes either from the stack (.endif) or from the table. */
829 if (cstate_stack_ptr < 0)
830 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
831 ".%s without matching .ifdef", c->name);
832 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
833 next_cstate[cstate][macro_found? c->action1 : c->action2];
836 /* Having dealt with a directive, break the loop */
841 /* If we have handled a conditional directive, continue with the next
842 physical line. Otherwise, fall through. */
844 if (i < cond_list_size) continue;
847 /* If the conditional state is not 0 (actively using these lines), ignore
850 if (cstate != 0) continue; /* Conditional skip */
852 /* Handle .include lines - these are also physical lines. */
854 if (Ustrncmp(ss, ".include", 8) == 0 &&
856 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
859 int include_if_exists = isspace(ss[8])? 0 : 10;
860 config_file_item *save;
863 ss += 9 + include_if_exists;
864 while (isspace(*ss)) ss++;
865 t = ss + Ustrlen(ss);
866 while (t > ss && isspace(t[-1])) t--;
867 if (*ss == '\"' && t[-1] == '\"')
875 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
876 "absolute path \"%s\"", ss);
878 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
880 save = store_get(sizeof(config_file_item));
881 save->next = config_file_stack;
882 config_file_stack = save;
883 save->file = config_file;
884 save->filename = config_filename;
885 save->lineno = config_lineno;
887 config_file = Ufopen(ss, "rb");
888 if (config_file == NULL)
889 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
890 "configuration file %s", ss);
891 config_filename = string_copy(ss);
896 /* If this is the start of the logical line, remember where the non-blank
897 data starts. Otherwise shuffle down continuation lines to remove leading
901 startoffset = ss - big_buffer;
904 s = big_buffer + len;
907 memmove(s, ss, (newlen - len) - (ss - s) + 1);
912 /* Accept the new addition to the line. Remove trailing white space. */
915 while (len > 0 && isspace(big_buffer[len-1])) len--;
918 /* We are done if the line does not end in backslash and contains some data.
919 Empty logical lines are ignored. For continuations, remove the backslash and
920 go round the loop to read the continuation line. */
924 if (big_buffer[len-1] != '\\') break; /* End of logical line */
925 big_buffer[--len] = 0; /* Remove backslash */
927 } /* Loop for reading multiple physical lines */
929 /* We now have a logical line. Test for the end of a configuration section (or,
930 more accurately, for the start of the next section). Place the name of the next
931 section in next_section, and return NULL. If the name given is longer than
932 next_section, truncate it. It will be unrecognized later, because all the known
933 section names do fit. Leave space for pluralizing. */
935 s = big_buffer + startoffset; /* First non-space character */
936 if (strncmpic(s, US"begin ", 6) == 0)
939 while (isspace(*s)) s++;
940 if (big_buffer + len - s > sizeof(next_section) - 2)
941 s[sizeof(next_section) - 2] = 0;
942 Ustrcpy(next_section, s);
946 /* Return the first non-blank character. */
953 /*************************************************
955 *************************************************/
957 /* The yield is the pointer to the next uschar. Names longer than the
958 output space are silently truncated. This function is also used from acl.c when
962 name where to put the name
966 Returns: new input pointer
970 readconf_readname(uschar *name, int len, uschar *s)
973 while (isspace(*s)) s++;
976 while (isalnum(*s) || *s == '_')
978 if (p < len-1) name[p++] = *s;
983 while (isspace(*s)) s++;
990 /*************************************************
991 * Read a time value *
992 *************************************************/
994 /* This function is also called from outside, to read argument
995 time values. The format of a time value is:
997 [<n>w][<n>d][<n>h][<n>m][<n>s]
999 as long as at least one is present. If a format error is encountered,
1000 return a negative value. The value must be terminated by the given
1005 terminator required terminating character
1006 return_msec if TRUE, allow fractional seconds and return milliseconds
1008 Returns: the time value, or -1 on syntax error
1009 value is seconds if return_msec is FALSE
1010 value is milliseconds if return_msec is TRUE
1014 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1022 if (!isdigit(*s)) return -1;
1023 (void)sscanf(CS s, "%d%n", &value, &count);
1028 case 'w': value *= 7;
1029 case 'd': value *= 24;
1030 case 'h': value *= 60;
1031 case 'm': value *= 60;
1036 if (!return_msec) return -1;
1037 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1039 if (*s++ != 's') return -1;
1040 yield += (int)(fraction * 1000.0);
1046 if (return_msec) value *= 1000;
1048 if (*s == terminator) return yield;
1050 /* Control never reaches here. */
1055 /*************************************************
1056 * Read a fixed point value *
1057 *************************************************/
1059 /* The value is returned *1000
1063 terminator required terminator
1065 Returns: the value, or -1 on error
1069 readconf_readfixed(uschar *s, int terminator)
1073 if (!isdigit(*s)) return -1;
1074 (void)sscanf(CS s, "%d%n", &value, &count);
1076 yield = value * 1000;
1080 while (isdigit((*(++s))))
1082 yield += (*s - '0') * m;
1087 return (*s == terminator)? yield : (-1);
1092 /*************************************************
1093 * Find option in list *
1094 *************************************************/
1096 /* The lists are always in order, so binary chop can be used.
1099 name the option name to search for
1100 ol the first entry in the option list
1101 last one more than the offset of the last entry in the option list
1103 Returns: pointer to an option entry, or NULL if not found
1107 find_option(uschar *name, optionlist *ol, int last)
1110 while (last > first)
1112 int middle = (first + last)/2;
1113 int c = Ustrcmp(name, ol[middle].name);
1114 if (c == 0) return ol + middle;
1115 else if (c > 0) first = middle + 1;
1123 /*************************************************
1124 * Find a set flag in option list *
1125 *************************************************/
1127 /* Because some versions of Unix make no restrictions on the values of uids and
1128 gids (even negative ones), we cannot represent "unset" by a special value.
1129 There is therefore a separate boolean variable for each one indicating whether
1130 a value is set or not. This function returns a pointer to the boolean, given
1131 the original option name. It is a major disaster if the flag cannot be found.
1134 name the name of the uid or gid option
1135 oltop points to the start of the relevant option list
1136 last one more than the offset of the last item in the option list
1137 data_block NULL when reading main options => data values in the option
1138 list are absolute addresses; otherwise they are byte offsets
1139 in data_block (used for driver options)
1141 Returns: a pointer to the boolean flag.
1145 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1149 sprintf(CS name2, "*set_%.50s", name);
1150 ol = find_option(name2, oltop, last);
1151 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1152 "Exim internal error: missing set flag for %s", name);
1153 return (data_block == NULL)? (BOOL *)(ol->value) :
1154 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1160 /*************************************************
1161 * Output extra characters message and die *
1162 *************************************************/
1164 /* Called when an option line has junk on the end. Sometimes this is because
1165 the sysadmin thinks comments are permitted.
1168 s points to the extra characters
1169 t1..t3 strings to insert in the log message
1171 Returns: doesn't return; dies
1175 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1177 uschar *comment = US"";
1178 if (*s == '#') comment = US" (# is comment only at line start)";
1179 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1180 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1185 /*************************************************
1186 * Read rewrite information *
1187 *************************************************/
1189 /* Each line of rewrite information contains:
1191 . A complete address in the form user@domain, possibly with
1192 leading * for each part; or alternatively, a regex.
1194 . A replacement string (which will be expanded).
1196 . An optional sequence of one-letter flags, indicating which
1197 headers etc. to apply this rule to.
1199 All this is decoded and placed into a control block. The OR of the flags is
1200 maintained in a common word.
1203 p points to the string that makes up the rule
1204 existflags points to the overall flag word
1205 isglobal TRUE if reading global rewrite rules
1207 Returns: the control block for the parsed rule.
1210 static rewrite_rule *
1211 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1213 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1216 next->key = string_dequote(&p);
1218 while (isspace(*p)) p++;
1220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1221 "missing rewrite replacement string");
1224 next->replacement = string_dequote(&p);
1226 while (*p != 0) switch (*p++)
1228 case ' ': case '\t': break;
1230 case 'q': next->flags |= rewrite_quit; break;
1231 case 'w': next->flags |= rewrite_whole; break;
1233 case 'h': next->flags |= rewrite_all_headers; break;
1234 case 's': next->flags |= rewrite_sender; break;
1235 case 'f': next->flags |= rewrite_from; break;
1236 case 't': next->flags |= rewrite_to; break;
1237 case 'c': next->flags |= rewrite_cc; break;
1238 case 'b': next->flags |= rewrite_bcc; break;
1239 case 'r': next->flags |= rewrite_replyto; break;
1241 case 'E': next->flags |= rewrite_all_envelope; break;
1242 case 'F': next->flags |= rewrite_envfrom; break;
1243 case 'T': next->flags |= rewrite_envto; break;
1245 case 'Q': next->flags |= rewrite_qualify; break;
1246 case 'R': next->flags |= rewrite_repeat; break;
1249 next->flags |= rewrite_smtp;
1250 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1251 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1252 "rewrite rule has the S flag but is not a regular expression");
1256 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1257 "unknown rewrite flag character '%c' "
1258 "(could be missing quotes round replacement item)", p[-1]);
1262 /* If no action flags are set, set all the "normal" rewrites. */
1264 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1265 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1267 /* Remember which exist, for optimization, and return the rule */
1269 *existflags |= next->flags;
1276 /*************************************************
1277 * Read global rewrite information *
1278 *************************************************/
1280 /* Each line is a single rewrite rule; it is parsed into a control block
1281 by readconf_one_rewrite(), and its flags are ORed into the global flag
1282 word rewrite_existflags. */
1285 readconf_rewrites(void)
1287 rewrite_rule **chain = &global_rewrite_rules;
1290 while ((p = get_config_line()) != NULL)
1292 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1294 chain = &(next->next);
1300 /*************************************************
1302 *************************************************/
1304 /* Strings are read into the normal store pool. As long we aren't too
1305 near the end of the current block, the string will just use what is necessary
1306 on the top of the stacking pool, because string_cat() uses the extension
1310 s the rest of the input line
1311 name the option name (for errors)
1313 Returns: pointer to the string
1317 read_string(uschar *s, uschar *name)
1322 if (*s != '\"') return string_copy(s);
1325 yield = string_dequote(&s);
1327 if (s == ss+1 || s[-1] != '\"')
1328 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1329 "missing quote at end of string value for %s", name);
1331 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1337 /*************************************************
1338 * Handle option line *
1339 *************************************************/
1341 /* This function is called from several places to process a line containing the
1342 setting of an option. The first argument is the line to be decoded; it has been
1343 checked not to be empty and not to start with '#'. Trailing newlines and white
1344 space have been removed. The second argument is a pointer to the list of
1345 variable names that are to be recognized, together with their types and
1346 locations, and the third argument gives the number of entries in the list.
1348 The fourth argument is a pointer to a data block. If it is NULL, then the data
1349 values in the options list are absolute addresses. Otherwise, they are byte
1350 offsets in the data block.
1352 String option data may continue onto several lines; this function reads further
1353 data from config_file if necessary.
1355 The yield of this function is normally zero. If a string continues onto
1356 multiple lines, then the data value is permitted to be followed by a comma
1357 or a semicolon (for use in drivers) and the yield is that character.
1360 buffer contains the configuration line to be handled
1361 oltop points to the start of the relevant option list
1362 last one more than the offset of the last item in the option list
1363 data_block NULL when reading main options => data values in the option
1364 list are absolute addresses; otherwise they are byte offsets
1365 in data_block when they have opt_public set; otherwise
1366 they are byte offsets in data_block->options_block.
1367 unknown_txt format string to use in panic message for unknown option;
1368 must contain %s for option name
1369 if given as NULL, don't panic on unknown option
1371 Returns: TRUE if an option was read successfully,
1372 FALSE false for an unknown option if unknown_txt == NULL,
1373 otherwise panic and die on an unknown option
1377 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1378 void *data_block, uschar *unknown_txt)
1382 int n, count, type, value;
1386 BOOL boolvalue = TRUE;
1387 BOOL freesptr = TRUE;
1388 optionlist *ol, *ol2;
1392 uschar *inttype = US"";
1395 uschar *saved_condition, *strtemp;
1396 uschar **str_target;
1400 /* There may be leading spaces; thereafter, we expect an option name starting
1403 while (isspace(*s)) s++;
1405 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1407 /* Read the name of the option, and skip any subsequent white space. If
1408 it turns out that what we read was "hide", set the flag indicating that
1409 this is a secure option, and loop to read the next word. */
1411 for (n = 0; n < 2; n++)
1413 while (isalnum(*s) || *s == '_')
1415 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1419 while (isspace(*s)) s++;
1420 if (Ustrcmp(name, "hide") != 0) break;
1421 issecure = opt_secure;
1425 /* Deal with "no_" or "not_" here for booleans */
1427 if (Ustrncmp(name, "no_", 3) == 0)
1433 if (Ustrncmp(name, "not_", 4) == 0)
1439 /* Search the list for the given name. A non-existent name, or an option that
1440 is set twice, is a disaster. */
1442 ol = find_option(name + offset, oltop, last);
1446 if (unknown_txt == NULL) return FALSE;
1447 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1450 if ((ol->type & opt_set) && !(ol->type & (opt_rep_con | opt_rep_str)))
1451 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1452 "\"%s\" option set for the second time", name);
1454 ol->type |= opt_set | issecure;
1455 type = ol->type & opt_mask;
1457 /* Types with data values must be followed by '='; the "no[t]_" prefix
1458 applies only to boolean values. */
1460 if (type < opt_bool || type > opt_bool_last)
1463 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1464 "negation prefix applied to a non-boolean option");
1466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1467 "unexpected end of line (data missing) after %s", name);
1469 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1472 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1473 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1474 ultimately expands to one of those values. */
1476 else if (*s != 0 && (offset != 0 || *s != '='))
1477 extra_chars_error(s, US"boolean option ", name, US"");
1479 /* Skip white space after = */
1481 if (*s == '=') while (isspace((*(++s))));
1483 /* If there is a data block and the opt_public flag is not set, change
1484 the data block pointer to the private options block. */
1486 if (data_block != NULL && (ol->type & opt_public) == 0)
1487 data_block = (void *)(((driver_instance *)data_block)->options_block);
1489 /* Now get the data according to the type. */
1493 /* If a string value is not enclosed in quotes, it consists of
1494 the rest of the current line, verbatim. Otherwise, string escapes
1497 A transport is specified as a string, which is then looked up in the
1498 list of transports. A search type is specified as one of a number of
1501 A set or rewrite rules for a driver is specified as a string, which is
1502 then parsed into a suitable chain of control blocks.
1504 Uids and gids are specified as strings which are then looked up in the
1505 passwd file. Lists of uids and gids are similarly specified as colon-
1506 separated strings. */
1511 case opt_expand_uid:
1512 case opt_expand_gid:
1517 reset_point = sptr = read_string(s, name);
1519 /* Having read a string, we now have several different ways of using it,
1520 depending on the data type, so do another switch. If keeping the actual
1521 string is not required (because it is interpreted), freesptr is set TRUE,
1522 and at the end we reset the pool. */
1526 /* If this was a string, set the variable to point to the new string,
1527 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1528 rules, we still keep the string (for printing), and parse the rules into a
1529 control block and flags word. */
1532 if (data_block == NULL)
1533 str_target = (uschar **)(ol->value);
1535 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1536 if (ol->type & opt_rep_con)
1538 /* We already have a condition, we're conducting a crude hack to let
1539 multiple condition rules be chained together, despite storing them in
1541 saved_condition = *str_target;
1542 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1543 saved_condition, sptr);
1544 *str_target = string_copy_malloc(strtemp);
1545 /* TODO(pdp): there is a memory leak here and just below
1546 when we set 3 or more conditions; I still don't
1547 understand the store mechanism enough to know
1548 what's the safe way to free content from an earlier store.
1549 AFAICT, stores stack, so freeing an early stored item also stores
1550 all data alloc'd after it. If we knew conditions were adjacent,
1551 we could survive that, but we don't. So I *think* we need to take
1552 another bit from opt_type to indicate "malloced"; this seems like
1553 quite a hack, especially for this one case. It also means that
1554 we can't ever reclaim the store from the *first* condition.
1556 Because we only do this once, near process start-up, I'm prepared to
1557 let this slide for the time being, even though it rankles. */
1559 else if (*str_target && (ol->type & opt_rep_str))
1561 uschar sep = Ustrncmp(name, "headers_add", 11)==0 ? '\n' : ':';
1562 saved_condition = *str_target;
1563 strtemp = saved_condition + Ustrlen(saved_condition)-1;
1564 if (*strtemp == sep) *strtemp = 0; /* eliminate trailing list-sep */
1565 strtemp = string_sprintf("%s%c%s", saved_condition, sep, sptr);
1566 *str_target = string_copy_malloc(strtemp);
1576 if (data_block == NULL)
1577 *((uschar **)(ol->value)) = sptr;
1579 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1581 if (type == opt_rewrite)
1586 rewrite_rule **chain;
1589 sprintf(CS name2, "*%.50s_rules", name);
1590 ol2 = find_option(name2, oltop, last);
1591 sprintf(CS name2, "*%.50s_flags", name);
1592 ol3 = find_option(name2, oltop, last);
1594 if (ol2 == NULL || ol3 == NULL)
1595 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1596 "rewrite rules not available for driver");
1598 if (data_block == NULL)
1600 chain = (rewrite_rule **)(ol2->value);
1601 flagptr = (int *)(ol3->value);
1605 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1606 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1609 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1612 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1614 chain = &(next->next);
1617 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1618 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1619 "non-header rewrite - not allowed at transport time -");
1623 /* If it was an expanded uid, see if there is any expansion to be
1624 done by checking for the presence of a $ character. If there is, save it
1625 in the corresponding *expand_user option field. Otherwise, fall through
1626 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1629 case opt_expand_uid:
1630 sprintf(CS name2, "*expand_%.50s", name);
1631 ol2 = find_option(name2, oltop, last);
1634 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1636 if (data_block == NULL)
1637 *((uschar **)(ol2->value)) = ss;
1639 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1643 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1649 /* Look up a fixed uid, and also make use of the corresponding gid
1650 if a passwd entry is returned and the gid has not been set. */
1653 if (!route_finduser(sptr, &pw, &uid))
1654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1655 if (data_block == NULL)
1656 *((uid_t *)(ol->value)) = uid;
1658 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1660 /* Set the flag indicating a fixed value is set */
1662 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1664 /* Handle matching gid if we have a passwd entry: done by finding the
1665 same name with terminating "user" changed to "group"; if not found,
1666 ignore. Also ignore if the value is already set. */
1668 if (pw == NULL) break;
1669 Ustrcpy(name+Ustrlen(name)-4, "group");
1670 ol2 = find_option(name, oltop, last);
1671 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1672 (ol2->type & opt_mask) == opt_expand_gid))
1674 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1677 if (data_block == NULL)
1678 *((gid_t *)(ol2->value)) = pw->pw_gid;
1680 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1686 /* If it was an expanded gid, see if there is any expansion to be
1687 done by checking for the presence of a $ character. If there is, save it
1688 in the corresponding *expand_user option field. Otherwise, fall through
1689 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1692 case opt_expand_gid:
1693 sprintf(CS name2, "*expand_%.50s", name);
1694 ol2 = find_option(name2, oltop, last);
1697 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1699 if (data_block == NULL)
1700 *((uschar **)(ol2->value)) = ss;
1702 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1706 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1712 /* Handle freestanding gid */
1715 if (!route_findgroup(sptr, &gid))
1716 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1717 if (data_block == NULL)
1718 *((gid_t *)(ol->value)) = gid;
1720 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1721 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1724 /* If it was a uid list, look up each individual entry, and build
1725 a vector of uids, with a count in the first element. Put the vector
1726 in malloc store so we can free the string. (We are reading into
1727 permanent store already.) */
1735 uschar *op = expand_string (sptr);
1738 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1739 name, expand_string_message);
1742 if (*p != 0) count++;
1743 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1744 list = store_malloc(count*sizeof(uid_t));
1745 list[ptr++] = (uid_t)(count - 1);
1747 if (data_block == NULL)
1748 *((uid_t **)(ol->value)) = list;
1750 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1756 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1757 if (!route_finduser(big_buffer, NULL, &uid))
1758 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1765 /* If it was a gid list, look up each individual entry, and build
1766 a vector of gids, with a count in the first element. Put the vector
1767 in malloc store so we can free the string. (We are reading into permanent
1776 uschar *op = expand_string (sptr);
1779 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1780 name, expand_string_message);
1783 if (*p != 0) count++;
1784 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1785 list = store_malloc(count*sizeof(gid_t));
1786 list[ptr++] = (gid_t)(count - 1);
1788 if (data_block == NULL)
1789 *((gid_t **)(ol->value)) = list;
1791 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1797 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1798 if (!route_findgroup(big_buffer, &gid))
1799 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1807 /* Release store if the value of the string doesn't need to be kept. */
1809 if (freesptr) store_reset(reset_point);
1812 /* Expanded boolean: if no characters follow, or if there are no dollar
1813 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1814 save the string for later expansion in the alternate place. */
1816 case opt_expand_bool:
1817 if (*s != 0 && Ustrchr(s, '$') != 0)
1819 sprintf(CS name2, "*expand_%.50s", name);
1820 ol2 = find_option(name2, oltop, last);
1823 reset_point = sptr = read_string(s, name);
1824 if (data_block == NULL)
1825 *((uschar **)(ol2->value)) = sptr;
1827 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1834 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1835 look for yes/not/true/false. Some booleans are stored in a single bit in
1836 a single int. There's a special fudge for verify settings; without a suffix
1837 they set both xx_sender and xx_recipient. The table points to the sender
1838 value; search subsequently for the recipient. There's another special case:
1839 opt_bool_set also notes when a boolean has been set. */
1843 case opt_bool_verify:
1847 s = readconf_readname(name2, 64, s);
1848 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1850 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1852 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1853 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1854 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1855 US"for boolean option ", name);
1858 /* Handle single-bit type. */
1860 if (type == opt_bit)
1862 int bit = 1 << ((ol->type >> 16) & 31);
1863 int *ptr = (data_block == NULL)?
1864 (int *)(ol->value) :
1865 (int *)((uschar *)data_block + (long int)ol->value);
1866 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1870 /* Handle full BOOL types */
1872 if (data_block == NULL)
1873 *((BOOL *)(ol->value)) = boolvalue;
1875 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1879 if (type == opt_bool_verify)
1881 sprintf(CS name2, "%.50s_recipient", name + offset);
1882 ol2 = find_option(name2, oltop, last);
1885 if (data_block == NULL)
1886 *((BOOL *)(ol2->value)) = boolvalue;
1888 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1892 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1894 else if (type == opt_bool_set)
1896 sprintf(CS name2, "*set_%.50s", name + offset);
1897 ol2 = find_option(name2, oltop, last);
1900 if (data_block == NULL)
1901 *((BOOL *)(ol2->value)) = TRUE;
1903 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1912 inttype = US"octal ";
1914 /* Integer: a simple(ish) case; allow octal and hex formats, and
1915 suffixes K and M. The different types affect output, not input. */
1924 lvalue = strtol(CS s, CSS &endptr, intbase);
1927 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1930 if (errno != ERANGE)
1932 if (tolower(*endptr) == 'k')
1934 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1935 else lvalue *= 1024;
1938 else if (tolower(*endptr) == 'm')
1940 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1942 else lvalue *= 1024*1024;
1947 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1948 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1949 "absolute value of integer \"%s\" is too large (overflow)", s);
1951 while (isspace(*endptr)) endptr++;
1953 extra_chars_error(endptr, inttype, US"integer value for ", name);
1955 value = (int)lvalue;
1958 if (data_block == NULL)
1959 *((int *)(ol->value)) = value;
1961 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1964 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1971 value = strtol(CS s, CSS &endptr, intbase);
1974 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1977 if (errno != ERANGE)
1979 if (tolower(*endptr) == 'm')
1981 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1985 else if (tolower(*endptr) == 'k')
1991 value = (value + 512)/1024;
1995 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1996 "absolute value of integer \"%s\" is too large (overflow)", s);
1998 while (isspace(*endptr)) endptr++;
2000 extra_chars_error(endptr, inttype, US"integer value for ", name);
2003 if (data_block == NULL)
2004 *((int *)(ol->value)) = value;
2006 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2009 /* Fixed-point number: held to 3 decimal places. */
2012 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2013 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2014 "fixed-point number expected for %s", name);
2016 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2017 "integer \"%s\" is too large (overflow)", s);
2021 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2022 "integer \"%s\" is too large (overflow)", s);
2024 if (s[count] == '.')
2027 while (isdigit(s[++count]))
2029 value += (s[count] - '0') * d;
2034 while (isspace(s[count])) count++;
2037 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2039 if (data_block == NULL)
2040 *((int *)(ol->value)) = value;
2042 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2045 /* There's a special routine to read time values. */
2048 value = readconf_readtime(s, 0, FALSE);
2050 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2052 if (data_block == NULL)
2053 *((int *)(ol->value)) = value;
2055 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2058 /* A time list is a list of colon-separated times, with the first
2059 element holding the size of the list and the second the number of
2065 int *list = (data_block == NULL)?
2066 (int *)(ol->value) :
2067 (int *)((uschar *)data_block + (long int)(ol->value));
2069 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2072 uschar *snext = Ustrchr(s, ':');
2076 while (ss > s && isspace(ss[-1])) ss--;
2079 value = readconf_readtime(s, terminator, FALSE);
2081 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2083 if (count > 1 && value <= list[count])
2084 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2085 "time value out of order for %s", name);
2086 list[count+1] = value;
2087 if (snext == NULL) break;
2089 while (isspace(*s)) s++;
2092 if (count > list[0] - 2)
2093 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2095 if (count > 0 && list[2] == 0) count = 0;
2107 /*************************************************
2108 * Print a time value *
2109 *************************************************/
2112 Argument: a time value in seconds
2113 Returns: pointer to a fixed buffer containing the time as a string,
2114 in readconf_readtime() format
2118 readconf_printtime(int t)
2121 uschar *p = time_buffer;
2138 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2139 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2140 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2141 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2142 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2149 /*************************************************
2150 * Print an individual option value *
2151 *************************************************/
2153 /* This is used by the -bP option, so prints to the standard output.
2154 The entire options list is passed in as an argument, because some options come
2155 in pairs - typically uid/gid settings, which can either be explicit numerical
2156 values, or strings to be expanded later. If the numerical value is unset,
2157 search for "*expand_<name>" to see if there is a string equivalent.
2160 ol option entry, or NULL for an unknown option
2162 options_block NULL for main configuration options; otherwise points to
2163 a driver block; if the option doesn't have opt_public
2164 set, then options_block->options_block is where the item
2166 oltop points to the option list in which ol exists
2167 last one more than the offset of the last entry in optop
2168 no_labels do not show "foo = " at the start.
2174 print_ol(optionlist *ol, uschar *name, void *options_block,
2175 optionlist *oltop, int last, BOOL no_labels)
2188 printf("%s is not a known option\n", name);
2192 /* Non-admin callers cannot see options that have been flagged secure by the
2195 if (!admin_user && (ol->type & opt_secure) != 0)
2197 const char * const hidden = "<value not displayable>";
2199 printf("%s\n", hidden);
2201 printf("%s = %s\n", name, hidden);
2205 /* Else show the value of the option */
2208 if (options_block != NULL)
2210 if ((ol->type & opt_public) == 0)
2211 options_block = (void *)(((driver_instance *)options_block)->options_block);
2212 value = (void *)((uschar *)options_block + (long int)value);
2215 switch(ol->type & opt_mask)
2218 case opt_rewrite: /* Show the text value */
2219 s = *((uschar **)value);
2220 if (!no_labels) printf("%s = ", name);
2221 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2225 if (!no_labels) printf("%s = ", name);
2226 printf("%d\n", *((int *)value));
2231 int x = *((int *)value);
2232 if (x != 0 && (x & 1023) == 0)
2236 if ((x & 1023) == 0)
2241 if (!no_labels) printf("%s = ", name);
2242 printf("%d%c\n", x, c);
2246 if (!no_labels) printf("%s = ", name);
2254 int x = *((int *)value);
2255 if (!no_labels) printf("%s = ", name);
2256 if (x == 0) printf("0\n");
2257 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2258 else printf("%dK\n", x);
2263 if (!no_labels) printf("%s = ", name);
2264 printf("%#o\n", *((int *)value));
2267 /* Can be negative only when "unset", in which case integer */
2271 int x = *((int *)value);
2274 if (x < 0) printf("%s =\n", name); else
2276 if (!no_labels) printf("%s = ", name);
2277 printf("%d.", x/1000);
2290 /* If the numerical value is unset, try for the string value */
2292 case opt_expand_uid:
2293 if (! *get_set_flag(name, oltop, last, options_block))
2295 sprintf(CS name2, "*expand_%.50s", name);
2296 ol2 = find_option(name2, oltop, last);
2299 void *value2 = ol2->value;
2300 if (options_block != NULL)
2301 value2 = (void *)((uschar *)options_block + (long int)value2);
2302 s = *((uschar **)value2);
2303 if (!no_labels) printf("%s = ", name);
2304 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2309 /* Else fall through */
2312 if (!no_labels) printf("%s = ", name);
2313 if (! *get_set_flag(name, oltop, last, options_block))
2317 pw = getpwuid(*((uid_t *)value));
2319 printf("%ld\n", (long int)(*((uid_t *)value)));
2320 else printf("%s\n", pw->pw_name);
2324 /* If the numerical value is unset, try for the string value */
2326 case opt_expand_gid:
2327 if (! *get_set_flag(name, oltop, last, options_block))
2329 sprintf(CS name2, "*expand_%.50s", name);
2330 ol2 = find_option(name2, oltop, last);
2331 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2333 void *value2 = ol2->value;
2334 if (options_block != NULL)
2335 value2 = (void *)((uschar *)options_block + (long int)value2);
2336 s = *((uschar **)value2);
2337 if (!no_labels) printf("%s = ", name);
2338 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2343 /* Else fall through */
2346 if (!no_labels) printf("%s = ", name);
2347 if (! *get_set_flag(name, oltop, last, options_block))
2351 gr = getgrgid(*((int *)value));
2353 printf("%ld\n", (long int)(*((int *)value)));
2354 else printf("%s\n", gr->gr_name);
2359 uidlist = *((uid_t **)value);
2360 if (!no_labels) printf("%s =", name);
2361 if (uidlist != NULL)
2365 if (no_labels) sep = '\0';
2366 for (i = 1; i <= (int)(uidlist[0]); i++)
2368 uschar *name = NULL;
2369 pw = getpwuid(uidlist[i]);
2370 if (pw != NULL) name = US pw->pw_name;
2371 if (sep != '\0') printf("%c", sep);
2372 if (name != NULL) printf("%s", name);
2373 else printf("%ld", (long int)(uidlist[i]));
2381 gidlist = *((gid_t **)value);
2382 if (!no_labels) printf("%s =", name);
2383 if (gidlist != NULL)
2387 if (no_labels) sep = '\0';
2388 for (i = 1; i <= (int)(gidlist[0]); i++)
2390 uschar *name = NULL;
2391 gr = getgrgid(gidlist[i]);
2392 if (gr != NULL) name = US gr->gr_name;
2393 if (sep != '\0') printf("%c", sep);
2394 if (name != NULL) printf("%s", name);
2395 else printf("%ld", (long int)(gidlist[i]));
2403 if (!no_labels) printf("%s = ", name);
2404 printf("%s\n", readconf_printtime(*((int *)value)));
2410 int *list = (int *)value;
2411 if (!no_labels) printf("%s = ", name);
2412 for (i = 0; i < list[1]; i++)
2413 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2419 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2423 case opt_expand_bool:
2424 sprintf(CS name2, "*expand_%.50s", name);
2425 ol2 = find_option(name2, oltop, last);
2426 if (ol2 != NULL && ol2->value != NULL)
2428 void *value2 = ol2->value;
2429 if (options_block != NULL)
2430 value2 = (void *)((uschar *)options_block + (long int)value2);
2431 s = *((uschar **)value2);
2434 if (!no_labels) printf("%s = ", name);
2435 printf("%s\n", string_printing(s));
2438 /* s == NULL => string not set; fall through */
2444 case opt_bool_verify:
2446 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2453 /*************************************************
2454 * Print value from main configuration *
2455 *************************************************/
2457 /* This function, called as a result of encountering the -bP option,
2458 causes the value of any main configuration variable to be output if the
2459 second argument is NULL. There are some special values:
2461 all print all main configuration options
2462 configure_file print the name of the configuration file
2463 routers print the routers' configurations
2464 transports print the transports' configuration
2465 authenticators print the authenticators' configuration
2466 macros print the macros' configuration
2467 router_list print a list of router names
2468 transport_list print a list of transport names
2469 authenticator_list print a list of authentication mechanism names
2470 macro_list print a list of macro names
2471 +name print a named list item
2472 local_scan print the local_scan options
2474 If the second argument is not NULL, it must be one of "router", "transport",
2475 "authenticator" or "macro" in which case the first argument identifies the
2476 driver whose options are to be printed.
2479 name option name if type == NULL; else driver name
2480 type NULL or driver type name, as described above
2481 no_labels avoid the "foo = " at the start of an item
2487 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2489 BOOL names_only = FALSE;
2491 optionlist *ol2 = NULL;
2492 driver_instance *d = NULL;
2503 static uschar *types[] = { US"address", US"domain", US"host",
2505 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2506 &hostlist_anchor, &localpartlist_anchor };
2508 for (i = 0; i < 4; i++)
2510 t = tree_search(*(anchors[i]), name+1);
2515 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2517 printf("%slist %s = %s\n", types[i], name+1,
2518 ((namedlist_block *)(t->data.ptr))->string);
2523 printf("no address, domain, host, or local part list called \"%s\" "
2524 "exists\n", name+1);
2529 if (Ustrcmp(name, "configure_file") == 0)
2531 printf("%s\n", CS config_main_filename);
2535 if (Ustrcmp(name, "all") == 0)
2537 for (ol = optionlist_config;
2538 ol < optionlist_config + optionlist_config_size; ol++)
2540 if ((ol->type & opt_hidden) == 0)
2541 print_ol(ol, US ol->name, NULL,
2542 optionlist_config, optionlist_config_size,
2548 if (Ustrcmp(name, "local_scan") == 0)
2550 #ifndef LOCAL_SCAN_HAS_OPTIONS
2551 printf("local_scan() options are not supported\n");
2553 for (ol = local_scan_options;
2554 ol < local_scan_options + local_scan_options_count; ol++)
2556 print_ol(ol, US ol->name, NULL, local_scan_options,
2557 local_scan_options_count, no_labels);
2563 if (Ustrcmp(name, "routers") == 0)
2568 else if (Ustrcmp(name, "transports") == 0)
2570 type = US"transport";
2574 else if (Ustrcmp(name, "authenticators") == 0)
2576 type = US"authenticator";
2580 else if (Ustrcmp(name, "macros") == 0)
2586 else if (Ustrcmp(name, "router_list") == 0)
2593 else if (Ustrcmp(name, "transport_list") == 0)
2595 type = US"transport";
2600 else if (Ustrcmp(name, "authenticator_list") == 0)
2602 type = US"authenticator";
2607 else if (Ustrcmp(name, "macro_list") == 0)
2616 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2617 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2622 /* Handle the options for a router or transport. Skip options that are flagged
2623 as hidden. Some of these are options with names starting with '*', used for
2624 internal alternative representations of other options (which the printing
2625 function will sort out). Others are synonyms kept for backward compatibility.
2628 if (Ustrcmp(type, "router") == 0)
2630 d = (driver_instance *)routers;
2631 ol2 = optionlist_routers;
2632 size = optionlist_routers_size;
2634 else if (Ustrcmp(type, "transport") == 0)
2636 d = (driver_instance *)transports;
2637 ol2 = optionlist_transports;
2638 size = optionlist_transports_size;
2640 else if (Ustrcmp(type, "authenticator") == 0)
2642 d = (driver_instance *)auths;
2643 ol2 = optionlist_auths;
2644 size = optionlist_auths_size;
2647 else if (Ustrcmp(type, "macro") == 0)
2649 /* People store passwords in macros and they were previously not available
2650 for printing. So we have an admin_users restriction. */
2653 fprintf(stderr, "exim: permission denied\n");
2656 for (m = macros; m != NULL; m = m->next)
2658 if (name == NULL || Ustrcmp(name, m->name) == 0)
2661 printf("%s\n", CS m->name);
2663 printf("%s=%s\n", CS m->name, CS m->replacement);
2669 printf("%s %s not found\n", type, name);
2675 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2679 /* Either search for a given driver, or print all of them */
2681 for (; d != NULL; d = d->next)
2684 printf("\n%s %s:\n", d->name, type);
2685 else if (Ustrcmp(d->name, name) != 0) continue;
2687 for (ol = ol2; ol < ol2 + size; ol++)
2689 if ((ol->type & opt_hidden) == 0)
2690 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2693 for (ol = d->info->options;
2694 ol < d->info->options + *(d->info->options_count); ol++)
2696 if ((ol->type & opt_hidden) == 0)
2697 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2699 if (name != NULL) return;
2701 if (name != NULL) printf("%s %s not found\n", type, name);
2706 /*************************************************
2707 * Read a named list item *
2708 *************************************************/
2710 /* This function reads a name and a list (i.e. string). The name is used to
2711 save the list in a tree, sorted by its name. Each entry also has a number,
2712 which can be used for caching tests, but if the string contains any expansion
2713 items other than $key, the number is set negative to inhibit caching. This
2714 mechanism is used for domain, host, and address lists that are referenced by
2718 anchorp points to the tree anchor
2719 numberp points to the current number for this tree
2720 max the maximum number permitted
2721 s the text of the option line, starting immediately after the name
2723 tname the name of the list type, for messages
2729 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2732 BOOL forcecache = FALSE;
2735 namedlist_block *nb = store_get(sizeof(namedlist_block));
2737 if (Ustrncmp(s, "_cache", 6) == 0)
2744 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2746 if (*numberp >= max)
2747 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2750 while (isspace(*s)) s++;
2752 while (isalnum(*s) || *s == '_') s++;
2753 t = store_get(sizeof(tree_node) + s-ss);
2754 Ustrncpy(t->name, ss, s-ss);
2756 while (isspace(*s)) s++;
2758 if (!tree_insertnode(anchorp, t))
2759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2760 "duplicate name \"%s\" for a named %s", t->name, tname);
2763 nb->number = *numberp;
2766 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2767 "missing '=' after \"%s\"", t->name);
2768 while (isspace(*s)) s++;
2769 nb->string = read_string(s, t->name);
2770 nb->cache_data = NULL;
2772 /* Check the string for any expansions; if any are found, mark this list
2773 uncacheable unless the user has explicited forced caching. */
2775 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2781 /*************************************************
2782 * Unpick data for a rate limit *
2783 *************************************************/
2785 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2789 s string, in the form t,b,f,l
2790 where t is the threshold (integer)
2791 b is the initial delay (time)
2792 f is the multiplicative factor (fixed point)
2793 k is the maximum time (time)
2794 threshold where to store threshold
2795 base where to store base in milliseconds
2796 factor where to store factor in milliseconds
2797 limit where to store limit
2799 Returns: nothing (panics on error)
2803 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2806 uschar bstring[16], lstring[16];
2808 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2809 factor, lstring) == 4)
2811 *base = readconf_readtime(bstring, 0, TRUE);
2812 *limit = readconf_readtime(lstring, 0, TRUE);
2813 if (*base >= 0 && *limit >= 0) return;
2815 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2821 /*************************************************
2822 * Drop privs for checking TLS config *
2823 *************************************************/
2825 /* We want to validate TLS options during readconf, but do not want to be
2826 root when we call into the TLS library, in case of library linkage errors
2827 which cause segfaults; before this check, those were always done as the Exim
2828 runtime user and it makes sense to continue with that.
2830 Assumes: tls_require_ciphers has been set, if it will be
2831 exim_user has been set, if it will be
2832 exim_group has been set, if it will be
2834 Returns: bool for "okay"; false will cause caller to immediately exit.
2839 tls_dropprivs_validate_require_cipher(void)
2841 const uschar *errmsg;
2844 void (*oldsignal)(int);
2846 oldsignal = signal(SIGCHLD, SIG_DFL);
2849 if ((pid = fork()) < 0)
2850 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2854 /* in some modes, will have dropped privilege already */
2856 exim_setugid(exim_uid, exim_gid, FALSE,
2857 US"calling tls_validate_require_cipher");
2859 errmsg = tls_validate_require_cipher();
2862 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2863 "tls_require_ciphers invalid: %s", errmsg);
2870 rc = waitpid(pid, &status, 0);
2871 } while (rc < 0 && errno == EINTR);
2874 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2877 signal(SIGCHLD, oldsignal);
2881 #endif /* SUPPORT_TLS */
2886 /*************************************************
2887 * Read main configuration options *
2888 *************************************************/
2890 /* This function is the first to be called for configuration reading. It
2891 opens the configuration file and reads general configuration settings until
2892 it reaches the end of the configuration section. The file is then left open so
2893 that the remaining configuration data can subsequently be read if needed for
2896 The configuration file must be owned either by root or exim, and be writeable
2897 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2898 in the config file, so the test is done on the compiled in values. A slight
2899 anomaly, to be carefully documented.
2901 The name of the configuration file is taken from a list that is included in the
2902 binary of Exim. It can be altered from the command line, but if that is done,
2903 root privilege is immediately withdrawn unless the caller is root or exim.
2904 The first file on the list that exists is used.
2906 For use on multiple systems that share file systems, first look for a
2907 configuration file whose name has the current node name on the end. If that is
2908 not found, try the generic name. For really contorted configurations, that run
2909 multiple Exims with different uid settings, first try adding the effective uid
2910 before the node name. These complications are going to waste resources on most
2911 systems. Therefore they are available only when requested by compile-time
2918 struct stat statbuf;
2919 uschar *s, *filename;
2920 uschar *list = config_main_filelist;
2922 /* Loop through the possible file names */
2924 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2927 /* Cut out all the fancy processing unless specifically wanted */
2929 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2930 uschar *suffix = filename + Ustrlen(filename);
2932 /* Try for the node-specific file if a node name exists */
2934 #ifdef CONFIGURE_FILE_USE_NODE
2936 if (uname(&uts) >= 0)
2938 #ifdef CONFIGURE_FILE_USE_EUID
2939 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2940 config_file = Ufopen(filename, "rb");
2941 if (config_file == NULL)
2942 #endif /* CONFIGURE_FILE_USE_EUID */
2944 sprintf(CS suffix, ".%.256s", uts.nodename);
2945 config_file = Ufopen(filename, "rb");
2948 #endif /* CONFIGURE_FILE_USE_NODE */
2950 /* Otherwise, try the generic name, possibly with the euid added */
2952 #ifdef CONFIGURE_FILE_USE_EUID
2953 if (config_file == NULL)
2955 sprintf(CS suffix, ".%ld", (long int)original_euid);
2956 config_file = Ufopen(filename, "rb");
2958 #endif /* CONFIGURE_FILE_USE_EUID */
2960 /* Finally, try the unadorned name */
2962 if (config_file == NULL)
2965 config_file = Ufopen(filename, "rb");
2967 #else /* if neither defined */
2969 /* This is the common case when the fancy processing is not included. */
2971 config_file = Ufopen(filename, "rb");
2974 /* If the file does not exist, continue to try any others. For any other
2975 error, break out (and die). */
2977 if (config_file != NULL || errno != ENOENT) break;
2980 /* On success, save the name for verification; config_filename is used when
2981 logging configuration errors (it changes for .included files) whereas
2982 config_main_filename is the name shown by -bP. Failure to open a configuration
2983 file is a serious disaster. */
2985 if (config_file != NULL)
2987 config_filename = config_main_filename = string_copy(filename);
2991 if (filename == NULL)
2992 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2993 "%s", config_main_filelist);
2995 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2996 "configuration file %s", filename));
2999 /* Check the status of the file we have opened, if we have retained root
3000 privileges and the file isn't /dev/null (which *should* be 0666). */
3002 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
3004 if (fstat(fileno(config_file), &statbuf) != 0)
3005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
3008 if ((statbuf.st_uid != root_uid /* owner not root */
3009 #ifdef CONFIGURE_OWNER
3010 && statbuf.st_uid != config_uid /* owner not the special one */
3013 (statbuf.st_gid != root_gid /* group not root & */
3014 #ifdef CONFIGURE_GROUP
3015 && statbuf.st_gid != config_gid /* group not the special one */
3017 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3019 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3021 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3022 "wrong owner, group, or mode", big_buffer);
3025 /* Process the main configuration settings. They all begin with a lower case
3026 letter. If we see something starting with an upper case letter, it is taken as
3027 a macro definition. */
3029 while ((s = get_config_line()) != NULL)
3031 if (isupper(s[0])) read_macro_assignment(s);
3033 else if (Ustrncmp(s, "domainlist", 10) == 0)
3034 read_named_list(&domainlist_anchor, &domainlist_count,
3035 MAX_NAMED_LIST, s+10, US"domain list");
3037 else if (Ustrncmp(s, "hostlist", 8) == 0)
3038 read_named_list(&hostlist_anchor, &hostlist_count,
3039 MAX_NAMED_LIST, s+8, US"host list");
3041 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3042 read_named_list(&addresslist_anchor, &addresslist_count,
3043 MAX_NAMED_LIST, s+11, US"address list");
3045 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3046 read_named_list(&localpartlist_anchor, &localpartlist_count,
3047 MAX_NAMED_LIST, s+13, US"local part list");
3050 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3051 NULL, US"main option \"%s\" unknown");
3055 /* If local_sender_retain is set, local_from_check must be unset. */
3057 if (local_sender_retain && local_from_check)
3058 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3059 "local_sender_retain are set; this combination is not allowed");
3061 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3064 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3066 /* The max retry interval must not be greater than 24 hours. */
3068 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3070 /* remote_max_parallel must be > 0 */
3072 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3074 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3075 start of a new SMTP message. */
3077 freeze_tell_config = freeze_tell;
3079 /* The primary host name may be required for expansion of spool_directory
3080 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3081 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3082 canonize it. Some people like upper case letters in their host names, so we
3083 don't force the case. */
3085 if (primary_hostname == NULL)
3089 if (uname(&uts) < 0)
3090 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3091 hostname = US uts.nodename;
3093 if (Ustrchr(hostname, '.') == NULL)
3096 struct hostent *hostdata;
3099 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3100 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3110 #if HAVE_GETIPNODEBYNAME
3112 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3114 hostdata = gethostbyname2(CS hostname, af);
3117 hostdata = gethostbyname(CS hostname);
3120 if (hostdata != NULL)
3122 hostname = US hostdata->h_name;
3126 if (af == AF_INET) break;
3131 primary_hostname = string_copy(hostname);
3134 /* Set up default value for smtp_active_hostname */
3136 smtp_active_hostname = primary_hostname;
3138 /* If spool_directory wasn't set in the build-time configuration, it must have
3139 got set above. Of course, writing to the log may not work if log_file_path is
3140 not set, but it will at least get to syslog or somewhere, with any luck. */
3142 if (*spool_directory == 0)
3143 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3146 /* Expand the spool directory name; it may, for example, contain the primary
3147 host name. Same comment about failure. */
3149 s = expand_string(spool_directory);
3151 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3152 "\"%s\": %s", spool_directory, expand_string_message);
3153 spool_directory = s;
3155 /* Expand log_file_path, which must contain "%s" in any component that isn't
3156 the null string or "syslog". It is also allowed to contain one instance of %D
3157 or %M. However, it must NOT contain % followed by anything else. */
3159 if (*log_file_path != 0)
3162 int sep = ':'; /* Fixed for log file path */
3163 s = expand_string(log_file_path);
3165 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3166 "\"%s\": %s", log_file_path, expand_string_message);
3169 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3172 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3173 t = Ustrstr(sss, "%s");
3175 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3176 "contain \"%%s\"", sss);
3178 t = Ustrchr(sss, '%');
3181 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3182 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3183 "unexpected \"%%\" character", s);
3190 /* Interpret syslog_facility into an integer argument for 'ident' param to
3191 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3194 if (syslog_facility_str != NULL)
3197 uschar *s = syslog_facility_str;
3199 if ((Ustrlen(syslog_facility_str) >= 4) &&
3200 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3203 for (i = 0; i < syslog_list_size; i++)
3205 if (strcmpic(s, syslog_list[i].name) == 0)
3207 syslog_facility = syslog_list[i].value;
3212 if (i >= syslog_list_size)
3214 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3215 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3219 /* Expand pid_file_path */
3221 if (*pid_file_path != 0)
3223 s = expand_string(pid_file_path);
3225 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3226 "\"%s\": %s", pid_file_path, expand_string_message);
3230 /* Set default value of process_log_path */
3232 if (process_log_path == NULL || *process_log_path =='\0')
3233 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3235 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3238 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3240 /* Unpick the SMTP rate limiting options, if set */
3242 if (smtp_ratelimit_mail != NULL)
3244 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3245 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3248 if (smtp_ratelimit_rcpt != NULL)
3250 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3251 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3254 /* The qualify domains default to the primary host name */
3256 if (qualify_domain_sender == NULL)
3257 qualify_domain_sender = primary_hostname;
3258 if (qualify_domain_recipient == NULL)
3259 qualify_domain_recipient = qualify_domain_sender;
3261 /* Setting system_filter_user in the configuration sets the gid as well if a
3262 name is given, but a numerical value does not. */
3264 if (system_filter_uid_set && !system_filter_gid_set)
3266 struct passwd *pw = getpwuid(system_filter_uid);
3268 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3269 (long int)system_filter_uid);
3270 system_filter_gid = pw->pw_gid;
3271 system_filter_gid_set = TRUE;
3274 /* If the errors_reply_to field is set, check that it is syntactically valid
3275 and ensure it contains a domain. */
3277 if (errors_reply_to != NULL)
3280 int start, end, domain;
3281 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3282 &start, &end, &domain, FALSE);
3284 if (recipient == NULL)
3285 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3286 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3289 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3290 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3293 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3294 smtp_accept_max must also be set. */
3296 if (smtp_accept_max == 0 &&
3297 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3298 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3299 "smtp_accept_max must be set if smtp_accept_queue or "
3300 "smtp_accept_max_per_host is set");
3302 /* Set up the host number if anything is specified. It is an expanded string
3303 so that it can be computed from the host name, for example. We do this last
3304 so as to ensure that everything else is set up before the expansion. */
3306 if (host_number_string != NULL)
3310 uschar *s = expand_string(host_number_string);
3312 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3313 "failed to expand localhost_number \"%s\": %s",
3314 host_number_string, expand_string_message);
3315 n = Ustrtol(s, &end, 0);
3316 while (isspace(*end)) end++;
3318 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3319 "localhost_number value is not a number: %s", s);
3320 if (n > LOCALHOST_MAX)
3321 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3322 "localhost_number is greater than the maximum allowed value (%d)",
3328 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3330 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3331 tls_verify_certificates == NULL)
3332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3333 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3334 (tls_verify_hosts != NULL)? "" : "try_");
3336 /* This also checks that the library linkage is working and we can call
3337 routines in it, so call even if tls_require_ciphers is unset */
3338 if (!tls_dropprivs_validate_require_cipher())
3341 /* Magic number: at time of writing, 1024 has been the long-standing value
3342 used by so many clients, and what Exim used to use always, that it makes
3343 sense to just min-clamp this max-clamp at that. */
3344 if (tls_dh_max_bits < 1024)
3345 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3346 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3348 /* If openssl_options is set, validate it */
3349 if (openssl_options != NULL)
3352 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3353 "openssl_options is set but we're using GnuTLS");
3356 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3357 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3358 "openssl_options parse error: %s", openssl_options);
3366 /*************************************************
3367 * Initialize one driver *
3368 *************************************************/
3370 /* This is called once the driver's generic options, if any, have been read.
3371 We can now find the driver, set up defaults for the private options, and
3372 unset any "set" bits in the private options table (which might have been
3373 set by another incarnation of the same driver).
3376 d pointer to driver instance block, with generic
3378 drivers_available vector of available drivers
3379 size_of_info size of each block in drivers_available
3380 class class of driver, for error message
3382 Returns: pointer to the driver info block
3385 static driver_info *
3386 init_driver(driver_instance *d, driver_info *drivers_available,
3387 int size_of_info, uschar *class)
3391 for (dd = drivers_available; dd->driver_name[0] != 0;
3392 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3394 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3397 int len = dd->options_len;
3399 d->options_block = store_get(len);
3400 memcpy(d->options_block, dd->options_block, len);
3401 for (i = 0; i < *(dd->options_count); i++)
3402 dd->options[i].type &= ~opt_set;
3407 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3408 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3410 return NULL; /* never obeyed */
3416 /*************************************************
3417 * Initialize driver list *
3418 *************************************************/
3420 /* This function is called for routers, transports, and authentication
3421 mechanisms. It reads the data from the current point in the configuration file
3422 up to the end of the section, and sets up a chain of instance blocks according
3423 to the file's contents. The file will already have been opened by a call to
3424 readconf_main, and must be left open for subsequent reading of further data.
3426 Any errors cause a panic crash. Note that the blocks with names driver_info and
3427 driver_instance must map the first portions of all the _info and _instance
3428 blocks for this shared code to work.
3431 class "router", "transport", or "authenticator"
3432 anchor &routers, &transports, &auths
3433 drivers_available available drivers
3434 size_of_info size of each info block
3435 instance_default points to default data for an instance
3436 instance_size size of instance block
3437 driver_optionlist generic option list
3438 driver_optionlist_count count of generic option list
3444 readconf_driver_init(
3446 driver_instance **anchor,
3447 driver_info *drivers_available,
3449 void *instance_default,
3451 optionlist *driver_optionlist,
3452 int driver_optionlist_count)
3454 driver_instance **p = anchor;
3455 driver_instance *d = NULL;
3458 while ((buffer = get_config_line()) != NULL)
3463 /* Read the first name on the line and test for the start of a new driver. A
3464 macro definition indicates the end of the previous driver. If this isn't the
3465 start of a new driver, the line will be re-read. */
3467 s = readconf_readname(name, sizeof(name), buffer);
3469 /* Handle macro definition, first finishing off the initialization of the
3470 previous driver, if any. */
3472 if (isupper(*name) && *s == '=')
3476 if (d->driver_name == NULL)
3477 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3478 "no driver defined for %s \"%s\"", class, d->name);
3482 read_macro_assignment(buffer);
3486 /* If the line starts with a name terminated by a colon, we are at the
3487 start of the definition of a new driver. The rest of the line must be
3494 /* Finish off initializing the previous driver. */
3498 if (d->driver_name == NULL)
3499 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3500 "no driver defined for %s \"%s\"", class, d->name);
3504 /* Check that we haven't already got a driver of this name */
3506 for (d = *anchor; d != NULL; d = d->next)
3507 if (Ustrcmp(name, d->name) == 0)
3508 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3509 "there are two %ss called \"%s\"", class, name);
3511 /* Set up a new driver instance data block on the chain, with
3512 its default values installed. */
3514 d = store_get(instance_size);
3515 memcpy(d, instance_default, instance_size);
3518 d->name = string_copy(name);
3520 /* Clear out the "set" bits in the generic options */
3522 for (i = 0; i < driver_optionlist_count; i++)
3523 driver_optionlist[i].type &= ~opt_set;
3525 /* Check nothing more on this line, then do the next loop iteration. */
3527 while (isspace(*s)) s++;
3528 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3532 /* Not the start of a new driver. Give an error if we have not set up a
3533 current driver yet. */
3535 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3536 "%s name missing", class);
3538 /* First look to see if this is a generic option; if it is "driver",
3539 initialize the driver. If is it not a generic option, we can look for a
3540 private option provided that the driver has been previously set up. */
3542 if (readconf_handle_option(buffer, driver_optionlist,
3543 driver_optionlist_count, d, NULL))
3545 if (d->info == NULL && d->driver_name != NULL)
3546 init_driver(d, drivers_available, size_of_info, class);
3549 /* Handle private options - pass the generic block because some may
3550 live therein. A flag with each option indicates if it is in the public
3553 else if (d->info != NULL)
3555 readconf_handle_option(buffer, d->info->options,
3556 *(d->info->options_count), d, US"option \"%s\" unknown");
3559 /* The option is not generic and the driver name has not yet been given. */
3561 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3562 "(\"driver\" must be specified before any private options)", name);
3565 /* Run the initialization function for the final driver. */
3569 if (d->driver_name == NULL)
3570 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3571 "no driver defined for %s \"%s\"", class, d->name);
3578 /*************************************************
3579 * Check driver dependency *
3580 *************************************************/
3582 /* This function is passed a driver instance and a string. It checks whether
3583 any of the string options for the driver contains the given string as an
3587 d points to a driver instance block
3588 s the string to search for
3590 Returns: TRUE if a dependency is found
3594 readconf_depends(driver_instance *d, uschar *s)
3596 int count = *(d->info->options_count);
3600 for (ol = d->info->options; ol < d->info->options + count; ol++)
3602 void *options_block;
3604 int type = ol->type & opt_mask;
3605 if (type != opt_stringptr) continue;
3606 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3607 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3608 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3610 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3611 isalnum(ss[Ustrlen(s)])) continue;
3612 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3613 d->name, ol->name, s);
3618 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3625 /*************************************************
3626 * Decode an error type for retries *
3627 *************************************************/
3629 /* This function is global because it is also called from the main
3630 program when testing retry information. It decodes strings such as "quota_7d"
3631 into numerical error codes.
3634 pp points to start of text
3635 p points past end of text
3636 basic_errno points to an int to receive the main error number
3637 more_errno points to an int to receive the secondary error data
3639 Returns: NULL if decoded correctly; else points to error text
3643 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3647 while (q < p && *q != '_') q++;
3650 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3652 *basic_errno = ERRNO_EXIMQUOTA;
3653 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3654 return US"bad time value";
3657 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3659 *basic_errno = ECONNREFUSED;
3662 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3663 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3664 else return US"A or MX expected after \"refused\"";
3668 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3670 *basic_errno = ETIMEDOUT;
3674 int xlen = p - q - 1;
3677 static uschar *extras[] =
3678 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3679 static int values[] =
3680 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3682 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3684 if (strncmpic(x, extras[i], xlen) == 0)
3686 *more_errno = values[i];
3691 if (i >= sizeof(extras)/sizeof(uschar *))
3693 if (strncmpic(x, US"DNS", xlen) == 0)
3695 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3696 "available in retry rules (it has never worked) - treated as "
3699 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3704 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3705 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3706 strncmpic(pp, US"data_4", 6) == 0)
3709 int x = 255; /* means "any 4xx code" */
3710 if (p != pp + 8) bad = TRUE; else
3712 int a = pp[6], b = pp[7];
3716 if (isdigit(b)) x += b - '0';
3717 else if (b == 'x') x += 100;
3720 else if (a != 'x' || b != 'x') bad = TRUE;
3724 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3725 "x is literal and d is any digit", pp);
3727 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3728 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3729 *more_errno = x << 8;
3732 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3733 strncmpic(q+1, US"failed", p-q-1) == 0)
3734 *basic_errno = ERRNO_AUTHFAIL;
3736 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3737 *basic_errno = ERRNO_SMTPCLOSED;
3739 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3740 *basic_errno = ERRNO_TLSREQUIRED;
3742 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3743 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3751 /*************************************************
3752 * Read retry information *
3753 *************************************************/
3755 /* Each line of retry information contains:
3757 . A domain name pattern or an address pattern;
3759 . An error name, possibly with additional data, or *;
3761 . An optional sequence of retry items, each consisting of an identifying
3762 letter, a cutoff time, and optional parameters.
3764 All this is decoded and placed into a control block. */
3767 /* Subroutine to read an argument, preceded by a comma and terminated
3768 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3769 1 = fixed point number (returned *1000).
3772 paddr pointer to pointer to current character; updated
3773 type 0 => read a time; 1 => read a fixed point number
3775 Returns: time in seconds or fixed point number * 1000
3779 retry_arg(uschar **paddr, int type)
3784 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3786 while (isspace(*p)) p++;
3788 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3790 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3791 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3797 return readconf_readtime(pp, *p, FALSE);
3799 return readconf_readfixed(pp, *p);
3801 return 0; /* Keep picky compilers happy */
3804 /* The function proper */
3807 readconf_retries(void)
3809 retry_config **chain = &retries;
3813 while ((p = get_config_line()) != NULL)
3815 retry_rule **rchain;
3818 next = store_get(sizeof(retry_config));
3821 chain = &(next->next);
3822 next->basic_errno = next->more_errno = 0;
3823 next->senders = NULL;
3825 rchain = &(next->rules);
3827 next->pattern = string_dequote(&p);
3828 while (isspace(*p)) p++;
3830 while (mac_isgraph(*p)) p++;
3831 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3832 "missing error type");
3834 /* Test error names for things we understand. */
3836 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3837 &(next->more_errno))) != NULL)
3838 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3840 /* There may be an optional address list of senders to be used as another
3841 constraint on the rule. This was added later, so the syntax is a bit of a
3842 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3845 while (isspace(*p)) p++;
3846 if (Ustrncmp(p, "senders", 7) == 0)
3849 while (isspace(*p)) p++;
3850 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3851 "\"=\" expected after \"senders\" in retry rule");
3852 while (isspace(*p)) p++;
3853 next->senders = string_dequote(&p);
3856 /* Now the retry rules. Keep the maximum timeout encountered. */
3858 while (isspace(*p)) p++;
3862 retry_rule *rule = store_get(sizeof(retry_rule));
3864 rchain = &(rule->next);
3866 rule->rule = toupper(*p++);
3867 rule->timeout = retry_arg(&p, 0);
3868 if (rule->timeout > retry_maximum_timeout)
3869 retry_maximum_timeout = rule->timeout;
3873 case 'F': /* Fixed interval */
3874 rule->p1 = retry_arg(&p, 0);
3877 case 'G': /* Geometrically increasing intervals */
3878 case 'H': /* Ditto, but with randomness */
3879 rule->p1 = retry_arg(&p, 0);
3880 rule->p2 = retry_arg(&p, 1);
3884 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3888 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3889 (rule->rule != 'F' && rule->p2 < 1000))
3890 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3891 "bad parameters for retry rule");
3893 while (isspace(*p)) p++;
3897 while (isspace(*p)) p++;
3900 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3907 /*************************************************
3908 * Initialize authenticators *
3909 *************************************************/
3911 /* Read the authenticators section of the configuration file.
3920 auth_instance *au, *bu;
3921 readconf_driver_init(US"authenticator",
3922 (driver_instance **)(&auths), /* chain anchor */
3923 (driver_info *)auths_available, /* available drivers */
3924 sizeof(auth_info), /* size of info block */
3925 &auth_defaults, /* default values for generic options */
3926 sizeof(auth_instance), /* size of instance block */
3927 optionlist_auths, /* generic options */
3928 optionlist_auths_size);
3930 for (au = auths; au != NULL; au = au->next)
3932 if (au->public_name == NULL)
3933 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3934 "the %s authenticator", au->name);
3935 for (bu = au->next; bu != NULL; bu = bu->next)
3937 if (strcmpic(au->public_name, bu->public_name) == 0)
3939 if ((au->client && bu->client) || (au->server && bu->server))
3940 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3941 "(%s and %s) have the same public name (%s)",
3942 (au->client)? US"client" : US"server", au->name, bu->name,
3952 /*************************************************
3953 * Read ACL information *
3954 *************************************************/
3956 /* If this run of Exim is not doing something that involves receiving a
3957 message, we can just skip over the ACL information. No need to parse it.
3959 First, we have a function for acl_read() to call back to get the next line. We
3960 need to remember the line we passed, because at the end it will contain the
3961 name of the next ACL. */
3963 static uschar *acl_line;
3968 acl_line = get_config_line();
3973 /* Now the main function:
3976 skip TRUE when this Exim process is doing something that will
3977 not need the ACL data
3983 readconf_acl(BOOL skip)
3987 /* Not receiving messages, don't need to parse the ACL data */
3991 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3992 while ((p = get_config_line()) != NULL);
3996 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3999 acl_line = get_config_line();
4001 while(acl_line != NULL)
4007 p = readconf_readname(name, sizeof(name), acl_line);
4008 if (isupper(*name) && *p == '=')
4010 read_macro_assignment(acl_line);
4011 acl_line = get_config_line();
4015 if (*p != ':' || name[0] == 0)
4016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4018 node = store_get(sizeof(tree_node) + Ustrlen(name));
4019 Ustrcpy(node->name, name);
4020 if (!tree_insertnode(&acl_anchor, node))
4021 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4022 "there are two ACLs called \"%s\"", name);
4024 node->data.ptr = acl_read(acl_callback, &error);
4026 if (node->data.ptr == NULL && error != NULL)
4027 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4033 /*************************************************
4034 * Read configuration for local_scan() *
4035 *************************************************/
4037 /* This function is called after "begin local_scan" is encountered in the
4038 configuration file. If the local_scan() function allows for configuration
4039 options, we can process them. Otherwise, we expire in a panic.
4046 local_scan_init(void)
4048 #ifndef LOCAL_SCAN_HAS_OPTIONS
4049 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4050 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4054 while ((p = get_config_line()) != NULL)
4056 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4057 NULL, US"local_scan option \"%s\" unknown");
4064 /*************************************************
4065 * Read rest of configuration (after main) *
4066 *************************************************/
4068 /* This function reads the rest of the runtime configuration, after the main
4069 configuration. It is called only when actually needed. Each subsequent section
4070 of the configuration starts with a line of the form
4074 where the name is "routers", "transports", etc. A section is terminated by
4075 hitting the next "begin" line, and the next name is left in next_section.
4076 Because it may confuse people as to whether the names are singular or plural,
4077 we add "s" if it's missing. There is always enough room in next_section for
4078 this. This function is basically just a switch.
4081 skip_acl TRUE if ACL information is not needed
4086 static uschar *section_list[] = {
4096 readconf_rest(BOOL skip_acl)
4100 while(next_section[0] != 0)
4104 int last = sizeof(section_list) / sizeof(uschar *);
4106 int n = Ustrlen(next_section);
4108 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4112 int c = strcmpic(next_section, section_list[mid]);
4114 if (c > 0) first = mid + 1; else last = mid;
4116 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4117 "\"%.*s\" is not a known configuration section name", n, next_section);
4118 mid = (last + first)/2;
4122 if (((had ^= bit) & bit) == 0)
4123 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4124 "\"%.*s\" section is repeated in the configuration file", n,
4129 case 0: readconf_acl(skip_acl); break;
4130 case 1: auths_init(); break;
4131 case 2: local_scan_init(); break;
4132 case 3: readconf_retries(); break;
4133 case 4: readconf_rewrites(); break;
4134 case 5: route_init(); break;
4135 case 6: transport_init(); break;
4139 (void)fclose(config_file);
4142 /* End of readconf.c */