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 { "add_environment", opt_stringptr, &add_environment },
163 { "admin_groups", opt_gidlist, &admin_groups },
164 { "allow_domain_literals", opt_bool, &allow_domain_literals },
165 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
166 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
167 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
168 { "auto_thaw", opt_time, &auto_thaw },
169 #ifdef WITH_CONTENT_SCAN
170 { "av_scanner", opt_stringptr, &av_scanner },
172 { "bi_command", opt_stringptr, &bi_command },
173 #ifdef EXPERIMENTAL_BRIGHTMAIL
174 { "bmi_config_file", opt_stringptr, &bmi_config_file },
176 { "bounce_message_file", opt_stringptr, &bounce_message_file },
177 { "bounce_message_text", opt_stringptr, &bounce_message_text },
178 { "bounce_return_body", opt_bool, &bounce_return_body },
179 { "bounce_return_message", opt_bool, &bounce_return_message },
180 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
181 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
182 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
183 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
184 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
185 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
186 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
187 { "check_log_inodes", opt_int, &check_log_inodes },
188 { "check_log_space", opt_Kint, &check_log_space },
189 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
190 { "check_spool_inodes", opt_int, &check_spool_inodes },
191 { "check_spool_space", opt_Kint, &check_spool_space },
192 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
193 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
194 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
195 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
196 #ifdef EXPERIMENTAL_DCC
197 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
198 { "dccifd_address", opt_stringptr, &dccifd_address },
199 { "dccifd_options", opt_stringptr, &dccifd_options },
201 { "delay_warning", opt_timelist, &delay_warning },
202 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
203 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
204 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
205 { "delivery_date_remove", opt_bool, &delivery_date_remove },
206 #ifdef ENABLE_DISABLE_FSYNC
207 { "disable_fsync", opt_bool, &disable_fsync },
209 { "disable_ipv6", opt_bool, &disable_ipv6 },
211 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
213 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
214 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
215 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
216 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
217 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
218 { "dns_retrans", opt_time, &dns_retrans },
219 { "dns_retry", opt_int, &dns_retry },
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 /* These three gnutls_require_* options stopped working in Exim 4.80 */
240 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
241 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
242 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
244 { "header_line_maxsize", opt_int, &header_line_maxsize },
245 { "header_maxsize", opt_int, &header_maxsize },
246 { "headers_charset", opt_stringptr, &headers_charset },
247 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
248 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
249 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
250 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
251 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
252 { "hold_domains", opt_stringptr, &hold_domains },
253 { "host_lookup", opt_stringptr, &host_lookup },
254 { "host_lookup_order", opt_stringptr, &host_lookup_order },
255 { "host_reject_connection", opt_stringptr, &host_reject_connection },
256 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
257 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
259 { "ibase_servers", opt_stringptr, &ibase_servers },
261 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
262 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
263 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
264 { "keep_environment", opt_stringptr, &keep_environment },
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_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
2160 print_ol(optionlist *ol, uschar *name, void *options_block,
2161 optionlist *oltop, int last)
2174 printf("%s is not a known option\n", name);
2178 /* Non-admin callers cannot see options that have been flagged secure by the
2181 if (!admin_user && (ol->type & opt_secure) != 0)
2183 printf("%s = <value not displayable>\n", name);
2187 /* Else show the value of the option */
2190 if (options_block != NULL)
2192 if ((ol->type & opt_public) == 0)
2193 options_block = (void *)(((driver_instance *)options_block)->options_block);
2194 value = (void *)((uschar *)options_block + (long int)value);
2197 switch(ol->type & opt_mask)
2200 case opt_rewrite: /* Show the text value */
2201 s = *((uschar **)value);
2202 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2206 printf("%s = %d\n", name, *((int *)value));
2211 int x = *((int *)value);
2212 if (x != 0 && (x & 1023) == 0)
2216 if ((x & 1023) == 0)
2221 printf("%s = %d%c\n", name, x, c);
2223 else printf("%s = %d\n", name, x);
2229 int x = *((int *)value);
2230 if (x == 0) printf("%s = 0\n", name);
2231 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2232 else printf("%s = %dK\n", name, x);
2237 printf("%s = %#o\n", name, *((int *)value));
2240 /* Can be negative only when "unset", in which case integer */
2244 int x = *((int *)value);
2247 if (x < 0) printf("%s =\n", name); else
2249 printf("%s = %d.", name, x/1000);
2262 /* If the numerical value is unset, try for the string value */
2264 case opt_expand_uid:
2265 if (! *get_set_flag(name, oltop, last, options_block))
2267 sprintf(CS name2, "*expand_%.50s", name);
2268 ol2 = find_option(name2, oltop, last);
2271 void *value2 = ol2->value;
2272 if (options_block != NULL)
2273 value2 = (void *)((uschar *)options_block + (long int)value2);
2274 s = *((uschar **)value2);
2275 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2280 /* Else fall through */
2283 if (! *get_set_flag(name, oltop, last, options_block))
2284 printf("%s =\n", name);
2287 pw = getpwuid(*((uid_t *)value));
2289 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2290 else printf("%s = %s\n", name, pw->pw_name);
2294 /* If the numerical value is unset, try for the string value */
2296 case opt_expand_gid:
2297 if (! *get_set_flag(name, oltop, last, options_block))
2299 sprintf(CS name2, "*expand_%.50s", name);
2300 ol2 = find_option(name2, oltop, last);
2301 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2303 void *value2 = ol2->value;
2304 if (options_block != NULL)
2305 value2 = (void *)((uschar *)options_block + (long int)value2);
2306 s = *((uschar **)value2);
2307 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2312 /* Else fall through */
2315 if (! *get_set_flag(name, oltop, last, options_block))
2316 printf("%s =\n", name);
2319 gr = getgrgid(*((int *)value));
2321 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2322 else printf("%s = %s\n", name, gr->gr_name);
2327 uidlist = *((uid_t **)value);
2328 printf("%s =", name);
2329 if (uidlist != NULL)
2333 for (i = 1; i <= (int)(uidlist[0]); i++)
2335 uschar *name = NULL;
2336 pw = getpwuid(uidlist[i]);
2337 if (pw != NULL) name = US pw->pw_name;
2338 if (name != NULL) printf("%c%s", sep, name);
2339 else printf("%c%ld", sep, (long int)(uidlist[i]));
2347 gidlist = *((gid_t **)value);
2348 printf("%s =", name);
2349 if (gidlist != NULL)
2353 for (i = 1; i <= (int)(gidlist[0]); i++)
2355 uschar *name = NULL;
2356 gr = getgrgid(gidlist[i]);
2357 if (gr != NULL) name = US gr->gr_name;
2358 if (name != NULL) printf("%c%s", sep, name);
2359 else printf("%c%ld", sep, (long int)(gidlist[i]));
2367 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2373 int *list = (int *)value;
2374 printf("%s = ", name);
2375 for (i = 0; i < list[1]; i++)
2376 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2382 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2386 case opt_expand_bool:
2387 sprintf(CS name2, "*expand_%.50s", name);
2388 ol2 = find_option(name2, oltop, last);
2389 if (ol2 != NULL && ol2->value != NULL)
2391 void *value2 = ol2->value;
2392 if (options_block != NULL)
2393 value2 = (void *)((uschar *)options_block + (long int)value2);
2394 s = *((uschar **)value2);
2397 printf("%s = %s\n", name, string_printing(s));
2400 /* s == NULL => string not set; fall through */
2406 case opt_bool_verify:
2408 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2415 /*************************************************
2416 * Print value from main configuration *
2417 *************************************************/
2419 /* This function, called as a result of encountering the -bP option,
2420 causes the value of any main configuration variable to be output if the
2421 second argument is NULL. There are some special values:
2423 all print all main configuration options
2424 configure_file print the name of the configuration file
2425 routers print the routers' configurations
2426 transports print the transports' configuration
2427 authenticators print the authenticators' configuration
2428 macros print the macros' configuration
2429 router_list print a list of router names
2430 transport_list print a list of transport names
2431 authenticator_list print a list of authentication mechanism names
2432 macro_list print a list of macro names
2433 +name print a named list item
2434 local_scan print the local_scan options
2435 environment print the used execution environment
2437 If the second argument is not NULL, it must be one of "router", "transport",
2438 "authenticator" or "macro" in which case the first argument identifies the
2439 driver whose options are to be printed.
2442 name option name if type == NULL; else driver name
2443 type NULL or driver type name, as described above
2449 readconf_print(uschar *name, uschar *type)
2451 BOOL names_only = FALSE;
2453 optionlist *ol2 = NULL;
2454 driver_instance *d = NULL;
2465 static uschar *types[] = { US"address", US"domain", US"host",
2467 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2468 &hostlist_anchor, &localpartlist_anchor };
2470 for (i = 0; i < 4; i++)
2472 t = tree_search(*(anchors[i]), name+1);
2476 printf("%slist %s = %s\n", types[i], name+1,
2477 ((namedlist_block *)(t->data.ptr))->string);
2482 printf("no address, domain, host, or local part list called \"%s\" "
2483 "exists\n", name+1);
2488 if (Ustrcmp(name, "configure_file") == 0)
2490 printf("%s\n", CS config_main_filename);
2494 if (Ustrcmp(name, "all") == 0)
2496 for (ol = optionlist_config;
2497 ol < optionlist_config + optionlist_config_size; ol++)
2499 if ((ol->type & opt_hidden) == 0)
2500 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2505 if (Ustrcmp(name, "local_scan") == 0)
2507 #ifndef LOCAL_SCAN_HAS_OPTIONS
2508 printf("local_scan() options are not supported\n");
2510 for (ol = local_scan_options;
2511 ol < local_scan_options + local_scan_options_count; ol++)
2513 print_ol(ol, US ol->name, NULL, local_scan_options,
2514 local_scan_options_count);
2520 if (Ustrcmp(name, "routers") == 0)
2525 else if (Ustrcmp(name, "transports") == 0)
2527 type = US"transport";
2531 else if (Ustrcmp(name, "authenticators") == 0)
2533 type = US"authenticator";
2537 else if (Ustrcmp(name, "macros") == 0)
2543 else if (Ustrcmp(name, "router_list") == 0)
2550 else if (Ustrcmp(name, "transport_list") == 0)
2552 type = US"transport";
2557 else if (Ustrcmp(name, "authenticator_list") == 0)
2559 type = US"authenticator";
2564 else if (Ustrcmp(name, "macro_list") == 0)
2571 else if (Ustrcmp(name, "environment") == 0)
2577 for (p = USS environ; *p; p++) ;
2578 n = p - USS environ;
2579 qsort(environ, p - USS environ, sizeof(*p), (__compar_fn_t) string_compare_by_pointer);
2581 for (p = USS environ; *p; p++)
2591 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2592 name, NULL, optionlist_config, optionlist_config_size);
2597 /* Handle the options for a router or transport. Skip options that are flagged
2598 as hidden. Some of these are options with names starting with '*', used for
2599 internal alternative representations of other options (which the printing
2600 function will sort out). Others are synonyms kept for backward compatibility.
2603 if (Ustrcmp(type, "router") == 0)
2605 d = (driver_instance *)routers;
2606 ol2 = optionlist_routers;
2607 size = optionlist_routers_size;
2609 else if (Ustrcmp(type, "transport") == 0)
2611 d = (driver_instance *)transports;
2612 ol2 = optionlist_transports;
2613 size = optionlist_transports_size;
2615 else if (Ustrcmp(type, "authenticator") == 0)
2617 d = (driver_instance *)auths;
2618 ol2 = optionlist_auths;
2619 size = optionlist_auths_size;
2622 else if (Ustrcmp(type, "macro") == 0)
2624 /* People store passwords in macros and they were previously not available
2625 for printing. So we have an admin_users restriction. */
2628 fprintf(stderr, "exim: permission denied\n");
2631 for (m = macros; m != NULL; m = m->next)
2633 if (name == NULL || Ustrcmp(name, m->name) == 0)
2636 printf("%s\n", CS m->name);
2638 printf("%s=%s\n", CS m->name, CS m->replacement);
2644 printf("%s %s not found\n", type, name);
2650 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2654 /* Either search for a given driver, or print all of them */
2656 for (; d != NULL; d = d->next)
2659 printf("\n%s %s:\n", d->name, type);
2660 else if (Ustrcmp(d->name, name) != 0) continue;
2662 for (ol = ol2; ol < ol2 + size; ol++)
2664 if ((ol->type & opt_hidden) == 0)
2665 print_ol(ol, US ol->name, d, ol2, size);
2668 for (ol = d->info->options;
2669 ol < d->info->options + *(d->info->options_count); ol++)
2671 if ((ol->type & opt_hidden) == 0)
2672 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2674 if (name != NULL) return;
2676 if (name != NULL) printf("%s %s not found\n", type, name);
2681 /*************************************************
2682 * Read a named list item *
2683 *************************************************/
2685 /* This function reads a name and a list (i.e. string). The name is used to
2686 save the list in a tree, sorted by its name. Each entry also has a number,
2687 which can be used for caching tests, but if the string contains any expansion
2688 items other than $key, the number is set negative to inhibit caching. This
2689 mechanism is used for domain, host, and address lists that are referenced by
2693 anchorp points to the tree anchor
2694 numberp points to the current number for this tree
2695 max the maximum number permitted
2696 s the text of the option line, starting immediately after the name
2698 tname the name of the list type, for messages
2704 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2707 BOOL forcecache = FALSE;
2710 namedlist_block *nb = store_get(sizeof(namedlist_block));
2712 if (Ustrncmp(s, "_cache", 6) == 0)
2719 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2721 if (*numberp >= max)
2722 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2725 while (isspace(*s)) s++;
2727 while (isalnum(*s) || *s == '_') s++;
2728 t = store_get(sizeof(tree_node) + s-ss);
2729 Ustrncpy(t->name, ss, s-ss);
2731 while (isspace(*s)) s++;
2733 if (!tree_insertnode(anchorp, t))
2734 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2735 "duplicate name \"%s\" for a named %s", t->name, tname);
2738 nb->number = *numberp;
2741 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2742 "missing '=' after \"%s\"", t->name);
2743 while (isspace(*s)) s++;
2744 nb->string = read_string(s, t->name);
2745 nb->cache_data = NULL;
2747 /* Check the string for any expansions; if any are found, mark this list
2748 uncacheable unless the user has explicited forced caching. */
2750 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2756 /*************************************************
2757 * Unpick data for a rate limit *
2758 *************************************************/
2760 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2764 s string, in the form t,b,f,l
2765 where t is the threshold (integer)
2766 b is the initial delay (time)
2767 f is the multiplicative factor (fixed point)
2768 k is the maximum time (time)
2769 threshold where to store threshold
2770 base where to store base in milliseconds
2771 factor where to store factor in milliseconds
2772 limit where to store limit
2774 Returns: nothing (panics on error)
2778 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2781 uschar bstring[16], lstring[16];
2783 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2784 factor, lstring) == 4)
2786 *base = readconf_readtime(bstring, 0, TRUE);
2787 *limit = readconf_readtime(lstring, 0, TRUE);
2788 if (*base >= 0 && *limit >= 0) return;
2790 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2796 /*************************************************
2797 * Drop privs for checking TLS config *
2798 *************************************************/
2800 /* We want to validate TLS options during readconf, but do not want to be
2801 root when we call into the TLS library, in case of library linkage errors
2802 which cause segfaults; before this check, those were always done as the Exim
2803 runtime user and it makes sense to continue with that.
2805 Assumes: tls_require_ciphers has been set, if it will be
2806 exim_user has been set, if it will be
2807 exim_group has been set, if it will be
2809 Returns: bool for "okay"; false will cause caller to immediately exit.
2814 tls_dropprivs_validate_require_cipher(void)
2816 const uschar *errmsg;
2819 void (*oldsignal)(int);
2821 oldsignal = signal(SIGCHLD, SIG_DFL);
2824 if ((pid = fork()) < 0)
2825 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "fork failed for TLS check");
2829 /* in some modes, will have dropped privilege already */
2831 exim_setugid(exim_uid, exim_gid, FALSE,
2832 US"calling tls_validate_require_cipher");
2834 errmsg = tls_validate_require_cipher();
2837 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2838 "tls_require_ciphers invalid: %s", errmsg);
2845 rc = waitpid(pid, &status, 0);
2846 } while (rc < 0 && errno == EINTR);
2849 debug_printf("tls_validate_require_cipher child %d ended: status=0x%x\n",
2852 signal(SIGCHLD, oldsignal);
2856 #endif /* SUPPORT_TLS */
2861 /*************************************************
2862 * Read main configuration options *
2863 *************************************************/
2865 /* This function is the first to be called for configuration reading. It
2866 opens the configuration file and reads general configuration settings until
2867 it reaches the end of the configuration section. The file is then left open so
2868 that the remaining configuration data can subsequently be read if needed for
2871 The configuration file must be owned either by root or exim, and be writeable
2872 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2873 in the config file, so the test is done on the compiled in values. A slight
2874 anomaly, to be carefully documented.
2876 The name of the configuration file is taken from a list that is included in the
2877 binary of Exim. It can be altered from the command line, but if that is done,
2878 root privilege is immediately withdrawn unless the caller is root or exim.
2879 The first file on the list that exists is used.
2881 For use on multiple systems that share file systems, first look for a
2882 configuration file whose name has the current node name on the end. If that is
2883 not found, try the generic name. For really contorted configurations, that run
2884 multiple Exims with different uid settings, first try adding the effective uid
2885 before the node name. These complications are going to waste resources on most
2886 systems. Therefore they are available only when requested by compile-time
2893 struct stat statbuf;
2894 uschar *s, *filename;
2895 uschar *list = config_main_filelist;
2897 /* Loop through the possible file names */
2899 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2903 /* To avoid confusion: Exim changes to / at the very beginning and
2904 * and to $spool_directory later. */
2905 if (filename[0] != '/')
2907 fprintf(stderr, "-C %s: only absolute names are allowed\n", filename);
2911 /* Cut out all the fancy processing unless specifically wanted */
2913 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2914 uschar *suffix = filename + Ustrlen(filename);
2916 /* Try for the node-specific file if a node name exists */
2918 #ifdef CONFIGURE_FILE_USE_NODE
2920 if (uname(&uts) >= 0)
2922 #ifdef CONFIGURE_FILE_USE_EUID
2923 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2924 config_file = Ufopen(filename, "rb");
2925 if (config_file == NULL)
2926 #endif /* CONFIGURE_FILE_USE_EUID */
2928 sprintf(CS suffix, ".%.256s", uts.nodename);
2929 config_file = Ufopen(filename, "rb");
2932 #endif /* CONFIGURE_FILE_USE_NODE */
2934 /* Otherwise, try the generic name, possibly with the euid added */
2936 #ifdef CONFIGURE_FILE_USE_EUID
2937 if (config_file == NULL)
2939 sprintf(CS suffix, ".%ld", (long int)original_euid);
2940 config_file = Ufopen(filename, "rb");
2942 #endif /* CONFIGURE_FILE_USE_EUID */
2944 /* Finally, try the unadorned name */
2946 if (config_file == NULL)
2949 config_file = Ufopen(filename, "rb");
2951 #else /* if neither defined */
2953 /* This is the common case when the fancy processing is not included. */
2955 config_file = Ufopen(filename, "rb");
2958 /* If the file does not exist, continue to try any others. For any other
2959 error, break out (and die). */
2961 if (config_file != NULL || errno != ENOENT) break;
2964 /* On success, save the name for verification; config_filename is used when
2965 logging configuration errors (it changes for .included files) whereas
2966 config_main_filename is the name shown by -bP. Failure to open a configuration
2967 file is a serious disaster. */
2969 if (config_file != NULL)
2971 config_filename = config_main_filename = string_copy(filename);
2975 if (filename == NULL)
2976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2977 "%s", config_main_filelist);
2979 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2980 "configuration file %s", filename));
2983 /* Check the status of the file we have opened, if we have retained root
2984 privileges and the file isn't /dev/null (which *should* be 0666). */
2986 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
2988 if (fstat(fileno(config_file), &statbuf) != 0)
2989 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2992 if ((statbuf.st_uid != root_uid /* owner not root */
2993 #ifdef CONFIGURE_OWNER
2994 && statbuf.st_uid != config_uid /* owner not the special one */
2997 (statbuf.st_gid != root_gid /* group not root & */
2998 #ifdef CONFIGURE_GROUP
2999 && statbuf.st_gid != config_gid /* group not the special one */
3001 && (statbuf.st_mode & 020) != 0) || /* group writeable */
3003 ((statbuf.st_mode & 2) != 0)) /* world writeable */
3005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
3006 "wrong owner, group, or mode", big_buffer);
3009 /* Process the main configuration settings. They all begin with a lower case
3010 letter. If we see something starting with an upper case letter, it is taken as
3011 a macro definition. */
3013 while ((s = get_config_line()) != NULL)
3015 if (isupper(s[0])) read_macro_assignment(s);
3017 else if (Ustrncmp(s, "domainlist", 10) == 0)
3018 read_named_list(&domainlist_anchor, &domainlist_count,
3019 MAX_NAMED_LIST, s+10, US"domain list");
3021 else if (Ustrncmp(s, "hostlist", 8) == 0)
3022 read_named_list(&hostlist_anchor, &hostlist_count,
3023 MAX_NAMED_LIST, s+8, US"host list");
3025 else if (Ustrncmp(s, US"addresslist", 11) == 0)
3026 read_named_list(&addresslist_anchor, &addresslist_count,
3027 MAX_NAMED_LIST, s+11, US"address list");
3029 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
3030 read_named_list(&localpartlist_anchor, &localpartlist_count,
3031 MAX_NAMED_LIST, s+13, US"local part list");
3034 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
3035 NULL, US"main option \"%s\" unknown");
3039 /* If local_sender_retain is set, local_from_check must be unset. */
3041 if (local_sender_retain && local_from_check)
3042 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
3043 "local_sender_retain are set; this combination is not allowed");
3045 /* If the timezone string is empty, set it to NULL, implying no TZ variable
3048 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
3050 /* The max retry interval must not be greater than 24 hours. */
3052 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
3054 /* remote_max_parallel must be > 0 */
3056 if (remote_max_parallel <= 0) remote_max_parallel = 1;
3058 /* Save the configured setting of freeze_tell, so we can re-instate it at the
3059 start of a new SMTP message. */
3061 freeze_tell_config = freeze_tell;
3063 /* The primary host name may be required for expansion of spool_directory
3064 and log_file_path, so make sure it is set asap. It is obtained from uname(),
3065 but if that yields an unqualified value, make a FQDN by using gethostbyname to
3066 canonize it. Some people like upper case letters in their host names, so we
3067 don't force the case. */
3069 if (primary_hostname == NULL)
3073 if (uname(&uts) < 0)
3074 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
3075 hostname = US uts.nodename;
3077 if (Ustrchr(hostname, '.') == NULL)
3080 struct hostent *hostdata;
3083 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
3084 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
3094 #if HAVE_GETIPNODEBYNAME
3096 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3098 hostdata = gethostbyname2(CS hostname, af);
3101 hostdata = gethostbyname(CS hostname);
3104 if (hostdata != NULL)
3106 hostname = US hostdata->h_name;
3110 if (af == AF_INET) break;
3115 primary_hostname = string_copy(hostname);
3118 /* Set up default value for smtp_active_hostname */
3120 smtp_active_hostname = primary_hostname;
3122 /* If spool_directory wasn't set in the build-time configuration, it must have
3123 got set above. Of course, writing to the log may not work if log_file_path is
3124 not set, but it will at least get to syslog or somewhere, with any luck. */
3126 if (*spool_directory == 0)
3127 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3130 /* Expand the spool directory name; it may, for example, contain the primary
3131 host name. Same comment about failure. */
3133 s = expand_string(spool_directory);
3135 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3136 "\"%s\": %s", spool_directory, expand_string_message);
3137 spool_directory = s;
3139 /* Expand log_file_path, which must contain "%s" in any component that isn't
3140 the null string or "syslog". It is also allowed to contain one instance of %D
3141 or %M. However, it must NOT contain % followed by anything else. */
3143 if (*log_file_path != 0)
3146 int sep = ':'; /* Fixed for log file path */
3147 s = expand_string(log_file_path);
3149 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3150 "\"%s\": %s", log_file_path, expand_string_message);
3153 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3156 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3157 t = Ustrstr(sss, "%s");
3159 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3160 "contain \"%%s\"", sss);
3162 t = Ustrchr(sss, '%');
3165 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3166 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3167 "unexpected \"%%\" character", s);
3174 /* Interpret syslog_facility into an integer argument for 'ident' param to
3175 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3178 if (syslog_facility_str != NULL)
3181 uschar *s = syslog_facility_str;
3183 if ((Ustrlen(syslog_facility_str) >= 4) &&
3184 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3187 for (i = 0; i < syslog_list_size; i++)
3189 if (strcmpic(s, syslog_list[i].name) == 0)
3191 syslog_facility = syslog_list[i].value;
3196 if (i >= syslog_list_size)
3198 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3199 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3203 /* Expand pid_file_path */
3205 if (*pid_file_path != 0)
3207 s = expand_string(pid_file_path);
3209 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3210 "\"%s\": %s", pid_file_path, expand_string_message);
3214 /* Set default value of process_log_path */
3216 if (process_log_path == NULL || *process_log_path =='\0')
3217 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3219 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3222 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3224 /* Unpick the SMTP rate limiting options, if set */
3226 if (smtp_ratelimit_mail != NULL)
3228 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3229 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3232 if (smtp_ratelimit_rcpt != NULL)
3234 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3235 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3238 /* The qualify domains default to the primary host name */
3240 if (qualify_domain_sender == NULL)
3241 qualify_domain_sender = primary_hostname;
3242 if (qualify_domain_recipient == NULL)
3243 qualify_domain_recipient = qualify_domain_sender;
3245 /* Setting system_filter_user in the configuration sets the gid as well if a
3246 name is given, but a numerical value does not. */
3248 if (system_filter_uid_set && !system_filter_gid_set)
3250 struct passwd *pw = getpwuid(system_filter_uid);
3252 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3253 (long int)system_filter_uid);
3254 system_filter_gid = pw->pw_gid;
3255 system_filter_gid_set = TRUE;
3258 /* If the errors_reply_to field is set, check that it is syntactically valid
3259 and ensure it contains a domain. */
3261 if (errors_reply_to != NULL)
3264 int start, end, domain;
3265 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3266 &start, &end, &domain, FALSE);
3268 if (recipient == NULL)
3269 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3270 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3273 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3274 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3277 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3278 smtp_accept_max must also be set. */
3280 if (smtp_accept_max == 0 &&
3281 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3283 "smtp_accept_max must be set if smtp_accept_queue or "
3284 "smtp_accept_max_per_host is set");
3286 /* Set up the host number if anything is specified. It is an expanded string
3287 so that it can be computed from the host name, for example. We do this last
3288 so as to ensure that everything else is set up before the expansion. */
3290 if (host_number_string != NULL)
3294 uschar *s = expand_string(host_number_string);
3296 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3297 "failed to expand localhost_number \"%s\": %s",
3298 host_number_string, expand_string_message);
3299 n = Ustrtol(s, &end, 0);
3300 while (isspace(*end)) end++;
3302 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3303 "localhost_number value is not a number: %s", s);
3304 if (n > LOCALHOST_MAX)
3305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3306 "localhost_number is greater than the maximum allowed value (%d)",
3312 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3314 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3315 tls_verify_certificates == NULL)
3316 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3317 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3318 (tls_verify_hosts != NULL)? "" : "try_");
3320 /* This also checks that the library linkage is working and we can call
3321 routines in it, so call even if tls_require_ciphers is unset */
3322 if (!tls_dropprivs_validate_require_cipher())
3325 /* Magic number: at time of writing, 1024 has been the long-standing value
3326 used by so many clients, and what Exim used to use always, that it makes
3327 sense to just min-clamp this max-clamp at that. */
3328 if (tls_dh_max_bits < 1024)
3329 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3330 "tls_dh_max_bits is too small, must be at least 1024 for interop");
3332 /* If openssl_options is set, validate it */
3333 if (openssl_options != NULL)
3336 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3337 "openssl_options is set but we're using GnuTLS");
3340 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3341 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3342 "openssl_options parse error: %s", openssl_options);
3347 if ((!add_environment || *add_environment == '\0') && !keep_environment)
3348 log_write(0, LOG_MAIN,
3349 "WARNING: purging the environment.\n"
3350 " Suggested action: use keep_environment and add_environment.\n");
3355 /*************************************************
3356 * Initialize one driver *
3357 *************************************************/
3359 /* This is called once the driver's generic options, if any, have been read.
3360 We can now find the driver, set up defaults for the private options, and
3361 unset any "set" bits in the private options table (which might have been
3362 set by another incarnation of the same driver).
3365 d pointer to driver instance block, with generic
3367 drivers_available vector of available drivers
3368 size_of_info size of each block in drivers_available
3369 class class of driver, for error message
3371 Returns: pointer to the driver info block
3374 static driver_info *
3375 init_driver(driver_instance *d, driver_info *drivers_available,
3376 int size_of_info, uschar *class)
3380 for (dd = drivers_available; dd->driver_name[0] != 0;
3381 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3383 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3386 int len = dd->options_len;
3388 d->options_block = store_get(len);
3389 memcpy(d->options_block, dd->options_block, len);
3390 for (i = 0; i < *(dd->options_count); i++)
3391 dd->options[i].type &= ~opt_set;
3396 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3397 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3399 return NULL; /* never obeyed */
3405 /*************************************************
3406 * Initialize driver list *
3407 *************************************************/
3409 /* This function is called for routers, transports, and authentication
3410 mechanisms. It reads the data from the current point in the configuration file
3411 up to the end of the section, and sets up a chain of instance blocks according
3412 to the file's contents. The file will already have been opened by a call to
3413 readconf_main, and must be left open for subsequent reading of further data.
3415 Any errors cause a panic crash. Note that the blocks with names driver_info and
3416 driver_instance must map the first portions of all the _info and _instance
3417 blocks for this shared code to work.
3420 class "router", "transport", or "authenticator"
3421 anchor &routers, &transports, &auths
3422 drivers_available available drivers
3423 size_of_info size of each info block
3424 instance_default points to default data for an instance
3425 instance_size size of instance block
3426 driver_optionlist generic option list
3427 driver_optionlist_count count of generic option list
3433 readconf_driver_init(
3435 driver_instance **anchor,
3436 driver_info *drivers_available,
3438 void *instance_default,
3440 optionlist *driver_optionlist,
3441 int driver_optionlist_count)
3443 driver_instance **p = anchor;
3444 driver_instance *d = NULL;
3447 while ((buffer = get_config_line()) != NULL)
3452 /* Read the first name on the line and test for the start of a new driver. A
3453 macro definition indicates the end of the previous driver. If this isn't the
3454 start of a new driver, the line will be re-read. */
3456 s = readconf_readname(name, sizeof(name), buffer);
3458 /* Handle macro definition, first finishing off the initialization of the
3459 previous driver, if any. */
3461 if (isupper(*name) && *s == '=')
3465 if (d->driver_name == NULL)
3466 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3467 "no driver defined for %s \"%s\"", class, d->name);
3471 read_macro_assignment(buffer);
3475 /* If the line starts with a name terminated by a colon, we are at the
3476 start of the definition of a new driver. The rest of the line must be
3483 /* Finish off initializing the previous driver. */
3487 if (d->driver_name == NULL)
3488 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3489 "no driver defined for %s \"%s\"", class, d->name);
3493 /* Check that we haven't already got a driver of this name */
3495 for (d = *anchor; d != NULL; d = d->next)
3496 if (Ustrcmp(name, d->name) == 0)
3497 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3498 "there are two %ss called \"%s\"", class, name);
3500 /* Set up a new driver instance data block on the chain, with
3501 its default values installed. */
3503 d = store_get(instance_size);
3504 memcpy(d, instance_default, instance_size);
3507 d->name = string_copy(name);
3509 /* Clear out the "set" bits in the generic options */
3511 for (i = 0; i < driver_optionlist_count; i++)
3512 driver_optionlist[i].type &= ~opt_set;
3514 /* Check nothing more on this line, then do the next loop iteration. */
3516 while (isspace(*s)) s++;
3517 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3521 /* Not the start of a new driver. Give an error if we have not set up a
3522 current driver yet. */
3524 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3525 "%s name missing", class);
3527 /* First look to see if this is a generic option; if it is "driver",
3528 initialize the driver. If is it not a generic option, we can look for a
3529 private option provided that the driver has been previously set up. */
3531 if (readconf_handle_option(buffer, driver_optionlist,
3532 driver_optionlist_count, d, NULL))
3534 if (d->info == NULL && d->driver_name != NULL)
3535 init_driver(d, drivers_available, size_of_info, class);
3538 /* Handle private options - pass the generic block because some may
3539 live therein. A flag with each option indicates if it is in the public
3542 else if (d->info != NULL)
3544 readconf_handle_option(buffer, d->info->options,
3545 *(d->info->options_count), d, US"option \"%s\" unknown");
3548 /* The option is not generic and the driver name has not yet been given. */
3550 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3551 "(\"driver\" must be specified before any private options)", name);
3554 /* Run the initialization function for the final driver. */
3558 if (d->driver_name == NULL)
3559 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3560 "no driver defined for %s \"%s\"", class, d->name);
3567 /*************************************************
3568 * Check driver dependency *
3569 *************************************************/
3571 /* This function is passed a driver instance and a string. It checks whether
3572 any of the string options for the driver contains the given string as an
3576 d points to a driver instance block
3577 s the string to search for
3579 Returns: TRUE if a dependency is found
3583 readconf_depends(driver_instance *d, uschar *s)
3585 int count = *(d->info->options_count);
3589 for (ol = d->info->options; ol < d->info->options + count; ol++)
3591 void *options_block;
3593 int type = ol->type & opt_mask;
3594 if (type != opt_stringptr) continue;
3595 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3596 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3597 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3599 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3600 isalnum(ss[Ustrlen(s)])) continue;
3601 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3602 d->name, ol->name, s);
3607 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3614 /*************************************************
3615 * Decode an error type for retries *
3616 *************************************************/
3618 /* This function is global because it is also called from the main
3619 program when testing retry information. It decodes strings such as "quota_7d"
3620 into numerical error codes.
3623 pp points to start of text
3624 p points past end of text
3625 basic_errno points to an int to receive the main error number
3626 more_errno points to an int to receive the secondary error data
3628 Returns: NULL if decoded correctly; else points to error text
3632 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3636 while (q < p && *q != '_') q++;
3639 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3641 *basic_errno = ERRNO_EXIMQUOTA;
3642 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3643 return US"bad time value";
3646 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3648 *basic_errno = ECONNREFUSED;
3651 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3652 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3653 else return US"A or MX expected after \"refused\"";
3657 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3659 *basic_errno = ETIMEDOUT;
3663 int xlen = p - q - 1;
3666 static uschar *extras[] =
3667 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3668 static int values[] =
3669 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3671 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3673 if (strncmpic(x, extras[i], xlen) == 0)
3675 *more_errno = values[i];
3680 if (i >= sizeof(extras)/sizeof(uschar *))
3682 if (strncmpic(x, US"DNS", xlen) == 0)
3684 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3685 "available in retry rules (it has never worked) - treated as "
3688 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3693 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3694 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3695 strncmpic(pp, US"data_4", 6) == 0)
3698 int x = 255; /* means "any 4xx code" */
3699 if (p != pp + 8) bad = TRUE; else
3701 int a = pp[6], b = pp[7];
3705 if (isdigit(b)) x += b - '0';
3706 else if (b == 'x') x += 100;
3709 else if (a != 'x' || b != 'x') bad = TRUE;
3713 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3714 "x is literal and d is any digit", pp);
3716 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3717 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3718 *more_errno = x << 8;
3721 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3722 strncmpic(q+1, US"failed", p-q-1) == 0)
3723 *basic_errno = ERRNO_AUTHFAIL;
3725 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3726 *basic_errno = ERRNO_SMTPCLOSED;
3728 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3729 *basic_errno = ERRNO_TLSREQUIRED;
3731 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3732 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3740 /*************************************************
3741 * Read retry information *
3742 *************************************************/
3744 /* Each line of retry information contains:
3746 . A domain name pattern or an address pattern;
3748 . An error name, possibly with additional data, or *;
3750 . An optional sequence of retry items, each consisting of an identifying
3751 letter, a cutoff time, and optional parameters.
3753 All this is decoded and placed into a control block. */
3756 /* Subroutine to read an argument, preceded by a comma and terminated
3757 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3758 1 = fixed point number (returned *1000).
3761 paddr pointer to pointer to current character; updated
3762 type 0 => read a time; 1 => read a fixed point number
3764 Returns: time in seconds or fixed point number * 1000
3768 retry_arg(uschar **paddr, int type)
3773 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3775 while (isspace(*p)) p++;
3777 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3779 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3780 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3786 return readconf_readtime(pp, *p, FALSE);
3788 return readconf_readfixed(pp, *p);
3790 return 0; /* Keep picky compilers happy */
3793 /* The function proper */
3796 readconf_retries(void)
3798 retry_config **chain = &retries;
3802 while ((p = get_config_line()) != NULL)
3804 retry_rule **rchain;
3807 next = store_get(sizeof(retry_config));
3810 chain = &(next->next);
3811 next->basic_errno = next->more_errno = 0;
3812 next->senders = NULL;
3814 rchain = &(next->rules);
3816 next->pattern = string_dequote(&p);
3817 while (isspace(*p)) p++;
3819 while (mac_isgraph(*p)) p++;
3820 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3821 "missing error type");
3823 /* Test error names for things we understand. */
3825 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3826 &(next->more_errno))) != NULL)
3827 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3829 /* There may be an optional address list of senders to be used as another
3830 constraint on the rule. This was added later, so the syntax is a bit of a
3831 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3834 while (isspace(*p)) p++;
3835 if (Ustrncmp(p, "senders", 7) == 0)
3838 while (isspace(*p)) p++;
3839 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3840 "\"=\" expected after \"senders\" in retry rule");
3841 while (isspace(*p)) p++;
3842 next->senders = string_dequote(&p);
3845 /* Now the retry rules. Keep the maximum timeout encountered. */
3847 while (isspace(*p)) p++;
3851 retry_rule *rule = store_get(sizeof(retry_rule));
3853 rchain = &(rule->next);
3855 rule->rule = toupper(*p++);
3856 rule->timeout = retry_arg(&p, 0);
3857 if (rule->timeout > retry_maximum_timeout)
3858 retry_maximum_timeout = rule->timeout;
3862 case 'F': /* Fixed interval */
3863 rule->p1 = retry_arg(&p, 0);
3866 case 'G': /* Geometrically increasing intervals */
3867 case 'H': /* Ditto, but with randomness */
3868 rule->p1 = retry_arg(&p, 0);
3869 rule->p2 = retry_arg(&p, 1);
3873 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3877 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3878 (rule->rule != 'F' && rule->p2 < 1000))
3879 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3880 "bad parameters for retry rule");
3882 while (isspace(*p)) p++;
3886 while (isspace(*p)) p++;
3889 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3896 /*************************************************
3897 * Initialize authenticators *
3898 *************************************************/
3900 /* Read the authenticators section of the configuration file.
3909 auth_instance *au, *bu;
3910 readconf_driver_init(US"authenticator",
3911 (driver_instance **)(&auths), /* chain anchor */
3912 (driver_info *)auths_available, /* available drivers */
3913 sizeof(auth_info), /* size of info block */
3914 &auth_defaults, /* default values for generic options */
3915 sizeof(auth_instance), /* size of instance block */
3916 optionlist_auths, /* generic options */
3917 optionlist_auths_size);
3919 for (au = auths; au != NULL; au = au->next)
3921 if (au->public_name == NULL)
3922 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3923 "the %s authenticator", au->name);
3924 for (bu = au->next; bu != NULL; bu = bu->next)
3926 if (strcmpic(au->public_name, bu->public_name) == 0)
3928 if ((au->client && bu->client) || (au->server && bu->server))
3929 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3930 "(%s and %s) have the same public name (%s)",
3931 (au->client)? US"client" : US"server", au->name, bu->name,
3941 /*************************************************
3942 * Read ACL information *
3943 *************************************************/
3945 /* If this run of Exim is not doing something that involves receiving a
3946 message, we can just skip over the ACL information. No need to parse it.
3948 First, we have a function for acl_read() to call back to get the next line. We
3949 need to remember the line we passed, because at the end it will contain the
3950 name of the next ACL. */
3952 static uschar *acl_line;
3957 acl_line = get_config_line();
3962 /* Now the main function:
3965 skip TRUE when this Exim process is doing something that will
3966 not need the ACL data
3972 readconf_acl(BOOL skip)
3976 /* Not receiving messages, don't need to parse the ACL data */
3980 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3981 while ((p = get_config_line()) != NULL);
3985 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3988 acl_line = get_config_line();
3990 while(acl_line != NULL)
3996 p = readconf_readname(name, sizeof(name), acl_line);
3997 if (isupper(*name) && *p == '=')
3999 read_macro_assignment(acl_line);
4000 acl_line = get_config_line();
4004 if (*p != ':' || name[0] == 0)
4005 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
4007 node = store_get(sizeof(tree_node) + Ustrlen(name));
4008 Ustrcpy(node->name, name);
4009 if (!tree_insertnode(&acl_anchor, node))
4010 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4011 "there are two ACLs called \"%s\"", name);
4013 node->data.ptr = acl_read(acl_callback, &error);
4015 if (node->data.ptr == NULL && error != NULL)
4016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
4022 /*************************************************
4023 * Read configuration for local_scan() *
4024 *************************************************/
4026 /* This function is called after "begin local_scan" is encountered in the
4027 configuration file. If the local_scan() function allows for configuration
4028 options, we can process them. Otherwise, we expire in a panic.
4035 local_scan_init(void)
4037 #ifndef LOCAL_SCAN_HAS_OPTIONS
4038 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
4039 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
4043 while ((p = get_config_line()) != NULL)
4045 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
4046 NULL, US"local_scan option \"%s\" unknown");
4053 /*************************************************
4054 * Read rest of configuration (after main) *
4055 *************************************************/
4057 /* This function reads the rest of the runtime configuration, after the main
4058 configuration. It is called only when actually needed. Each subsequent section
4059 of the configuration starts with a line of the form
4063 where the name is "routers", "transports", etc. A section is terminated by
4064 hitting the next "begin" line, and the next name is left in next_section.
4065 Because it may confuse people as to whether the names are singular or plural,
4066 we add "s" if it's missing. There is always enough room in next_section for
4067 this. This function is basically just a switch.
4070 skip_acl TRUE if ACL information is not needed
4075 static uschar *section_list[] = {
4085 readconf_rest(BOOL skip_acl)
4089 while(next_section[0] != 0)
4093 int last = sizeof(section_list) / sizeof(uschar *);
4095 int n = Ustrlen(next_section);
4097 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
4101 int c = strcmpic(next_section, section_list[mid]);
4103 if (c > 0) first = mid + 1; else last = mid;
4105 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4106 "\"%.*s\" is not a known configuration section name", n, next_section);
4107 mid = (last + first)/2;
4111 if (((had ^= bit) & bit) == 0)
4112 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
4113 "\"%.*s\" section is repeated in the configuration file", n,
4118 case 0: readconf_acl(skip_acl); break;
4119 case 1: auths_init(); break;
4120 case 2: local_scan_init(); break;
4121 case 3: readconf_retries(); break;
4122 case 4: readconf_rewrites(); break;
4123 case 5: route_init(); break;
4124 case 6: transport_init(); break;
4128 (void)fclose(config_file);
4131 /* End of readconf.c */