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 },
144 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
146 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
147 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
148 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
149 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
150 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
151 #ifdef WITH_CONTENT_SCAN
152 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
154 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
155 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
156 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
157 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
159 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
161 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
162 { "admin_groups", opt_gidlist, &admin_groups },
163 { "allow_domain_literals", opt_bool, &allow_domain_literals },
164 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
165 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
166 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
167 { "auto_thaw", opt_time, &auto_thaw },
168 #ifdef WITH_CONTENT_SCAN
169 { "av_scanner", opt_stringptr, &av_scanner },
171 { "bi_command", opt_stringptr, &bi_command },
172 #ifdef EXPERIMENTAL_BRIGHTMAIL
173 { "bmi_config_file", opt_stringptr, &bmi_config_file },
175 { "bounce_message_file", opt_stringptr, &bounce_message_file },
176 { "bounce_message_text", opt_stringptr, &bounce_message_text },
177 { "bounce_return_body", opt_bool, &bounce_return_body },
178 { "bounce_return_message", opt_bool, &bounce_return_message },
179 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
180 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
181 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
182 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
183 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
184 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
185 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
186 { "check_log_inodes", opt_int, &check_log_inodes },
187 { "check_log_space", opt_Kint, &check_log_space },
188 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
189 { "check_spool_inodes", opt_int, &check_spool_inodes },
190 { "check_spool_space", opt_Kint, &check_spool_space },
191 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
192 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
193 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
194 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
195 #ifdef EXPERIMENTAL_DCC
196 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
197 { "dccifd_address", opt_stringptr, &dccifd_address },
198 { "dccifd_options", opt_stringptr, &dccifd_options },
200 { "delay_warning", opt_timelist, &delay_warning },
201 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
202 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
203 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
204 { "delivery_date_remove", opt_bool, &delivery_date_remove },
205 #ifdef ENABLE_DISABLE_FSYNC
206 { "disable_fsync", opt_bool, &disable_fsync },
208 { "disable_ipv6", opt_bool, &disable_ipv6 },
210 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
212 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
213 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
214 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
215 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
216 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
217 { "dns_retrans", opt_time, &dns_retrans },
218 { "dns_retry", opt_int, &dns_retry },
219 { "dns_use_dnssec", opt_int, &dns_use_dnssec },
220 { "dns_use_edns0", opt_int, &dns_use_edns0 },
221 /* This option is now a no-op, retained for compability */
222 { "drop_cr", opt_bool, &drop_cr },
223 /*********************************************************/
224 { "dsn_from", opt_stringptr, &dsn_from },
225 { "envelope_to_remove", opt_bool, &envelope_to_remove },
226 { "errors_copy", opt_stringptr, &errors_copy },
227 { "errors_reply_to", opt_stringptr, &errors_reply_to },
228 { "exim_group", opt_gid, &exim_gid },
229 { "exim_path", opt_stringptr, &exim_path },
230 { "exim_user", opt_uid, &exim_uid },
231 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
232 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
233 { "finduser_retries", opt_int, &finduser_retries },
234 { "freeze_tell", opt_stringptr, &freeze_tell },
235 { "gecos_name", opt_stringptr, &gecos_name },
236 { "gecos_pattern", opt_stringptr, &gecos_pattern },
238 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
239 { "gnutls_enable_pkcs11", opt_bool, &gnutls_enable_pkcs11 },
240 /* These three gnutls_require_* options stopped working in Exim 4.80 */
241 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
242 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
243 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
245 { "header_line_maxsize", opt_int, &header_line_maxsize },
246 { "header_maxsize", opt_int, &header_maxsize },
247 { "headers_charset", opt_stringptr, &headers_charset },
248 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
249 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
250 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
251 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
252 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
253 { "hold_domains", opt_stringptr, &hold_domains },
254 { "host_lookup", opt_stringptr, &host_lookup },
255 { "host_lookup_order", opt_stringptr, &host_lookup_order },
256 { "host_reject_connection", opt_stringptr, &host_reject_connection },
257 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
258 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
260 { "ibase_servers", opt_stringptr, &ibase_servers },
262 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
263 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
264 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
265 { "keep_malformed", opt_time, &keep_malformed },
267 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
268 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
269 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
270 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
271 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
272 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
273 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
274 { "ldap_start_tls", opt_bool, &eldap_start_tls },
275 { "ldap_version", opt_int, &eldap_version },
277 { "local_from_check", opt_bool, &local_from_check },
278 { "local_from_prefix", opt_stringptr, &local_from_prefix },
279 { "local_from_suffix", opt_stringptr, &local_from_suffix },
280 { "local_interfaces", opt_stringptr, &local_interfaces },
281 { "local_scan_timeout", opt_time, &local_scan_timeout },
282 { "local_sender_retain", opt_bool, &local_sender_retain },
283 { "localhost_number", opt_stringptr, &host_number_string },
284 { "log_file_path", opt_stringptr, &log_file_path },
285 { "log_selector", opt_stringptr, &log_selector_string },
286 { "log_timezone", opt_bool, &log_timezone },
287 { "lookup_open_max", opt_int, &lookup_open_max },
288 { "max_username_length", opt_int, &max_username_length },
289 { "message_body_newlines", opt_bool, &message_body_newlines },
290 { "message_body_visible", opt_mkint, &message_body_visible },
291 { "message_id_header_domain", opt_stringptr, &message_id_domain },
292 { "message_id_header_text", opt_stringptr, &message_id_text },
293 { "message_logs", opt_bool, &message_logs },
294 { "message_size_limit", opt_stringptr, &message_size_limit },
295 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
296 { "move_frozen_messages", opt_bool, &move_frozen_messages },
298 { "mua_wrapper", opt_bool, &mua_wrapper },
300 { "mysql_servers", opt_stringptr, &mysql_servers },
302 { "never_users", opt_uidlist, &never_users },
304 { "openssl_options", opt_stringptr, &openssl_options },
307 { "oracle_servers", opt_stringptr, &oracle_servers },
309 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
311 { "perl_at_start", opt_bool, &opt_perl_at_start },
312 { "perl_startup", opt_stringptr, &opt_perl_startup },
315 { "pgsql_servers", opt_stringptr, &pgsql_servers },
317 { "pid_file_path", opt_stringptr, &pid_file_path },
318 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
319 { "preserve_message_logs", opt_bool, &preserve_message_logs },
320 { "primary_hostname", opt_stringptr, &primary_hostname },
321 { "print_topbitchars", opt_bool, &print_topbitchars },
322 { "process_log_path", opt_stringptr, &process_log_path },
323 { "prod_requires_admin", opt_bool, &prod_requires_admin },
324 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
325 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
326 { "queue_domains", opt_stringptr, &queue_domains },
327 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
328 { "queue_only", opt_bool, &queue_only },
329 { "queue_only_file", opt_stringptr, &queue_only_file },
330 { "queue_only_load", opt_fixed, &queue_only_load },
331 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
332 { "queue_only_override", opt_bool, &queue_only_override },
333 { "queue_run_in_order", opt_bool, &queue_run_in_order },
334 { "queue_run_max", opt_int, &queue_run_max },
335 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
336 { "receive_timeout", opt_time, &receive_timeout },
337 { "received_header_text", opt_stringptr, &received_header_text },
338 { "received_headers_max", opt_int, &received_headers_max },
339 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
340 { "recipients_max", opt_int, &recipients_max },
341 { "recipients_max_reject", opt_bool, &recipients_max_reject },
342 { "remote_max_parallel", opt_int, &remote_max_parallel },
343 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
344 { "retry_data_expire", opt_time, &retry_data_expire },
345 { "retry_interval_max", opt_time, &retry_interval_max },
346 { "return_path_remove", opt_bool, &return_path_remove },
347 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
348 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
349 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
350 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
351 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
352 { "smtp_accept_max", opt_int, &smtp_accept_max },
353 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
354 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
355 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
356 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
357 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
358 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
359 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
360 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
361 { "smtp_banner", opt_stringptr, &smtp_banner },
362 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
363 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
364 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
365 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
366 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
367 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
368 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
369 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
370 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
371 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
372 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
373 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
374 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
375 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
376 #ifdef WITH_CONTENT_SCAN
377 { "spamd_address", opt_stringptr, &spamd_address },
379 #ifdef EXPERIMENTAL_SPF
380 { "spf_guess", opt_stringptr, &spf_guess },
382 { "split_spool_directory", opt_bool, &split_spool_directory },
383 { "spool_directory", opt_stringptr, &spool_directory },
385 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
387 #ifdef EXPERIMENTAL_SRS
388 { "srs_config", opt_stringptr, &srs_config },
389 { "srs_hashlength", opt_int, &srs_hashlength },
390 { "srs_hashmin", opt_int, &srs_hashmin },
391 { "srs_maxage", opt_int, &srs_maxage },
392 { "srs_secrets", opt_stringptr, &srs_secrets },
393 { "srs_usehash", opt_bool, &srs_usehash },
394 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
396 { "strict_acl_vars", opt_bool, &strict_acl_vars },
397 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
398 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
399 { "syslog_duplication", opt_bool, &syslog_duplication },
400 { "syslog_facility", opt_stringptr, &syslog_facility_str },
401 { "syslog_processname", opt_stringptr, &syslog_processname },
402 { "syslog_timestamp", opt_bool, &syslog_timestamp },
403 { "system_filter", opt_stringptr, &system_filter },
404 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
405 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
406 { "system_filter_group", opt_gid, &system_filter_gid },
407 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
408 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
409 { "system_filter_user", opt_uid, &system_filter_uid },
410 { "tcp_nodelay", opt_bool, &tcp_nodelay },
411 #ifdef USE_TCP_WRAPPERS
412 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
414 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
415 { "timezone", opt_stringptr, &timezone_string },
417 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
418 { "tls_certificate", opt_stringptr, &tls_certificate },
419 { "tls_crl", opt_stringptr, &tls_crl },
420 { "tls_dh_max_bits", opt_int, &tls_dh_max_bits },
421 { "tls_dhparam", opt_stringptr, &tls_dhparam },
422 # if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
423 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
425 { "tls_on_connect_ports", opt_stringptr, &tls_in.on_connect_ports },
426 { "tls_privatekey", opt_stringptr, &tls_privatekey },
427 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
428 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
429 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
430 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
431 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
433 { "trusted_groups", opt_gidlist, &trusted_groups },
434 { "trusted_users", opt_uidlist, &trusted_users },
435 { "unknown_login", opt_stringptr, &unknown_login },
436 { "unknown_username", opt_stringptr, &unknown_username },
437 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
438 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
439 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
440 { "warn_message_file", opt_stringptr, &warn_message_file },
441 { "write_rejectlog", opt_bool, &write_rejectlog }
444 static int optionlist_config_size =
445 sizeof(optionlist_config)/sizeof(optionlist);
449 /*************************************************
450 * Find the name of an option *
451 *************************************************/
453 /* This function is to aid debugging. Various functions take arguments that are
454 pointer variables in the options table or in option tables for various drivers.
455 For debugging output, it is useful to be able to find the name of the option
456 which is currently being processed. This function finds it, if it exists, by
457 searching the table(s).
459 Arguments: a value that is presumed to be in the table above
460 Returns: the option name, or an empty string
464 readconf_find_option(void *p)
468 transport_instance *t;
470 for (i = 0; i < optionlist_config_size; i++)
471 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
473 for (r = routers; r != NULL; r = r->next)
475 router_info *ri = r->info;
476 for (i = 0; i < ri->options_count[0]; i++)
478 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
479 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
480 return US ri->options[i].name;
484 for (t = transports; t != NULL; t = t->next)
486 transport_info *ti = t->info;
487 for (i = 0; i < ti->options_count[0]; i++)
489 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
490 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
491 return US ti->options[i].name;
501 /*************************************************
502 * Deal with an assignment to a macro *
503 *************************************************/
505 /* This function is called when a line that starts with an upper case letter is
506 encountered. The argument "line" should contain a complete logical line, and
507 start with the first letter of the macro name. The macro name and the
508 replacement text are extracted and stored. Redefinition of existing,
509 non-command line, macros is permitted using '==' instead of '='.
512 s points to the start of the logical line
518 read_macro_assignment(uschar *s)
524 macro_item *mlast = NULL;
526 while (isalnum(*s) || *s == '_')
528 if (namelen >= sizeof(name) - 1)
529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
530 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
531 name[namelen++] = *s++;
535 while (isspace(*s)) s++;
537 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
544 while (isspace(*s)) s++;
546 /* If an existing macro of the same name was defined on the command line, we
547 just skip this definition. It's an error to attempt to redefine a macro without
548 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
549 It is also an error to define a macro whose name begins with the name of a
550 previously defined macro. Note: it is documented that the other way round
553 for (m = macros; m != NULL; m = m->next)
555 int len = Ustrlen(m->name);
557 if (Ustrcmp(m->name, name) == 0)
559 if (!m->command_line && !redef)
560 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
561 "defined (use \"==\" if you want to redefine it", name);
565 if (len < namelen && Ustrstr(name, m->name) != NULL)
566 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
567 "a macro because previously defined macro \"%s\" is a substring",
570 /* We cannot have this test, because it is documented that a substring
571 macro is permitted (there is even an example).
573 * if (len > namelen && Ustrstr(m->name, name) != NULL)
574 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
575 * "a macro because it is a substring of previously defined macro \"%s\"",
582 /* Check for an overriding command-line definition. */
584 if (m != NULL && m->command_line) return;
586 /* Redefinition must refer to an existing macro. */
591 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
595 /* We have a new definition. The macro_item structure includes a final vector
596 called "name" which is one byte long. Thus, adding "namelen" gives us enough
597 room to store the "name" string. */
601 m = store_get(sizeof(macro_item) + namelen);
602 if (macros == NULL) macros = m; else mlast->next = m;
603 Ustrncpy(m->name, name, namelen);
604 m->name[namelen] = 0;
606 m->command_line = FALSE;
609 /* Set the value of the new or redefined macro */
611 m->replacement = string_copy(s);
618 /*************************************************
619 * Read configuration line *
620 *************************************************/
622 /* A logical line of text is read from the configuration file into the big
623 buffer, taking account of macros, .includes, and continuations. The size of
624 big_buffer is increased if necessary. The count of configuration lines is
625 maintained. Physical input lines starting with # (ignoring leading white space,
626 and after macro replacement) and empty logical lines are always ignored.
627 Leading and trailing spaces are removed.
629 If we hit a line of the form "begin xxxx", the xxxx is placed in the
630 next_section vector, and the function returns NULL, indicating the end of a
631 configuration section. On end-of-file, NULL is returned with next_section
636 Returns: a pointer to the first non-blank in the line,
637 or NULL if eof or end of section is reached
641 get_config_line(void)
643 int startoffset = 0; /* To first non-blank char in logical line */
644 int len = 0; /* Of logical line so far */
650 /* Loop for handling continuation lines, skipping comments, and dealing with
655 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
657 if (config_file_stack != NULL) /* EOF inside .include */
659 (void)fclose(config_file);
660 config_file = config_file_stack->file;
661 config_filename = config_file_stack->filename;
662 config_lineno = config_file_stack->lineno;
663 config_file_stack = config_file_stack->next;
667 /* EOF at top level */
669 if (cstate_stack_ptr >= 0)
670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
671 "Unexpected end of configuration file: .endif missing");
673 if (len != 0) break; /* EOF after continuation */
674 next_section[0] = 0; /* EOF at start of logical line */
679 newlen = len + Ustrlen(big_buffer + len);
681 /* Handle pathologically long physical lines - yes, it did happen - by
682 extending big_buffer at this point. The code also copes with very long
685 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
688 big_buffer_size += BIG_BUFFER_SIZE;
689 newbuffer = store_malloc(big_buffer_size);
691 /* This use of strcpy is OK because we know that the string in the old
692 buffer is shorter than the new buffer. */
694 Ustrcpy(newbuffer, big_buffer);
695 store_free(big_buffer);
696 big_buffer = newbuffer;
697 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
699 newlen += Ustrlen(big_buffer + newlen);
702 /* Find the true start of the physical line - leading spaces are always
705 ss = big_buffer + len;
706 while (isspace(*ss)) ss++;
708 /* Process the physical line for macros. If this is the start of the logical
709 line, skip over initial text at the start of the line if it starts with an
710 upper case character followed by a sequence of name characters and an equals
711 sign, because that is the definition of a new macro, and we don't do
712 replacement therein. */
715 if (len == 0 && isupper(*s))
717 while (isalnum(*s) || *s == '_') s++;
718 while (isspace(*s)) s++;
719 if (*s != '=') s = ss; /* Not a macro definition */
722 /* For each defined macro, scan the line (from after XXX= if present),
723 replacing all occurrences of the macro. */
726 for (m = macros; m != NULL; m = m->next)
731 while ((p = Ustrstr(t, m->name)) != NULL)
734 int namelen = Ustrlen(m->name);
735 int replen = Ustrlen(m->replacement);
737 /* Expand the buffer if necessary */
739 while (newlen - namelen + replen + 1 > big_buffer_size)
741 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
742 uschar *newbuffer = store_malloc(newsize);
743 memcpy(newbuffer, big_buffer, newlen + 1);
744 p = newbuffer + (p - big_buffer);
745 s = newbuffer + (s - big_buffer);
746 ss = newbuffer + (ss - big_buffer);
747 t = newbuffer + (t - big_buffer);
748 big_buffer_size = newsize;
749 store_free(big_buffer);
750 big_buffer = newbuffer;
753 /* Shuffle the remaining characters up or down in the buffer before
754 copying in the replacement text. Don't rescan the replacement for this
758 moveby = replen - namelen;
761 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
764 Ustrncpy(p, m->replacement, replen);
770 /* An empty macro replacement at the start of a line could mean that ss no
771 longer points to the first non-blank character. */
773 while (isspace(*ss)) ss++;
775 /* Check for comment lines - these are physical lines. */
777 if (*ss == '#') continue;
779 /* Handle conditionals, which are also applied to physical lines. Conditions
780 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
781 expansion occured on the rest of the line. A preliminary test for the leading
782 '.' saves effort on most lines. */
788 /* Search the list of conditional directives */
790 for (i = 0; i < cond_list_size; i++)
793 cond_item *c = cond_list+i;
794 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
796 /* The following character must be white space or end of string */
798 n = ss[1 + c->namelen];
799 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
801 /* .ifdef and .ifndef push the current state onto the stack, then set
802 a new one from the table. Stack overflow is an error */
806 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
807 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
808 ".%s nested too deeply", c->name);
809 cstate_stack[++cstate_stack_ptr] = cstate;
810 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
813 /* For any of the others, stack underflow is an error. The next state
814 comes either from the stack (.endif) or from the table. */
818 if (cstate_stack_ptr < 0)
819 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
820 ".%s without matching .ifdef", c->name);
821 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
822 next_cstate[cstate][macro_found? c->action1 : c->action2];
825 /* Having dealt with a directive, break the loop */
830 /* If we have handled a conditional directive, continue with the next
831 physical line. Otherwise, fall through. */
833 if (i < cond_list_size) continue;
836 /* If the conditional state is not 0 (actively using these lines), ignore
839 if (cstate != 0) continue; /* Conditional skip */
841 /* Handle .include lines - these are also physical lines. */
843 if (Ustrncmp(ss, ".include", 8) == 0 &&
845 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
848 int include_if_exists = isspace(ss[8])? 0 : 10;
849 config_file_item *save;
852 ss += 9 + include_if_exists;
853 while (isspace(*ss)) ss++;
854 t = ss + Ustrlen(ss);
855 while (t > ss && isspace(t[-1])) t--;
856 if (*ss == '\"' && t[-1] == '\"')
864 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
865 "absolute path \"%s\"", ss);
867 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
869 save = store_get(sizeof(config_file_item));
870 save->next = config_file_stack;
871 config_file_stack = save;
872 save->file = config_file;
873 save->filename = config_filename;
874 save->lineno = config_lineno;
876 config_file = Ufopen(ss, "rb");
877 if (config_file == NULL)
878 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
879 "configuration file %s", ss);
880 config_filename = string_copy(ss);
885 /* If this is the start of the logical line, remember where the non-blank
886 data starts. Otherwise shuffle down continuation lines to remove leading
890 startoffset = ss - big_buffer;
893 s = big_buffer + len;
896 memmove(s, ss, (newlen - len) - (ss - s) + 1);
901 /* Accept the new addition to the line. Remove trailing white space. */
904 while (len > 0 && isspace(big_buffer[len-1])) len--;
907 /* We are done if the line does not end in backslash and contains some data.
908 Empty logical lines are ignored. For continuations, remove the backslash and
909 go round the loop to read the continuation line. */
913 if (big_buffer[len-1] != '\\') break; /* End of logical line */
914 big_buffer[--len] = 0; /* Remove backslash */
916 } /* Loop for reading multiple physical lines */
918 /* We now have a logical line. Test for the end of a configuration section (or,
919 more accurately, for the start of the next section). Place the name of the next
920 section in next_section, and return NULL. If the name given is longer than
921 next_section, truncate it. It will be unrecognized later, because all the known
922 section names do fit. Leave space for pluralizing. */
924 s = big_buffer + startoffset; /* First non-space character */
925 if (strncmpic(s, US"begin ", 6) == 0)
928 while (isspace(*s)) s++;
929 if (big_buffer + len - s > sizeof(next_section) - 2)
930 s[sizeof(next_section) - 2] = 0;
931 Ustrcpy(next_section, s);
935 /* Return the first non-blank character. */
942 /*************************************************
944 *************************************************/
946 /* The yield is the pointer to the next uschar. Names longer than the
947 output space are silently truncated. This function is also used from acl.c when
951 name where to put the name
955 Returns: new input pointer
959 readconf_readname(uschar *name, int len, uschar *s)
962 while (isspace(*s)) s++;
965 while (isalnum(*s) || *s == '_')
967 if (p < len-1) name[p++] = *s;
972 while (isspace(*s)) s++;
979 /*************************************************
980 * Read a time value *
981 *************************************************/
983 /* This function is also called from outside, to read argument
984 time values. The format of a time value is:
986 [<n>w][<n>d][<n>h][<n>m][<n>s]
988 as long as at least one is present. If a format error is encountered,
989 return a negative value. The value must be terminated by the given
994 terminator required terminating character
995 return_msec if TRUE, allow fractional seconds and return milliseconds
997 Returns: the time value, or -1 on syntax error
998 value is seconds if return_msec is FALSE
999 value is milliseconds if return_msec is TRUE
1003 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1011 if (!isdigit(*s)) return -1;
1012 (void)sscanf(CS s, "%d%n", &value, &count);
1017 case 'w': value *= 7;
1018 case 'd': value *= 24;
1019 case 'h': value *= 60;
1020 case 'm': value *= 60;
1025 if (!return_msec) return -1;
1026 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1028 if (*s++ != 's') return -1;
1029 yield += (int)(fraction * 1000.0);
1035 if (return_msec) value *= 1000;
1037 if (*s == terminator) return yield;
1039 /* Control never reaches here. */
1044 /*************************************************
1045 * Read a fixed point value *
1046 *************************************************/
1048 /* The value is returned *1000
1052 terminator required terminator
1054 Returns: the value, or -1 on error
1058 readconf_readfixed(uschar *s, int terminator)
1062 if (!isdigit(*s)) return -1;
1063 (void)sscanf(CS s, "%d%n", &value, &count);
1065 yield = value * 1000;
1069 while (isdigit((*(++s))))
1071 yield += (*s - '0') * m;
1076 return (*s == terminator)? yield : (-1);
1081 /*************************************************
1082 * Find option in list *
1083 *************************************************/
1085 /* The lists are always in order, so binary chop can be used.
1088 name the option name to search for
1089 ol the first entry in the option list
1090 last one more than the offset of the last entry in the option list
1092 Returns: pointer to an option entry, or NULL if not found
1096 find_option(uschar *name, optionlist *ol, int last)
1099 while (last > first)
1101 int middle = (first + last)/2;
1102 int c = Ustrcmp(name, ol[middle].name);
1103 if (c == 0) return ol + middle;
1104 else if (c > 0) first = middle + 1;
1112 /*************************************************
1113 * Find a set flag in option list *
1114 *************************************************/
1116 /* Because some versions of Unix make no restrictions on the values of uids and
1117 gids (even negative ones), we cannot represent "unset" by a special value.
1118 There is therefore a separate boolean variable for each one indicating whether
1119 a value is set or not. This function returns a pointer to the boolean, given
1120 the original option name. It is a major disaster if the flag cannot be found.
1123 name the name of the uid or gid option
1124 oltop points to the start of the relevant option list
1125 last one more than the offset of the last item in the option list
1126 data_block NULL when reading main options => data values in the option
1127 list are absolute addresses; otherwise they are byte offsets
1128 in data_block (used for driver options)
1130 Returns: a pointer to the boolean flag.
1134 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1138 sprintf(CS name2, "*set_%.50s", name);
1139 ol = find_option(name2, oltop, last);
1140 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1141 "Exim internal error: missing set flag for %s", name);
1142 return (data_block == NULL)? (BOOL *)(ol->value) :
1143 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1149 /*************************************************
1150 * Output extra characters message and die *
1151 *************************************************/
1153 /* Called when an option line has junk on the end. Sometimes this is because
1154 the sysadmin thinks comments are permitted.
1157 s points to the extra characters
1158 t1..t3 strings to insert in the log message
1160 Returns: doesn't return; dies
1164 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1166 uschar *comment = US"";
1167 if (*s == '#') comment = US" (# is comment only at line start)";
1168 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1169 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1174 /*************************************************
1175 * Read rewrite information *
1176 *************************************************/
1178 /* Each line of rewrite information contains:
1180 . A complete address in the form user@domain, possibly with
1181 leading * for each part; or alternatively, a regex.
1183 . A replacement string (which will be expanded).
1185 . An optional sequence of one-letter flags, indicating which
1186 headers etc. to apply this rule to.
1188 All this is decoded and placed into a control block. The OR of the flags is
1189 maintained in a common word.
1192 p points to the string that makes up the rule
1193 existflags points to the overall flag word
1194 isglobal TRUE if reading global rewrite rules
1196 Returns: the control block for the parsed rule.
1199 static rewrite_rule *
1200 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1202 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1205 next->key = string_dequote(&p);
1207 while (isspace(*p)) p++;
1209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1210 "missing rewrite replacement string");
1213 next->replacement = string_dequote(&p);
1215 while (*p != 0) switch (*p++)
1217 case ' ': case '\t': break;
1219 case 'q': next->flags |= rewrite_quit; break;
1220 case 'w': next->flags |= rewrite_whole; break;
1222 case 'h': next->flags |= rewrite_all_headers; break;
1223 case 's': next->flags |= rewrite_sender; break;
1224 case 'f': next->flags |= rewrite_from; break;
1225 case 't': next->flags |= rewrite_to; break;
1226 case 'c': next->flags |= rewrite_cc; break;
1227 case 'b': next->flags |= rewrite_bcc; break;
1228 case 'r': next->flags |= rewrite_replyto; break;
1230 case 'E': next->flags |= rewrite_all_envelope; break;
1231 case 'F': next->flags |= rewrite_envfrom; break;
1232 case 'T': next->flags |= rewrite_envto; break;
1234 case 'Q': next->flags |= rewrite_qualify; break;
1235 case 'R': next->flags |= rewrite_repeat; break;
1238 next->flags |= rewrite_smtp;
1239 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1240 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1241 "rewrite rule has the S flag but is not a regular expression");
1245 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1246 "unknown rewrite flag character '%c' "
1247 "(could be missing quotes round replacement item)", p[-1]);
1251 /* If no action flags are set, set all the "normal" rewrites. */
1253 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1254 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1256 /* Remember which exist, for optimization, and return the rule */
1258 *existflags |= next->flags;
1265 /*************************************************
1266 * Read global rewrite information *
1267 *************************************************/
1269 /* Each line is a single rewrite rule; it is parsed into a control block
1270 by readconf_one_rewrite(), and its flags are ORed into the global flag
1271 word rewrite_existflags. */
1274 readconf_rewrites(void)
1276 rewrite_rule **chain = &global_rewrite_rules;
1279 while ((p = get_config_line()) != NULL)
1281 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1283 chain = &(next->next);
1289 /*************************************************
1291 *************************************************/
1293 /* Strings are read into the normal store pool. As long we aren't too
1294 near the end of the current block, the string will just use what is necessary
1295 on the top of the stacking pool, because string_cat() uses the extension
1299 s the rest of the input line
1300 name the option name (for errors)
1302 Returns: pointer to the string
1306 read_string(uschar *s, uschar *name)
1311 if (*s != '\"') return string_copy(s);
1314 yield = string_dequote(&s);
1316 if (s == ss+1 || s[-1] != '\"')
1317 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1318 "missing quote at end of string value for %s", name);
1320 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1326 /*************************************************
1327 * Handle option line *
1328 *************************************************/
1330 /* This function is called from several places to process a line containing the
1331 setting of an option. The first argument is the line to be decoded; it has been
1332 checked not to be empty and not to start with '#'. Trailing newlines and white
1333 space have been removed. The second argument is a pointer to the list of
1334 variable names that are to be recognized, together with their types and
1335 locations, and the third argument gives the number of entries in the list.
1337 The fourth argument is a pointer to a data block. If it is NULL, then the data
1338 values in the options list are absolute addresses. Otherwise, they are byte
1339 offsets in the data block.
1341 String option data may continue onto several lines; this function reads further
1342 data from config_file if necessary.
1344 The yield of this function is normally zero. If a string continues onto
1345 multiple lines, then the data value is permitted to be followed by a comma
1346 or a semicolon (for use in drivers) and the yield is that character.
1349 buffer contains the configuration line to be handled
1350 oltop points to the start of the relevant option list
1351 last one more than the offset of the last item in the option list
1352 data_block NULL when reading main options => data values in the option
1353 list are absolute addresses; otherwise they are byte offsets
1354 in data_block when they have opt_public set; otherwise
1355 they are byte offsets in data_block->options_block.
1356 unknown_txt format string to use in panic message for unknown option;
1357 must contain %s for option name
1358 if given as NULL, don't panic on unknown option
1360 Returns: TRUE if an option was read successfully,
1361 FALSE false for an unknown option if unknown_txt == NULL,
1362 otherwise panic and die on an unknown option
1366 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1367 void *data_block, uschar *unknown_txt)
1371 int n, count, type, value;
1375 BOOL boolvalue = TRUE;
1376 BOOL freesptr = TRUE;
1377 BOOL extra_condition = FALSE;
1378 optionlist *ol, *ol2;
1382 uschar *inttype = US"";
1385 uschar *saved_condition, *strtemp;
1386 uschar **str_target;
1390 /* There may be leading spaces; thereafter, we expect an option name starting
1393 while (isspace(*s)) s++;
1395 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1397 /* Read the name of the option, and skip any subsequent white space. If
1398 it turns out that what we read was "hide", set the flag indicating that
1399 this is a secure option, and loop to read the next word. */
1401 for (n = 0; n < 2; n++)
1403 while (isalnum(*s) || *s == '_')
1405 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1409 while (isspace(*s)) s++;
1410 if (Ustrcmp(name, "hide") != 0) break;
1411 issecure = opt_secure;
1415 /* Deal with "no_" or "not_" here for booleans */
1417 if (Ustrncmp(name, "no_", 3) == 0)
1423 if (Ustrncmp(name, "not_", 4) == 0)
1429 /* Search the list for the given name. A non-existent name, or an option that
1430 is set twice, is a disaster. */
1432 ol = find_option(name + offset, oltop, last);
1436 if (unknown_txt == NULL) return FALSE;
1437 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1440 if ((ol->type & opt_set) != 0)
1442 uschar *mname = name;
1443 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1444 if (Ustrcmp(mname, "condition") == 0)
1445 extra_condition = TRUE;
1447 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1448 "\"%s\" option set for the second time", mname);
1451 ol->type |= opt_set | issecure;
1452 type = ol->type & opt_mask;
1454 /* Types with data values must be followed by '='; the "no[t]_" prefix
1455 applies only to boolean values. */
1457 if (type < opt_bool || type > opt_bool_last)
1460 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1461 "negation prefix applied to a non-boolean option");
1463 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1464 "unexpected end of line (data missing) after %s", name);
1466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1469 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1470 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1471 ultimately expands to one of those values. */
1473 else if (*s != 0 && (offset != 0 || *s != '='))
1474 extra_chars_error(s, US"boolean option ", name, US"");
1476 /* Skip white space after = */
1478 if (*s == '=') while (isspace((*(++s))));
1480 /* If there is a data block and the opt_public flag is not set, change
1481 the data block pointer to the private options block. */
1483 if (data_block != NULL && (ol->type & opt_public) == 0)
1484 data_block = (void *)(((driver_instance *)data_block)->options_block);
1486 /* Now get the data according to the type. */
1490 /* If a string value is not enclosed in quotes, it consists of
1491 the rest of the current line, verbatim. Otherwise, string escapes
1494 A transport is specified as a string, which is then looked up in the
1495 list of transports. A search type is specified as one of a number of
1498 A set or rewrite rules for a driver is specified as a string, which is
1499 then parsed into a suitable chain of control blocks.
1501 Uids and gids are specified as strings which are then looked up in the
1502 passwd file. Lists of uids and gids are similarly specified as colon-
1503 separated strings. */
1508 case opt_expand_uid:
1509 case opt_expand_gid:
1514 reset_point = sptr = read_string(s, name);
1516 /* Having read a string, we now have several different ways of using it,
1517 depending on the data type, so do another switch. If keeping the actual
1518 string is not required (because it is interpreted), freesptr is set TRUE,
1519 and at the end we reset the pool. */
1523 /* If this was a string, set the variable to point to the new string,
1524 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1525 rules, we still keep the string (for printing), and parse the rules into a
1526 control block and flags word. */
1529 if (data_block == NULL)
1530 str_target = (uschar **)(ol->value);
1532 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1533 if (extra_condition)
1535 /* We already have a condition, we're conducting a crude hack to let
1536 multiple condition rules be chained together, despite storing them in
1538 saved_condition = *str_target;
1539 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1540 saved_condition, sptr);
1541 *str_target = string_copy_malloc(strtemp);
1542 /* TODO(pdp): there is a memory leak here when we set 3 or more
1543 conditions; I still don't understand the store mechanism enough
1544 to know what's the safe way to free content from an earlier store.
1545 AFAICT, stores stack, so freeing an early stored item also stores
1546 all data alloc'd after it. If we knew conditions were adjacent,
1547 we could survive that, but we don't. So I *think* we need to take
1548 another bit from opt_type to indicate "malloced"; this seems like
1549 quite a hack, especially for this one case. It also means that
1550 we can't ever reclaim the store from the *first* condition.
1552 Because we only do this once, near process start-up, I'm prepared to
1553 let this slide for the time being, even though it rankles. */
1563 if (data_block == NULL)
1564 *((uschar **)(ol->value)) = sptr;
1566 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1568 if (type == opt_rewrite)
1573 rewrite_rule **chain;
1576 sprintf(CS name2, "*%.50s_rules", name);
1577 ol2 = find_option(name2, oltop, last);
1578 sprintf(CS name2, "*%.50s_flags", name);
1579 ol3 = find_option(name2, oltop, last);
1581 if (ol2 == NULL || ol3 == NULL)
1582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1583 "rewrite rules not available for driver");
1585 if (data_block == NULL)
1587 chain = (rewrite_rule **)(ol2->value);
1588 flagptr = (int *)(ol3->value);
1592 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1593 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1596 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1599 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1601 chain = &(next->next);
1604 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1605 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1606 "non-header rewrite - not allowed at transport time -");
1610 /* If it was an expanded uid, see if there is any expansion to be
1611 done by checking for the presence of a $ character. If there is, save it
1612 in the corresponding *expand_user option field. Otherwise, fall through
1613 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1616 case opt_expand_uid:
1617 sprintf(CS name2, "*expand_%.50s", name);
1618 ol2 = find_option(name2, oltop, last);
1621 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1623 if (data_block == NULL)
1624 *((uschar **)(ol2->value)) = ss;
1626 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1630 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1636 /* Look up a fixed uid, and also make use of the corresponding gid
1637 if a passwd entry is returned and the gid has not been set. */
1640 if (!route_finduser(sptr, &pw, &uid))
1641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1642 if (data_block == NULL)
1643 *((uid_t *)(ol->value)) = uid;
1645 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1647 /* Set the flag indicating a fixed value is set */
1649 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1651 /* Handle matching gid if we have a passwd entry: done by finding the
1652 same name with terminating "user" changed to "group"; if not found,
1653 ignore. Also ignore if the value is already set. */
1655 if (pw == NULL) break;
1656 Ustrcpy(name+Ustrlen(name)-4, "group");
1657 ol2 = find_option(name, oltop, last);
1658 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1659 (ol2->type & opt_mask) == opt_expand_gid))
1661 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1664 if (data_block == NULL)
1665 *((gid_t *)(ol2->value)) = pw->pw_gid;
1667 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1673 /* If it was an expanded gid, see if there is any expansion to be
1674 done by checking for the presence of a $ character. If there is, save it
1675 in the corresponding *expand_user option field. Otherwise, fall through
1676 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1679 case opt_expand_gid:
1680 sprintf(CS name2, "*expand_%.50s", name);
1681 ol2 = find_option(name2, oltop, last);
1684 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1686 if (data_block == NULL)
1687 *((uschar **)(ol2->value)) = ss;
1689 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1693 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1699 /* Handle freestanding gid */
1702 if (!route_findgroup(sptr, &gid))
1703 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1704 if (data_block == NULL)
1705 *((gid_t *)(ol->value)) = gid;
1707 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1708 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1711 /* If it was a uid list, look up each individual entry, and build
1712 a vector of uids, with a count in the first element. Put the vector
1713 in malloc store so we can free the string. (We are reading into
1714 permanent store already.) */
1722 uschar *op = expand_string (sptr);
1725 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1726 name, expand_string_message);
1729 if (*p != 0) count++;
1730 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1731 list = store_malloc(count*sizeof(uid_t));
1732 list[ptr++] = (uid_t)(count - 1);
1734 if (data_block == NULL)
1735 *((uid_t **)(ol->value)) = list;
1737 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1743 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1744 if (!route_finduser(big_buffer, NULL, &uid))
1745 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1752 /* If it was a gid list, look up each individual entry, and build
1753 a vector of gids, with a count in the first element. Put the vector
1754 in malloc store so we can free the string. (We are reading into permanent
1763 uschar *op = expand_string (sptr);
1766 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1767 name, expand_string_message);
1770 if (*p != 0) count++;
1771 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1772 list = store_malloc(count*sizeof(gid_t));
1773 list[ptr++] = (gid_t)(count - 1);
1775 if (data_block == NULL)
1776 *((gid_t **)(ol->value)) = list;
1778 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1784 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1785 if (!route_findgroup(big_buffer, &gid))
1786 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1794 /* Release store if the value of the string doesn't need to be kept. */
1796 if (freesptr) store_reset(reset_point);
1799 /* Expanded boolean: if no characters follow, or if there are no dollar
1800 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1801 save the string for later expansion in the alternate place. */
1803 case opt_expand_bool:
1804 if (*s != 0 && Ustrchr(s, '$') != 0)
1806 sprintf(CS name2, "*expand_%.50s", name);
1807 ol2 = find_option(name2, oltop, last);
1810 reset_point = sptr = read_string(s, name);
1811 if (data_block == NULL)
1812 *((uschar **)(ol2->value)) = sptr;
1814 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1821 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1822 look for yes/not/true/false. Some booleans are stored in a single bit in
1823 a single int. There's a special fudge for verify settings; without a suffix
1824 they set both xx_sender and xx_recipient. The table points to the sender
1825 value; search subsequently for the recipient. There's another special case:
1826 opt_bool_set also notes when a boolean has been set. */
1830 case opt_bool_verify:
1834 s = readconf_readname(name2, 64, s);
1835 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1837 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1839 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1840 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1841 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1842 US"for boolean option ", name);
1845 /* Handle single-bit type. */
1847 if (type == opt_bit)
1849 int bit = 1 << ((ol->type >> 16) & 31);
1850 int *ptr = (data_block == NULL)?
1851 (int *)(ol->value) :
1852 (int *)((uschar *)data_block + (long int)ol->value);
1853 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1857 /* Handle full BOOL types */
1859 if (data_block == NULL)
1860 *((BOOL *)(ol->value)) = boolvalue;
1862 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1866 if (type == opt_bool_verify)
1868 sprintf(CS name2, "%.50s_recipient", name + offset);
1869 ol2 = find_option(name2, oltop, last);
1872 if (data_block == NULL)
1873 *((BOOL *)(ol2->value)) = boolvalue;
1875 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1879 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1881 else if (type == opt_bool_set)
1883 sprintf(CS name2, "*set_%.50s", name + offset);
1884 ol2 = find_option(name2, oltop, last);
1887 if (data_block == NULL)
1888 *((BOOL *)(ol2->value)) = TRUE;
1890 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1899 inttype = US"octal ";
1901 /* Integer: a simple(ish) case; allow octal and hex formats, and
1902 suffixes K and M. The different types affect output, not input. */
1911 lvalue = strtol(CS s, CSS &endptr, intbase);
1914 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1917 if (errno != ERANGE)
1919 if (tolower(*endptr) == 'k')
1921 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1922 else lvalue *= 1024;
1925 else if (tolower(*endptr) == 'm')
1927 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1929 else lvalue *= 1024*1024;
1934 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1935 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1936 "absolute value of integer \"%s\" is too large (overflow)", s);
1938 while (isspace(*endptr)) endptr++;
1940 extra_chars_error(endptr, inttype, US"integer value for ", name);
1942 value = (int)lvalue;
1945 if (data_block == NULL)
1946 *((int *)(ol->value)) = value;
1948 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1951 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1958 value = strtol(CS s, CSS &endptr, intbase);
1961 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1964 if (errno != ERANGE)
1966 if (tolower(*endptr) == 'm')
1968 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1972 else if (tolower(*endptr) == 'k')
1978 value = (value + 512)/1024;
1982 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1983 "absolute value of integer \"%s\" is too large (overflow)", s);
1985 while (isspace(*endptr)) endptr++;
1987 extra_chars_error(endptr, inttype, US"integer value for ", name);
1990 if (data_block == NULL)
1991 *((int *)(ol->value)) = value;
1993 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1996 /* Fixed-point number: held to 3 decimal places. */
1999 if (sscanf(CS s, "%d%n", &value, &count) != 1)
2000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2001 "fixed-point number expected for %s", name);
2003 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2004 "integer \"%s\" is too large (overflow)", s);
2008 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2009 "integer \"%s\" is too large (overflow)", s);
2011 if (s[count] == '.')
2014 while (isdigit(s[++count]))
2016 value += (s[count] - '0') * d;
2021 while (isspace(s[count])) count++;
2024 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2026 if (data_block == NULL)
2027 *((int *)(ol->value)) = value;
2029 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2032 /* There's a special routine to read time values. */
2035 value = readconf_readtime(s, 0, FALSE);
2037 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2039 if (data_block == NULL)
2040 *((int *)(ol->value)) = value;
2042 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2045 /* A time list is a list of colon-separated times, with the first
2046 element holding the size of the list and the second the number of
2052 int *list = (data_block == NULL)?
2053 (int *)(ol->value) :
2054 (int *)((uschar *)data_block + (long int)(ol->value));
2056 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2059 uschar *snext = Ustrchr(s, ':');
2063 while (ss > s && isspace(ss[-1])) ss--;
2066 value = readconf_readtime(s, terminator, FALSE);
2068 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2070 if (count > 1 && value <= list[count])
2071 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2072 "time value out of order for %s", name);
2073 list[count+1] = value;
2074 if (snext == NULL) break;
2076 while (isspace(*s)) s++;
2079 if (count > list[0] - 2)
2080 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2082 if (count > 0 && list[2] == 0) count = 0;
2094 /*************************************************
2095 * Print a time value *
2096 *************************************************/
2099 Argument: a time value in seconds
2100 Returns: pointer to a fixed buffer containing the time as a string,
2101 in readconf_readtime() format
2105 readconf_printtime(int t)
2108 uschar *p = time_buffer;
2125 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2126 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2127 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2128 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2129 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2136 /*************************************************
2137 * Print an individual option value *
2138 *************************************************/
2140 /* This is used by the -bP option, so prints to the standard output.
2141 The entire options list is passed in as an argument, because some options come
2142 in pairs - typically uid/gid settings, which can either be explicit numerical
2143 values, or strings to be expanded later. If the numerical value is unset,
2144 search for "*expand_<name>" to see if there is a string equivalent.
2147 ol option entry, or NULL for an unknown option
2149 options_block NULL for main configuration options; otherwise points to
2150 a driver block; if the option doesn't have opt_public
2151 set, then options_block->options_block is where the item
2153 oltop points to the option list in which ol exists
2154 last one more than the offset of the last entry in optop
2155 no_labels do not show "foo = " at the start.
2161 print_ol(optionlist *ol, uschar *name, void *options_block,
2162 optionlist *oltop, int last, BOOL no_labels)
2175 printf("%s is not a known option\n", name);
2179 /* Non-admin callers cannot see options that have been flagged secure by the
2182 if (!admin_user && (ol->type & opt_secure) != 0)
2184 const char * const hidden = "<value not displayable>";
2186 printf("%s\n", hidden);
2188 printf("%s = %s\n", name, hidden);
2192 /* Else show the value of the option */
2195 if (options_block != NULL)
2197 if ((ol->type & opt_public) == 0)
2198 options_block = (void *)(((driver_instance *)options_block)->options_block);
2199 value = (void *)((uschar *)options_block + (long int)value);
2202 switch(ol->type & opt_mask)
2205 case opt_rewrite: /* Show the text value */
2206 s = *((uschar **)value);
2207 if (!no_labels) printf("%s = ", name);
2208 printf("%s\n", (s == NULL)? US"" : string_printing2(s, FALSE));
2212 if (!no_labels) printf("%s = ", name);
2213 printf("%d\n", *((int *)value));
2218 int x = *((int *)value);
2219 if (x != 0 && (x & 1023) == 0)
2223 if ((x & 1023) == 0)
2228 if (!no_labels) printf("%s = ", name);
2229 printf("%d%c\n", x, c);
2233 if (!no_labels) printf("%s = ", name);
2241 int x = *((int *)value);
2242 if (!no_labels) printf("%s = ", name);
2243 if (x == 0) printf("0\n");
2244 else if ((x & 1023) == 0) printf("%dM\n", x >> 10);
2245 else printf("%dK\n", x);
2250 if (!no_labels) printf("%s = ", name);
2251 printf("%#o\n", *((int *)value));
2254 /* Can be negative only when "unset", in which case integer */
2258 int x = *((int *)value);
2261 if (x < 0) printf("%s =\n", name); else
2263 if (!no_labels) printf("%s = ", name);
2264 printf("%d.", x/1000);
2277 /* If the numerical value is unset, try for the string value */
2279 case opt_expand_uid:
2280 if (! *get_set_flag(name, oltop, last, options_block))
2282 sprintf(CS name2, "*expand_%.50s", name);
2283 ol2 = find_option(name2, oltop, last);
2286 void *value2 = ol2->value;
2287 if (options_block != NULL)
2288 value2 = (void *)((uschar *)options_block + (long int)value2);
2289 s = *((uschar **)value2);
2290 if (!no_labels) printf("%s = ", name);
2291 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2296 /* Else fall through */
2299 if (!no_labels) printf("%s = ", name);
2300 if (! *get_set_flag(name, oltop, last, options_block))
2304 pw = getpwuid(*((uid_t *)value));
2306 printf("%ld\n", (long int)(*((uid_t *)value)));
2307 else printf("%s\n", pw->pw_name);
2311 /* If the numerical value is unset, try for the string value */
2313 case opt_expand_gid:
2314 if (! *get_set_flag(name, oltop, last, options_block))
2316 sprintf(CS name2, "*expand_%.50s", name);
2317 ol2 = find_option(name2, oltop, last);
2318 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2320 void *value2 = ol2->value;
2321 if (options_block != NULL)
2322 value2 = (void *)((uschar *)options_block + (long int)value2);
2323 s = *((uschar **)value2);
2324 if (!no_labels) printf("%s = ", name);
2325 printf("%s\n", (s == NULL)? US"" : string_printing(s));
2330 /* Else fall through */
2333 if (!no_labels) printf("%s = ", name);
2334 if (! *get_set_flag(name, oltop, last, options_block))
2338 gr = getgrgid(*((int *)value));
2340 printf("%ld\n", (long int)(*((int *)value)));
2341 else printf("%s\n", gr->gr_name);
2346 uidlist = *((uid_t **)value);
2347 if (!no_labels) printf("%s =", name);
2348 if (uidlist != NULL)
2352 if (no_labels) sep = '\0';
2353 for (i = 1; i <= (int)(uidlist[0]); i++)
2355 uschar *name = NULL;
2356 pw = getpwuid(uidlist[i]);
2357 if (pw != NULL) name = US pw->pw_name;
2358 if (sep != '\0') printf("%c", sep);
2359 if (name != NULL) printf("%s", name);
2360 else printf("%ld", (long int)(uidlist[i]));
2368 gidlist = *((gid_t **)value);
2369 if (!no_labels) printf("%s =", name);
2370 if (gidlist != NULL)
2374 if (no_labels) sep = '\0';
2375 for (i = 1; i <= (int)(gidlist[0]); i++)
2377 uschar *name = NULL;
2378 gr = getgrgid(gidlist[i]);
2379 if (gr != NULL) name = US gr->gr_name;
2380 if (sep != '\0') printf("%c", sep);
2381 if (name != NULL) printf("%s", name);
2382 else printf("%ld", (long int)(gidlist[i]));
2390 if (!no_labels) printf("%s = ", name);
2391 printf("%s\n", readconf_printtime(*((int *)value)));
2397 int *list = (int *)value;
2398 if (!no_labels) printf("%s = ", name);
2399 for (i = 0; i < list[1]; i++)
2400 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2406 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2410 case opt_expand_bool:
2411 sprintf(CS name2, "*expand_%.50s", name);
2412 ol2 = find_option(name2, oltop, last);
2413 if (ol2 != NULL && ol2->value != NULL)
2415 void *value2 = ol2->value;
2416 if (options_block != NULL)
2417 value2 = (void *)((uschar *)options_block + (long int)value2);
2418 s = *((uschar **)value2);
2421 if (!no_labels) printf("%s = ", name);
2422 printf("%s\n", string_printing(s));
2425 /* s == NULL => string not set; fall through */
2431 case opt_bool_verify:
2433 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2440 /*************************************************
2441 * Print value from main configuration *
2442 *************************************************/
2444 /* This function, called as a result of encountering the -bP option,
2445 causes the value of any main configuration variable to be output if the
2446 second argument is NULL. There are some special values:
2448 all print all main configuration options
2449 configure_file print the name of the configuration file
2450 routers print the routers' configurations
2451 transports print the transports' configuration
2452 authenticators print the authenticators' configuration
2453 macros print the macros' configuration
2454 router_list print a list of router names
2455 transport_list print a list of transport names
2456 authenticator_list print a list of authentication mechanism names
2457 macro_list print a list of macro names
2458 +name print a named list item
2459 local_scan print the local_scan options
2461 If the second argument is not NULL, it must be one of "router", "transport",
2462 "authenticator" or "macro" in which case the first argument identifies the
2463 driver whose options are to be printed.
2466 name option name if type == NULL; else driver name
2467 type NULL or driver type name, as described above
2468 no_labels avoid the "foo = " at the start of an item
2474 readconf_print(uschar *name, uschar *type, BOOL no_labels)
2476 BOOL names_only = FALSE;
2478 optionlist *ol2 = NULL;
2479 driver_instance *d = NULL;
2490 static uschar *types[] = { US"address", US"domain", US"host",
2492 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2493 &hostlist_anchor, &localpartlist_anchor };
2495 for (i = 0; i < 4; i++)
2497 t = tree_search(*(anchors[i]), name+1);
2502 printf("%s\n", ((namedlist_block *)(t->data.ptr))->string);
2504 printf("%slist %s = %s\n", types[i], name+1,
2505 ((namedlist_block *)(t->data.ptr))->string);
2510 printf("no address, domain, host, or local part list called \"%s\" "
2511 "exists\n", name+1);
2516 if (Ustrcmp(name, "configure_file") == 0)
2518 printf("%s\n", CS config_main_filename);
2522 if (Ustrcmp(name, "all") == 0)
2524 for (ol = optionlist_config;
2525 ol < optionlist_config + optionlist_config_size; ol++)
2527 if ((ol->type & opt_hidden) == 0)
2528 print_ol(ol, US ol->name, NULL,
2529 optionlist_config, optionlist_config_size,
2535 if (Ustrcmp(name, "local_scan") == 0)
2537 #ifndef LOCAL_SCAN_HAS_OPTIONS
2538 printf("local_scan() options are not supported\n");
2540 for (ol = local_scan_options;
2541 ol < local_scan_options + local_scan_options_count; ol++)
2543 print_ol(ol, US ol->name, NULL, local_scan_options,
2544 local_scan_options_count, no_labels);
2550 if (Ustrcmp(name, "routers") == 0)
2555 else if (Ustrcmp(name, "transports") == 0)
2557 type = US"transport";
2561 else if (Ustrcmp(name, "authenticators") == 0)
2563 type = US"authenticator";
2567 else if (Ustrcmp(name, "macros") == 0)
2573 else if (Ustrcmp(name, "router_list") == 0)
2580 else if (Ustrcmp(name, "transport_list") == 0)
2582 type = US"transport";
2587 else if (Ustrcmp(name, "authenticator_list") == 0)
2589 type = US"authenticator";
2594 else if (Ustrcmp(name, "macro_list") == 0)
2603 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2604 name, NULL, optionlist_config, optionlist_config_size, no_labels);
2609 /* Handle the options for a router or transport. Skip options that are flagged
2610 as hidden. Some of these are options with names starting with '*', used for
2611 internal alternative representations of other options (which the printing
2612 function will sort out). Others are synonyms kept for backward compatibility.
2615 if (Ustrcmp(type, "router") == 0)
2617 d = (driver_instance *)routers;
2618 ol2 = optionlist_routers;
2619 size = optionlist_routers_size;
2621 else if (Ustrcmp(type, "transport") == 0)
2623 d = (driver_instance *)transports;
2624 ol2 = optionlist_transports;
2625 size = optionlist_transports_size;
2627 else if (Ustrcmp(type, "authenticator") == 0)
2629 d = (driver_instance *)auths;
2630 ol2 = optionlist_auths;
2631 size = optionlist_auths_size;
2634 else if (Ustrcmp(type, "macro") == 0)
2636 /* People store passwords in macros and they were previously not available
2637 for printing. So we have an admin_users restriction. */
2640 fprintf(stderr, "exim: permission denied\n");
2643 for (m = macros; m != NULL; m = m->next)
2645 if (name == NULL || Ustrcmp(name, m->name) == 0)
2648 printf("%s\n", CS m->name);
2650 printf("%s=%s\n", CS m->name, CS m->replacement);
2656 printf("%s %s not found\n", type, name);
2662 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2666 /* Either search for a given driver, or print all of them */
2668 for (; d != NULL; d = d->next)
2671 printf("\n%s %s:\n", d->name, type);
2672 else if (Ustrcmp(d->name, name) != 0) continue;
2674 for (ol = ol2; ol < ol2 + size; ol++)
2676 if ((ol->type & opt_hidden) == 0)
2677 print_ol(ol, US ol->name, d, ol2, size, no_labels);
2680 for (ol = d->info->options;
2681 ol < d->info->options + *(d->info->options_count); ol++)
2683 if ((ol->type & opt_hidden) == 0)
2684 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count), no_labels);
2686 if (name != NULL) return;
2688 if (name != NULL) printf("%s %s not found\n", type, name);
2693 /*************************************************
2694 * Read a named list item *
2695 *************************************************/
2697 /* This function reads a name and a list (i.e. string). The name is used to
2698 save the list in a tree, sorted by its name. Each entry also has a number,
2699 which can be used for caching tests, but if the string contains any expansion
2700 items other than $key, the number is set negative to inhibit caching. This
2701 mechanism is used for domain, host, and address lists that are referenced by
2705 anchorp points to the tree anchor
2706 numberp points to the current number for this tree
2707 max the maximum number permitted
2708 s the text of the option line, starting immediately after the name
2710 tname the name of the list type, for messages
2716 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2719 BOOL forcecache = FALSE;
2722 namedlist_block *nb = store_get(sizeof(namedlist_block));
2724 if (Ustrncmp(s, "_cache", 6) == 0)
2731 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2733 if (*numberp >= max)
2734 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2737 while (isspace(*s)) s++;
2739 while (isalnum(*s) || *s == '_') s++;
2740 t = store_get(sizeof(tree_node) + s-ss);
2741 Ustrncpy(t->name, ss, s-ss);
2743 while (isspace(*s)) s++;
2745 if (!tree_insertnode(anchorp, t))
2746 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2747 "duplicate name \"%s\" for a named %s", t->name, tname);
2750 nb->number = *numberp;
2753 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2754 "missing '=' after \"%s\"", t->name);
2755 while (isspace(*s)) s++;
2756 nb->string = read_string(s, t->name);
2757 nb->cache_data = NULL;
2759 /* Check the string for any expansions; if any are found, mark this list
2760 uncacheable unless the user has explicited forced caching. */
2762 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2768 /*************************************************
2769 * Unpick data for a rate limit *
2770 *************************************************/
2772 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2776 s string, in the form t,b,f,l
2777 where t is the threshold (integer)
2778 b is the initial delay (time)
2779 f is the multiplicative factor (fixed point)
2780 k is the maximum time (time)
2781 threshold where to store threshold
2782 base where to store base in milliseconds
2783 factor where to store factor in milliseconds
2784 limit where to store limit
2786 Returns: nothing (panics on error)
2790 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2793 uschar bstring[16], lstring[16];
2795 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2796 factor, lstring) == 4)
2798 *base = readconf_readtime(bstring, 0, TRUE);
2799 *limit = readconf_readtime(lstring, 0, TRUE);
2800 if (*base >= 0 && *limit >= 0) return;
2802 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2808 /*************************************************
2809 * Drop privs for checking TLS config *
2810 *************************************************/
2812 /* We want to validate TLS options during readconf, but do not want to be
2813 root when we call into the TLS library, in case of library linkage errors
2814 which cause segfaults; before this check, those were always done as the Exim
2815 runtime user and it makes sense to continue with that.
2817 Assumes: tls_require_ciphers has been set, if it will be
2818 exim_user has been set, if it will be
2819 exim_group has been set, if it will be
2821 Returns: bool for "okay"; false will cause caller to immediately exit.
2826 tls_dropprivs_validate_require_cipher(void)
2828 const uschar *errmsg;
2831 void (*oldsignal)(int);
2833 oldsignal = signal(SIGCHLD, SIG_DFL);
2836 if ((pid = fork()) < 0)
2837 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2841 /* in some modes, will have dropped privilege already */
2843 exim_setugid(exim_uid, exim_gid, FALSE,
2844 US"calling tls_validate_require_cipher");
2846 errmsg = tls_validate_require_cipher();
2849 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2850 "tls_require_ciphers invalid: %s", errmsg);
2857 rc = waitpid(pid, &status, 0);
2858 } while (rc < 0 && errno == EINTR);
2861 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2864 signal(SIGCHLD, oldsignal);
2868 #endif /* SUPPORT_TLS */
2873 /*************************************************
2874 * Read main configuration options *
2875 *************************************************/
2877 /* This function is the first to be called for configuration reading. It
2878 opens the configuration file and reads general configuration settings until
2879 it reaches the end of the configuration section. The file is then left open so
2880 that the remaining configuration data can subsequently be read if needed for
2883 The configuration file must be owned either by root or exim, and be writeable
2884 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2885 in the config file, so the test is done on the compiled in values. A slight
2886 anomaly, to be carefully documented.
2888 The name of the configuration file is taken from a list that is included in the
2889 binary of Exim. It can be altered from the command line, but if that is done,
2890 root privilege is immediately withdrawn unless the caller is root or exim.
2891 The first file on the list that exists is used.
2893 For use on multiple systems that share file systems, first look for a
2894 configuration file whose name has the current node name on the end. If that is
2895 not found, try the generic name. For really contorted configurations, that run
2896 multiple Exims with different uid settings, first try adding the effective uid
2897 before the node name. These complications are going to waste resources on most
2898 systems. Therefore they are available only when requested by compile-time
2905 struct stat statbuf;
2906 uschar *s, *filename;
2907 uschar *list = config_main_filelist;
2909 /* Loop through the possible file names */
2911 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2914 /* Cut out all the fancy processing unless specifically wanted */
2916 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2917 uschar *suffix = filename + Ustrlen(filename);
2919 /* Try for the node-specific file if a node name exists */
2921 #ifdef CONFIGURE_FILE_USE_NODE
2923 if (uname(&uts) >= 0)
2925 #ifdef CONFIGURE_FILE_USE_EUID
2926 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2927 config_file = Ufopen(filename, "rb");
2928 if (config_file == NULL)
2929 #endif /* CONFIGURE_FILE_USE_EUID */
2931 sprintf(CS suffix, ".%.256s", uts.nodename);
2932 config_file = Ufopen(filename, "rb");
2935 #endif /* CONFIGURE_FILE_USE_NODE */
2937 /* Otherwise, try the generic name, possibly with the euid added */
2939 #ifdef CONFIGURE_FILE_USE_EUID
2940 if (config_file == NULL)
2942 sprintf(CS suffix, ".%ld", (long int)original_euid);
2943 config_file = Ufopen(filename, "rb");
2945 #endif /* CONFIGURE_FILE_USE_EUID */
2947 /* Finally, try the unadorned name */
2949 if (config_file == NULL)
2952 config_file = Ufopen(filename, "rb");
2954 #else /* if neither defined */
2956 /* This is the common case when the fancy processing is not included. */
2958 config_file = Ufopen(filename, "rb");
2961 /* If the file does not exist, continue to try any others. For any other
2962 error, break out (and die). */
2964 if (config_file != NULL || errno != ENOENT) break;
2967 /* On success, save the name for verification; config_filename is used when
2968 logging configuration errors (it changes for .included files) whereas
2969 config_main_filename is the name shown by -bP. Failure to open a configuration
2970 file is a serious disaster. */
2972 if (config_file != NULL)
2974 config_filename = config_main_filename = string_copy(filename);
2978 if (filename == NULL)
2979 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2980 "%s", config_main_filelist);
2982 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2983 "configuration file %s", filename));
2986 /* Check the status of the file we have opened, if we have retained root
2987 privileges and the file isn't /dev/null (which *should* be 0666). */
2989 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
2991 if (fstat(fileno(config_file), &statbuf) != 0)
2992 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2995 if ((statbuf.st_uid != root_uid /* owner not root */
2996 #ifdef CONFIGURE_OWNER
2997 && statbuf.st_uid != config_uid /* owner not the special one */
3000 (statbuf.st_gid != root_gid /* group not root & */
3001 #ifdef CONFIGURE_GROUP
3002 && statbuf.st_gid != config_gid /* group not the special one */
3004 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3006 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3009 "wrong owner, group, or mode", big_buffer);
3012 /* Process the main configuration settings. They all begin with a lower case
3013 letter. If we see something starting with an upper case letter, it is taken as
3014 a macro definition. */
3016 while ((s = get_config_line()) != NULL)
3018 if (isupper(s[0])) read_macro_assignment(s);
3020 else if (Ustrncmp(s, "domainlist", 10) == 0)
3021 read_named_list(&domainlist_anchor, &domainlist_count,
3022 MAX_NAMED_LIST, s+10, US"domain list");
3024 else if (Ustrncmp(s, "hostlist", 8) == 0)
3025 read_named_list(&hostlist_anchor, &hostlist_count,
3026 MAX_NAMED_LIST, s+8, US"host list");
3028 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3029 read_named_list(&addresslist_anchor, &addresslist_count,
3030 MAX_NAMED_LIST, s+11, US"address list");
3032 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3033 read_named_list(&localpartlist_anchor, &localpartlist_count,
3034 MAX_NAMED_LIST, s+13, US"local part list");
3037 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3038 NULL, US"main option \"%s\" unknown");
3042 /* If local_sender_retain is set, local_from_check must be unset. */
3044 if (local_sender_retain && local_from_check)
3045 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3046 "local_sender_retain are set; this combination is not allowed");
3048 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3051 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3053 /* The max retry interval must not be greater than 24 hours. */
3055 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3057 /* remote_max_parallel must be > 0 */
3059 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3061 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3062 start of a new SMTP message. */
3064 freeze_tell_config = freeze_tell;
3066 /* The primary host name may be required for expansion of spool_directory
3067 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3068 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3069 canonize it. Some people like upper case letters in their host names, so we
3070 don't force the case. */
3072 if (primary_hostname == NULL)
3076 if (uname(&uts) < 0)
3077 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3078 hostname = US uts.nodename;
3080 if (Ustrchr(hostname, '.') == NULL)
3083 struct hostent *hostdata;
3086 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3087 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3097 #if HAVE_GETIPNODEBYNAME
3099 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3101 hostdata = gethostbyname2(CS hostname, af);
3104 hostdata = gethostbyname(CS hostname);
3107 if (hostdata != NULL)
3109 hostname = US hostdata->h_name;
3113 if (af == AF_INET) break;
3118 primary_hostname = string_copy(hostname);
3121 /* Set up default value for smtp_active_hostname */
3123 smtp_active_hostname = primary_hostname;
3125 /* If spool_directory wasn't set in the build-time configuration, it must have
3126 got set above. Of course, writing to the log may not work if log_file_path is
3127 not set, but it will at least get to syslog or somewhere, with any luck. */
3129 if (*spool_directory == 0)
3130 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3133 /* Expand the spool directory name; it may, for example, contain the primary
3134 host name. Same comment about failure. */
3136 s = expand_string(spool_directory);
3138 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3139 "\"%s\": %s", spool_directory, expand_string_message);
3140 spool_directory = s;
3142 /* Expand log_file_path, which must contain "%s" in any component that isn't
3143 the null string or "syslog". It is also allowed to contain one instance of %D
3144 or %M. However, it must NOT contain % followed by anything else. */
3146 if (*log_file_path != 0)
3149 int sep = ':'; /* Fixed for log file path */
3150 s = expand_string(log_file_path);
3152 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3153 "\"%s\": %s", log_file_path, expand_string_message);
3156 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3159 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3160 t = Ustrstr(sss, "%s");
3162 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3163 "contain \"%%s\"", sss);
3165 t = Ustrchr(sss, '%');
3168 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3169 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3170 "unexpected \"%%\" character", s);
3177 /* Interpret syslog_facility into an integer argument for 'ident' param to
3178 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3181 if (syslog_facility_str != NULL)
3184 uschar *s = syslog_facility_str;
3186 if ((Ustrlen(syslog_facility_str) >= 4) &&
3187 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3190 for (i = 0; i < syslog_list_size; i++)
3192 if (strcmpic(s, syslog_list[i].name) == 0)
3194 syslog_facility = syslog_list[i].value;
3199 if (i >= syslog_list_size)
3201 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3202 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3206 /* Expand pid_file_path */
3208 if (*pid_file_path != 0)
3210 s = expand_string(pid_file_path);
3212 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3213 "\"%s\": %s", pid_file_path, expand_string_message);
3217 /* Set default value of process_log_path */
3219 if (process_log_path == NULL || *process_log_path =='\0')
3220 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3222 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3225 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3227 /* Unpick the SMTP rate limiting options, if set */
3229 if (smtp_ratelimit_mail != NULL)
3231 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3232 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3235 if (smtp_ratelimit_rcpt != NULL)
3237 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3238 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3241 /* The qualify domains default to the primary host name */
3243 if (qualify_domain_sender == NULL)
3244 qualify_domain_sender = primary_hostname;
3245 if (qualify_domain_recipient == NULL)
3246 qualify_domain_recipient = qualify_domain_sender;
3248 /* Setting system_filter_user in the configuration sets the gid as well if a
3249 name is given, but a numerical value does not. */
3251 if (system_filter_uid_set && !system_filter_gid_set)
3253 struct passwd *pw = getpwuid(system_filter_uid);
3255 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3256 (long int)system_filter_uid);
3257 system_filter_gid = pw->pw_gid;
3258 system_filter_gid_set = TRUE;
3261 /* If the errors_reply_to field is set, check that it is syntactically valid
3262 and ensure it contains a domain. */
3264 if (errors_reply_to != NULL)
3267 int start, end, domain;
3268 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3269 &start, &end, &domain, FALSE);
3271 if (recipient == NULL)
3272 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3273 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3276 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3277 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3280 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3281 smtp_accept_max must also be set. */
3283 if (smtp_accept_max == 0 &&
3284 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3285 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3286 "smtp_accept_max must be set if smtp_accept_queue or "
3287 "smtp_accept_max_per_host is set");
3289 /* Set up the host number if anything is specified. It is an expanded string
3290 so that it can be computed from the host name, for example. We do this last
3291 so as to ensure that everything else is set up before the expansion. */
3293 if (host_number_string != NULL)
3297 uschar *s = expand_string(host_number_string);
3299 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3300 "failed to expand localhost_number \"%s\": %s",
3301 host_number_string, expand_string_message);
3302 n = Ustrtol(s, &end, 0);
3303 while (isspace(*end)) end++;
3305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3306 "localhost_number value is not a number: %s", s);
3307 if (n > LOCALHOST_MAX)
3308 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3309 "localhost_number is greater than the maximum allowed value (%d)",
3315 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3317 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3318 tls_verify_certificates == NULL)
3319 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3320 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3321 (tls_verify_hosts != NULL)? "" : "try_");
3323 /* This also checks that the library linkage is working and we can call
3324 routines in it, so call even if tls_require_ciphers is unset */
3325 if (!tls_dropprivs_validate_require_cipher())
3328 /* Magic number: at time of writing, 1024 has been the long-standing value
3329 used by so many clients, and what Exim used to use always, that it makes
3330 sense to just min-clamp this max-clamp at that. */
3331 if (tls_dh_max_bits < 1024)
3332 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3333 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3335 /* If openssl_options is set, validate it */
3336 if (openssl_options != NULL)
3339 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3340 "openssl_options is set but we're using GnuTLS");
3343 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3344 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3345 "openssl_options parse error: %s", openssl_options);
3353 /*************************************************
3354 * Initialize one driver *
3355 *************************************************/
3357 /* This is called once the driver's generic options, if any, have been read.
3358 We can now find the driver, set up defaults for the private options, and
3359 unset any "set" bits in the private options table (which might have been
3360 set by another incarnation of the same driver).
3363 d pointer to driver instance block, with generic
3365 drivers_available vector of available drivers
3366 size_of_info size of each block in drivers_available
3367 class class of driver, for error message
3369 Returns: pointer to the driver info block
3372 static driver_info *
3373 init_driver(driver_instance *d, driver_info *drivers_available,
3374 int size_of_info, uschar *class)
3378 for (dd = drivers_available; dd->driver_name[0] != 0;
3379 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3381 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3384 int len = dd->options_len;
3386 d->options_block = store_get(len);
3387 memcpy(d->options_block, dd->options_block, len);
3388 for (i = 0; i < *(dd->options_count); i++)
3389 dd->options[i].type &= ~opt_set;
3394 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3395 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3397 return NULL; /* never obeyed */
3403 /*************************************************
3404 * Initialize driver list *
3405 *************************************************/
3407 /* This function is called for routers, transports, and authentication
3408 mechanisms. It reads the data from the current point in the configuration file
3409 up to the end of the section, and sets up a chain of instance blocks according
3410 to the file's contents. The file will already have been opened by a call to
3411 readconf_main, and must be left open for subsequent reading of further data.
3413 Any errors cause a panic crash. Note that the blocks with names driver_info and
3414 driver_instance must map the first portions of all the _info and _instance
3415 blocks for this shared code to work.
3418 class "router", "transport", or "authenticator"
3419 anchor &routers, &transports, &auths
3420 drivers_available available drivers
3421 size_of_info size of each info block
3422 instance_default points to default data for an instance
3423 instance_size size of instance block
3424 driver_optionlist generic option list
3425 driver_optionlist_count count of generic option list
3431 readconf_driver_init(
3433 driver_instance **anchor,
3434 driver_info *drivers_available,
3436 void *instance_default,
3438 optionlist *driver_optionlist,
3439 int driver_optionlist_count)
3441 driver_instance **p = anchor;
3442 driver_instance *d = NULL;
3445 while ((buffer = get_config_line()) != NULL)
3450 /* Read the first name on the line and test for the start of a new driver. A
3451 macro definition indicates the end of the previous driver. If this isn't the
3452 start of a new driver, the line will be re-read. */
3454 s = readconf_readname(name, sizeof(name), buffer);
3456 /* Handle macro definition, first finishing off the initialization of the
3457 previous driver, if any. */
3459 if (isupper(*name) && *s == '=')
3463 if (d->driver_name == NULL)
3464 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3465 "no driver defined for %s \"%s\"", class, d->name);
3469 read_macro_assignment(buffer);
3473 /* If the line starts with a name terminated by a colon, we are at the
3474 start of the definition of a new driver. The rest of the line must be
3481 /* Finish off initializing the previous driver. */
3485 if (d->driver_name == NULL)
3486 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3487 "no driver defined for %s \"%s\"", class, d->name);
3491 /* Check that we haven't already got a driver of this name */
3493 for (d = *anchor; d != NULL; d = d->next)
3494 if (Ustrcmp(name, d->name) == 0)
3495 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3496 "there are two %ss called \"%s\"", class, name);
3498 /* Set up a new driver instance data block on the chain, with
3499 its default values installed. */
3501 d = store_get(instance_size);
3502 memcpy(d, instance_default, instance_size);
3505 d->name = string_copy(name);
3507 /* Clear out the "set" bits in the generic options */
3509 for (i = 0; i < driver_optionlist_count; i++)
3510 driver_optionlist[i].type &= ~opt_set;
3512 /* Check nothing more on this line, then do the next loop iteration. */
3514 while (isspace(*s)) s++;
3515 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3519 /* Not the start of a new driver. Give an error if we have not set up a
3520 current driver yet. */
3522 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3523 "%s name missing", class);
3525 /* First look to see if this is a generic option; if it is "driver",
3526 initialize the driver. If is it not a generic option, we can look for a
3527 private option provided that the driver has been previously set up. */
3529 if (readconf_handle_option(buffer, driver_optionlist,
3530 driver_optionlist_count, d, NULL))
3532 if (d->info == NULL && d->driver_name != NULL)
3533 init_driver(d, drivers_available, size_of_info, class);
3536 /* Handle private options - pass the generic block because some may
3537 live therein. A flag with each option indicates if it is in the public
3540 else if (d->info != NULL)
3542 readconf_handle_option(buffer, d->info->options,
3543 *(d->info->options_count), d, US"option \"%s\" unknown");
3546 /* The option is not generic and the driver name has not yet been given. */
3548 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3549 "(\"driver\" must be specified before any private options)", name);
3552 /* Run the initialization function for the final driver. */
3556 if (d->driver_name == NULL)
3557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3558 "no driver defined for %s \"%s\"", class, d->name);
3565 /*************************************************
3566 * Check driver dependency *
3567 *************************************************/
3569 /* This function is passed a driver instance and a string. It checks whether
3570 any of the string options for the driver contains the given string as an
3574 d points to a driver instance block
3575 s the string to search for
3577 Returns: TRUE if a dependency is found
3581 readconf_depends(driver_instance *d, uschar *s)
3583 int count = *(d->info->options_count);
3587 for (ol = d->info->options; ol < d->info->options + count; ol++)
3589 void *options_block;
3591 int type = ol->type & opt_mask;
3592 if (type != opt_stringptr) continue;
3593 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3594 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3595 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3597 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3598 isalnum(ss[Ustrlen(s)])) continue;
3599 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3600 d->name, ol->name, s);
3605 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3612 /*************************************************
3613 * Decode an error type for retries *
3614 *************************************************/
3616 /* This function is global because it is also called from the main
3617 program when testing retry information. It decodes strings such as "quota_7d"
3618 into numerical error codes.
3621 pp points to start of text
3622 p points past end of text
3623 basic_errno points to an int to receive the main error number
3624 more_errno points to an int to receive the secondary error data
3626 Returns: NULL if decoded correctly; else points to error text
3630 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3634 while (q < p && *q != '_') q++;
3637 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3639 *basic_errno = ERRNO_EXIMQUOTA;
3640 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3641 return US"bad time value";
3644 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3646 *basic_errno = ECONNREFUSED;
3649 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3650 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3651 else return US"A or MX expected after \"refused\"";
3655 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3657 *basic_errno = ETIMEDOUT;
3661 int xlen = p - q - 1;
3664 static uschar *extras[] =
3665 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3666 static int values[] =
3667 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3669 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3671 if (strncmpic(x, extras[i], xlen) == 0)
3673 *more_errno = values[i];
3678 if (i >= sizeof(extras)/sizeof(uschar *))
3680 if (strncmpic(x, US"DNS", xlen) == 0)
3682 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3683 "available in retry rules (it has never worked) - treated as "
3686 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3691 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3692 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3693 strncmpic(pp, US"data_4", 6) == 0)
3696 int x = 255; /* means "any 4xx code" */
3697 if (p != pp + 8) bad = TRUE; else
3699 int a = pp[6], b = pp[7];
3703 if (isdigit(b)) x += b - '0';
3704 else if (b == 'x') x += 100;
3707 else if (a != 'x' || b != 'x') bad = TRUE;
3711 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3712 "x is literal and d is any digit", pp);
3714 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3715 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3716 *more_errno = x << 8;
3719 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3720 strncmpic(q+1, US"failed", p-q-1) == 0)
3721 *basic_errno = ERRNO_AUTHFAIL;
3723 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3724 *basic_errno = ERRNO_SMTPCLOSED;
3726 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3727 *basic_errno = ERRNO_TLSREQUIRED;
3729 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3730 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3738 /*************************************************
3739 * Read retry information *
3740 *************************************************/
3742 /* Each line of retry information contains:
3744 . A domain name pattern or an address pattern;
3746 . An error name, possibly with additional data, or *;
3748 . An optional sequence of retry items, each consisting of an identifying
3749 letter, a cutoff time, and optional parameters.
3751 All this is decoded and placed into a control block. */
3754 /* Subroutine to read an argument, preceded by a comma and terminated
3755 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3756 1 = fixed point number (returned *1000).
3759 paddr pointer to pointer to current character; updated
3760 type 0 => read a time; 1 => read a fixed point number
3762 Returns: time in seconds or fixed point number * 1000
3766 retry_arg(uschar **paddr, int type)
3771 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3773 while (isspace(*p)) p++;
3775 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3777 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3778 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3784 return readconf_readtime(pp, *p, FALSE);
3786 return readconf_readfixed(pp, *p);
3788 return 0; /* Keep picky compilers happy */
3791 /* The function proper */
3794 readconf_retries(void)
3796 retry_config **chain = &retries;
3800 while ((p = get_config_line()) != NULL)
3802 retry_rule **rchain;
3805 next = store_get(sizeof(retry_config));
3808 chain = &(next->next);
3809 next->basic_errno = next->more_errno = 0;
3810 next->senders = NULL;
3812 rchain = &(next->rules);
3814 next->pattern = string_dequote(&p);
3815 while (isspace(*p)) p++;
3817 while (mac_isgraph(*p)) p++;
3818 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3819 "missing error type");
3821 /* Test error names for things we understand. */
3823 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3824 &(next->more_errno))) != NULL)
3825 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3827 /* There may be an optional address list of senders to be used as another
3828 constraint on the rule. This was added later, so the syntax is a bit of a
3829 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3832 while (isspace(*p)) p++;
3833 if (Ustrncmp(p, "senders", 7) == 0)
3836 while (isspace(*p)) p++;
3837 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3838 "\"=\" expected after \"senders\" in retry rule");
3839 while (isspace(*p)) p++;
3840 next->senders = string_dequote(&p);
3843 /* Now the retry rules. Keep the maximum timeout encountered. */
3845 while (isspace(*p)) p++;
3849 retry_rule *rule = store_get(sizeof(retry_rule));
3851 rchain = &(rule->next);
3853 rule->rule = toupper(*p++);
3854 rule->timeout = retry_arg(&p, 0);
3855 if (rule->timeout > retry_maximum_timeout)
3856 retry_maximum_timeout = rule->timeout;
3860 case 'F': /* Fixed interval */
3861 rule->p1 = retry_arg(&p, 0);
3864 case 'G': /* Geometrically increasing intervals */
3865 case 'H': /* Ditto, but with randomness */
3866 rule->p1 = retry_arg(&p, 0);
3867 rule->p2 = retry_arg(&p, 1);
3871 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3875 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3876 (rule->rule != 'F' && rule->p2 < 1000))
3877 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3878 "bad parameters for retry rule");
3880 while (isspace(*p)) p++;
3884 while (isspace(*p)) p++;
3887 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3894 /*************************************************
3895 * Initialize authenticators *
3896 *************************************************/
3898 /* Read the authenticators section of the configuration file.
3907 auth_instance *au, *bu;
3908 readconf_driver_init(US"authenticator",
3909 (driver_instance **)(&auths), /* chain anchor */
3910 (driver_info *)auths_available, /* available drivers */
3911 sizeof(auth_info), /* size of info block */
3912 &auth_defaults, /* default values for generic options */
3913 sizeof(auth_instance), /* size of instance block */
3914 optionlist_auths, /* generic options */
3915 optionlist_auths_size);
3917 for (au = auths; au != NULL; au = au->next)
3919 if (au->public_name == NULL)
3920 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3921 "the %s authenticator", au->name);
3922 for (bu = au->next; bu != NULL; bu = bu->next)
3924 if (strcmpic(au->public_name, bu->public_name) == 0)
3926 if ((au->client && bu->client) || (au->server && bu->server))
3927 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3928 "(%s and %s) have the same public name (%s)",
3929 (au->client)? US"client" : US"server", au->name, bu->name,
3939 /*************************************************
3940 * Read ACL information *
3941 *************************************************/
3943 /* If this run of Exim is not doing something that involves receiving a
3944 message, we can just skip over the ACL information. No need to parse it.
3946 First, we have a function for acl_read() to call back to get the next line. We
3947 need to remember the line we passed, because at the end it will contain the
3948 name of the next ACL. */
3950 static uschar *acl_line;
3955 acl_line = get_config_line();
3960 /* Now the main function:
3963 skip TRUE when this Exim process is doing something that will
3964 not need the ACL data
3970 readconf_acl(BOOL skip)
3974 /* Not receiving messages, don't need to parse the ACL data */
3978 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3979 while ((p = get_config_line()) != NULL);
3983 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3986 acl_line = get_config_line();
3988 while(acl_line != NULL)
3994 p = readconf_readname(name, sizeof(name), acl_line);
3995 if (isupper(*name) && *p == '=')
3997 read_macro_assignment(acl_line);
3998 acl_line = get_config_line();
4002 if (*p != ':' || name[0] == 0)
4003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4005 node = store_get(sizeof(tree_node) + Ustrlen(name));
4006 Ustrcpy(node->name, name);
4007 if (!tree_insertnode(&acl_anchor, node))
4008 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4009 "there are two ACLs called \"%s\"", name);
4011 node->data.ptr = acl_read(acl_callback, &error);
4013 if (node->data.ptr == NULL && error != NULL)
4014 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4020 /*************************************************
4021 * Read configuration for local_scan() *
4022 *************************************************/
4024 /* This function is called after "begin local_scan" is encountered in the
4025 configuration file. If the local_scan() function allows for configuration
4026 options, we can process them. Otherwise, we expire in a panic.
4033 local_scan_init(void)
4035 #ifndef LOCAL_SCAN_HAS_OPTIONS
4036 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4037 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4041 while ((p = get_config_line()) != NULL)
4043 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4044 NULL, US"local_scan option \"%s\" unknown");
4051 /*************************************************
4052 * Read rest of configuration (after main) *
4053 *************************************************/
4055 /* This function reads the rest of the runtime configuration, after the main
4056 configuration. It is called only when actually needed. Each subsequent section
4057 of the configuration starts with a line of the form
4061 where the name is "routers", "transports", etc. A section is terminated by
4062 hitting the next "begin" line, and the next name is left in next_section.
4063 Because it may confuse people as to whether the names are singular or plural,
4064 we add "s" if it's missing. There is always enough room in next_section for
4065 this. This function is basically just a switch.
4068 skip_acl TRUE if ACL information is not needed
4073 static uschar *section_list[] = {
4083 readconf_rest(BOOL skip_acl)
4087 while(next_section[0] != 0)
4091 int last = sizeof(section_list) / sizeof(uschar *);
4093 int n = Ustrlen(next_section);
4095 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4099 int c = strcmpic(next_section, section_list[mid]);
4101 if (c > 0) first = mid + 1; else last = mid;
4103 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4104 "\"%.*s\" is not a known configuration section name", n, next_section);
4105 mid = (last + first)/2;
4109 if (((had ^= bit) & bit) == 0)
4110 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4111 "\"%.*s\" section is repeated in the configuration file", n,
4116 case 0: readconf_acl(skip_acl); break;
4117 case 1: auths_init(); break;
4118 case 2: local_scan_init(); break;
4119 case 3: readconf_retries(); break;
4120 case 4: readconf_rewrites(); break;
4121 case 5: route_init(); break;
4122 case 6: transport_init(); break;
4126 (void)fclose(config_file);
4129 /* End of readconf.c */