1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for reading the configuration file, and for displaying
9 overall configuration values. Thanks to Brian Candler for the original
10 implementation of the conditional .ifdef etc. */
14 #define CSTATE_STACK_SIZE 10
17 /* Structure for chain (stack) of .included files */
19 typedef struct config_file_item {
20 struct config_file_item *next;
26 /* Structure of table of conditional words and their state transitions */
28 typedef struct cond_item {
36 /* Structure of table of syslog facility names and values */
38 typedef struct syslog_fac_item {
44 /* Static variables */
46 static config_file_item *config_file_stack = NULL; /* For includes */
48 static uschar *syslog_facility_str = NULL;
49 static uschar next_section[24];
50 static uschar time_buffer[24];
52 /* State variables for conditional loading (.ifdef / .else / .endif) */
54 static int cstate = 0;
55 static int cstate_stack_ptr = -1;
56 static int cstate_stack[CSTATE_STACK_SIZE];
58 /* Table of state transitions for handling conditional inclusions. There are
59 four possible state transitions:
63 .elifdef true (or .else)
66 .endif just causes the previous cstate to be popped off the stack */
68 static int next_cstate[3][4] =
70 /* State 0: reading from file, or reading until next .else or .endif */
72 /* State 1: condition failed, skipping until next .else or .endif */
74 /* State 2: skipping until .endif */
78 /* Table of conditionals and the states to set. For each name, there are four
79 values: the length of the name (to save computing it each time), the state to
80 set if a macro was found in the line, the state to set if a macro was not found
81 in the line, and a stack manipulation setting which is:
83 -1 pull state value off the stack
84 0 don't alter the stack
85 +1 push value onto stack, before setting new state
88 static cond_item cond_list[] = {
89 { US"ifdef", 5, 0, 1, 1 },
90 { US"ifndef", 6, 1, 0, 1 },
91 { US"elifdef", 7, 2, 3, 0 },
92 { US"elifndef", 8, 3, 2, 0 },
93 { US"else", 4, 2, 2, 0 },
94 { US"endif", 5, 0, 0, -1 }
97 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
99 /* Table of syslog facility names and their values */
101 static syslog_fac_item syslog_list[] = {
102 { US"mail", LOG_MAIL },
103 { US"user", LOG_USER },
104 { US"news", LOG_NEWS },
105 { US"uucp", LOG_UUCP },
106 { US"local0", LOG_LOCAL0 },
107 { US"local1", LOG_LOCAL1 },
108 { US"local2", LOG_LOCAL2 },
109 { US"local3", LOG_LOCAL3 },
110 { US"local4", LOG_LOCAL4 },
111 { US"local5", LOG_LOCAL5 },
112 { US"local6", LOG_LOCAL6 },
113 { US"local7", LOG_LOCAL7 },
114 { US"daemon", LOG_DAEMON }
117 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
122 /*************************************************
123 * Main configuration options *
124 *************************************************/
126 /* The list of options that can be set in the main configuration file. This
127 must be in alphabetic order because it is searched by binary chop. */
129 static optionlist optionlist_config[] = {
130 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
131 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
132 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
133 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
134 { "accept_8bitmime", opt_bool, &accept_8bitmime },
135 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
136 #ifdef WITH_CONTENT_SCAN
137 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
139 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
140 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
141 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
142 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
144 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
146 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
147 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
148 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
149 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
150 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
151 #ifdef WITH_CONTENT_SCAN
152 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
154 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
155 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
156 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
157 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
159 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
161 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
162 { "admin_groups", opt_gidlist, &admin_groups },
163 { "allow_domain_literals", opt_bool, &allow_domain_literals },
164 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
165 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
166 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
167 { "auto_thaw", opt_time, &auto_thaw },
168 #ifdef WITH_CONTENT_SCAN
169 { "av_scanner", opt_stringptr, &av_scanner },
171 { "bi_command", opt_stringptr, &bi_command },
172 #ifdef EXPERIMENTAL_BRIGHTMAIL
173 { "bmi_config_file", opt_stringptr, &bmi_config_file },
175 { "bounce_message_file", opt_stringptr, &bounce_message_file },
176 { "bounce_message_text", opt_stringptr, &bounce_message_text },
177 { "bounce_return_body", opt_bool, &bounce_return_body },
178 { "bounce_return_message", opt_bool, &bounce_return_message },
179 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
180 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
181 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
182 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
183 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
184 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
185 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
186 { "check_log_inodes", opt_int, &check_log_inodes },
187 { "check_log_space", opt_Kint, &check_log_space },
188 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
189 { "check_spool_inodes", opt_int, &check_spool_inodes },
190 { "check_spool_space", opt_Kint, &check_spool_space },
191 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
192 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
193 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
194 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
195 #ifdef EXPERIMENTAL_DCC
196 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
197 { "dccifd_address", opt_stringptr, &dccifd_address },
198 { "dccifd_options", opt_stringptr, &dccifd_options },
200 { "delay_warning", opt_timelist, &delay_warning },
201 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
202 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
203 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
204 { "delivery_date_remove", opt_bool, &delivery_date_remove },
205 #ifdef ENABLE_DISABLE_FSYNC
206 { "disable_fsync", opt_bool, &disable_fsync },
208 { "disable_ipv6", opt_bool, &disable_ipv6 },
210 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
212 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
213 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
214 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
215 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
216 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
217 { "dns_retrans", opt_time, &dns_retrans },
218 { "dns_retry", opt_int, &dns_retry },
219 { "dns_use_edns0", opt_int, &dns_use_edns0 },
220 /* This option is now a no-op, retained for compability */
221 { "drop_cr", opt_bool, &drop_cr },
222 /*********************************************************/
223 { "dsn_from", opt_stringptr, &dsn_from },
224 { "envelope_to_remove", opt_bool, &envelope_to_remove },
225 { "errors_copy", opt_stringptr, &errors_copy },
226 { "errors_reply_to", opt_stringptr, &errors_reply_to },
227 { "exim_group", opt_gid, &exim_gid },
228 { "exim_path", opt_stringptr, &exim_path },
229 { "exim_user", opt_uid, &exim_uid },
230 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
231 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
232 { "finduser_retries", opt_int, &finduser_retries },
233 { "freeze_tell", opt_stringptr, &freeze_tell },
234 { "gecos_name", opt_stringptr, &gecos_name },
235 { "gecos_pattern", opt_stringptr, &gecos_pattern },
237 { "gnutls_compat_mode", opt_bool, &gnutls_compat_mode },
238 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
239 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
240 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
242 { "header_line_maxsize", opt_int, &header_line_maxsize },
243 { "header_maxsize", opt_int, &header_maxsize },
244 { "headers_charset", opt_stringptr, &headers_charset },
245 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
246 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
247 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
248 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
249 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
250 { "hold_domains", opt_stringptr, &hold_domains },
251 { "host_lookup", opt_stringptr, &host_lookup },
252 { "host_lookup_order", opt_stringptr, &host_lookup_order },
253 { "host_reject_connection", opt_stringptr, &host_reject_connection },
254 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
255 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
257 { "ibase_servers", opt_stringptr, &ibase_servers },
259 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
260 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
261 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
262 { "keep_malformed", opt_time, &keep_malformed },
264 { "ldap_ca_cert_dir", opt_stringptr, &eldap_ca_cert_dir },
265 { "ldap_ca_cert_file", opt_stringptr, &eldap_ca_cert_file },
266 { "ldap_cert_file", opt_stringptr, &eldap_cert_file },
267 { "ldap_cert_key", opt_stringptr, &eldap_cert_key },
268 { "ldap_cipher_suite", opt_stringptr, &eldap_cipher_suite },
269 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
270 { "ldap_require_cert", opt_stringptr, &eldap_require_cert },
271 { "ldap_start_tls", opt_bool, &eldap_start_tls },
272 { "ldap_version", opt_int, &eldap_version },
274 { "local_from_check", opt_bool, &local_from_check },
275 { "local_from_prefix", opt_stringptr, &local_from_prefix },
276 { "local_from_suffix", opt_stringptr, &local_from_suffix },
277 { "local_interfaces", opt_stringptr, &local_interfaces },
278 { "local_scan_timeout", opt_time, &local_scan_timeout },
279 { "local_sender_retain", opt_bool, &local_sender_retain },
280 { "localhost_number", opt_stringptr, &host_number_string },
281 { "log_file_path", opt_stringptr, &log_file_path },
282 { "log_selector", opt_stringptr, &log_selector_string },
283 { "log_timezone", opt_bool, &log_timezone },
284 { "lookup_open_max", opt_int, &lookup_open_max },
285 { "max_username_length", opt_int, &max_username_length },
286 { "message_body_newlines", opt_bool, &message_body_newlines },
287 { "message_body_visible", opt_mkint, &message_body_visible },
288 { "message_id_header_domain", opt_stringptr, &message_id_domain },
289 { "message_id_header_text", opt_stringptr, &message_id_text },
290 { "message_logs", opt_bool, &message_logs },
291 { "message_size_limit", opt_stringptr, &message_size_limit },
292 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
293 { "move_frozen_messages", opt_bool, &move_frozen_messages },
295 { "mua_wrapper", opt_bool, &mua_wrapper },
297 { "mysql_servers", opt_stringptr, &mysql_servers },
299 { "never_users", opt_uidlist, &never_users },
301 { "openssl_options", opt_stringptr, &openssl_options },
304 { "oracle_servers", opt_stringptr, &oracle_servers },
306 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
308 { "perl_at_start", opt_bool, &opt_perl_at_start },
309 { "perl_startup", opt_stringptr, &opt_perl_startup },
312 { "pgsql_servers", opt_stringptr, &pgsql_servers },
314 { "pid_file_path", opt_stringptr, &pid_file_path },
315 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
316 { "preserve_message_logs", opt_bool, &preserve_message_logs },
317 { "primary_hostname", opt_stringptr, &primary_hostname },
318 { "print_topbitchars", opt_bool, &print_topbitchars },
319 { "process_log_path", opt_stringptr, &process_log_path },
320 { "prod_requires_admin", opt_bool, &prod_requires_admin },
321 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
322 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
323 { "queue_domains", opt_stringptr, &queue_domains },
324 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
325 { "queue_only", opt_bool, &queue_only },
326 { "queue_only_file", opt_stringptr, &queue_only_file },
327 { "queue_only_load", opt_fixed, &queue_only_load },
328 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
329 { "queue_only_override", opt_bool, &queue_only_override },
330 { "queue_run_in_order", opt_bool, &queue_run_in_order },
331 { "queue_run_max", opt_int, &queue_run_max },
332 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
333 { "receive_timeout", opt_time, &receive_timeout },
334 { "received_header_text", opt_stringptr, &received_header_text },
335 { "received_headers_max", opt_int, &received_headers_max },
336 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
337 { "recipients_max", opt_int, &recipients_max },
338 { "recipients_max_reject", opt_bool, &recipients_max_reject },
339 { "remote_max_parallel", opt_int, &remote_max_parallel },
340 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
341 { "retry_data_expire", opt_time, &retry_data_expire },
342 { "retry_interval_max", opt_time, &retry_interval_max },
343 { "return_path_remove", opt_bool, &return_path_remove },
344 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
345 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
346 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
347 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
348 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
349 { "smtp_accept_max", opt_int, &smtp_accept_max },
350 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
351 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
352 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
353 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
354 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
355 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
356 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
357 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
358 { "smtp_banner", opt_stringptr, &smtp_banner },
359 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
360 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
361 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
362 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
363 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
364 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
365 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
366 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
367 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
368 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
369 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
370 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
371 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
372 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
373 #ifdef WITH_CONTENT_SCAN
374 { "spamd_address", opt_stringptr, &spamd_address },
376 #ifdef EXPERIMENTAL_SPF
377 { "spf_guess", opt_stringptr, &spf_guess },
379 { "split_spool_directory", opt_bool, &split_spool_directory },
380 { "spool_directory", opt_stringptr, &spool_directory },
382 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
384 #ifdef EXPERIMENTAL_SRS
385 { "srs_config", opt_stringptr, &srs_config },
386 { "srs_hashlength", opt_int, &srs_hashlength },
387 { "srs_hashmin", opt_int, &srs_hashmin },
388 { "srs_maxage", opt_int, &srs_maxage },
389 { "srs_secrets", opt_stringptr, &srs_secrets },
390 { "srs_usehash", opt_bool, &srs_usehash },
391 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
393 { "strict_acl_vars", opt_bool, &strict_acl_vars },
394 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
395 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
396 { "syslog_duplication", opt_bool, &syslog_duplication },
397 { "syslog_facility", opt_stringptr, &syslog_facility_str },
398 { "syslog_processname", opt_stringptr, &syslog_processname },
399 { "syslog_timestamp", opt_bool, &syslog_timestamp },
400 { "system_filter", opt_stringptr, &system_filter },
401 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
402 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
403 { "system_filter_group", opt_gid, &system_filter_gid },
404 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
405 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
406 { "system_filter_user", opt_uid, &system_filter_uid },
407 { "tcp_nodelay", opt_bool, &tcp_nodelay },
408 #ifdef USE_TCP_WRAPPERS
409 { "tcp_wrappers_daemon_name", opt_stringptr, &tcp_wrappers_daemon_name },
411 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
412 { "timezone", opt_stringptr, &timezone_string },
414 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
415 { "tls_certificate", opt_stringptr, &tls_certificate },
416 { "tls_crl", opt_stringptr, &tls_crl },
417 { "tls_dhparam", opt_stringptr, &tls_dhparam },
418 #if defined(EXPERIMENTAL_OCSP) && !defined(USE_GNUTLS)
419 { "tls_ocsp_file", opt_stringptr, &tls_ocsp_file },
421 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
422 { "tls_privatekey", opt_stringptr, &tls_privatekey },
423 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
424 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
425 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
426 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
427 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
429 { "trusted_groups", opt_gidlist, &trusted_groups },
430 { "trusted_users", opt_uidlist, &trusted_users },
431 { "unknown_login", opt_stringptr, &unknown_login },
432 { "unknown_username", opt_stringptr, &unknown_username },
433 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
434 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
435 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
436 { "warn_message_file", opt_stringptr, &warn_message_file },
437 { "write_rejectlog", opt_bool, &write_rejectlog }
440 static int optionlist_config_size =
441 sizeof(optionlist_config)/sizeof(optionlist);
445 /*************************************************
446 * Find the name of an option *
447 *************************************************/
449 /* This function is to aid debugging. Various functions take arguments that are
450 pointer variables in the options table or in option tables for various drivers.
451 For debugging output, it is useful to be able to find the name of the option
452 which is currently being processed. This function finds it, if it exists, by
453 searching the table(s).
455 Arguments: a value that is presumed to be in the table above
456 Returns: the option name, or an empty string
460 readconf_find_option(void *p)
464 transport_instance *t;
466 for (i = 0; i < optionlist_config_size; i++)
467 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
469 for (r = routers; r != NULL; r = r->next)
471 router_info *ri = r->info;
472 for (i = 0; i < ri->options_count[0]; i++)
474 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
475 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
476 return US ri->options[i].name;
480 for (t = transports; t != NULL; t = t->next)
482 transport_info *ti = t->info;
483 for (i = 0; i < ti->options_count[0]; i++)
485 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
486 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
487 return US ti->options[i].name;
497 /*************************************************
498 * Deal with an assignment to a macro *
499 *************************************************/
501 /* This function is called when a line that starts with an upper case letter is
502 encountered. The argument "line" should contain a complete logical line, and
503 start with the first letter of the macro name. The macro name and the
504 replacement text are extracted and stored. Redefinition of existing,
505 non-command line, macros is permitted using '==' instead of '='.
508 s points to the start of the logical line
514 read_macro_assignment(uschar *s)
520 macro_item *mlast = NULL;
522 while (isalnum(*s) || *s == '_')
524 if (namelen >= sizeof(name) - 1)
525 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
526 "macro name too long (maximum is " SIZE_T_FMT " characters)", sizeof(name) - 1);
527 name[namelen++] = *s++;
531 while (isspace(*s)) s++;
533 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
540 while (isspace(*s)) s++;
542 /* If an existing macro of the same name was defined on the command line, we
543 just skip this definition. It's an error to attempt to redefine a macro without
544 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
545 It is also an error to define a macro whose name begins with the name of a
546 previously defined macro. Note: it is documented that the other way round
549 for (m = macros; m != NULL; m = m->next)
551 int len = Ustrlen(m->name);
553 if (Ustrcmp(m->name, name) == 0)
555 if (!m->command_line && !redef)
556 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
557 "defined (use \"==\" if you want to redefine it", name);
561 if (len < namelen && Ustrstr(name, m->name) != NULL)
562 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
563 "a macro because previously defined macro \"%s\" is a substring",
566 /* We cannot have this test, because it is documented that a substring
567 macro is permitted (there is even an example).
569 * if (len > namelen && Ustrstr(m->name, name) != NULL)
570 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
571 * "a macro because it is a substring of previously defined macro \"%s\"",
578 /* Check for an overriding command-line definition. */
580 if (m != NULL && m->command_line) return;
582 /* Redefinition must refer to an existing macro. */
587 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
591 /* We have a new definition. The macro_item structure includes a final vector
592 called "name" which is one byte long. Thus, adding "namelen" gives us enough
593 room to store the "name" string. */
597 m = store_get(sizeof(macro_item) + namelen);
598 if (macros == NULL) macros = m; else mlast->next = m;
599 Ustrncpy(m->name, name, namelen);
600 m->name[namelen] = 0;
602 m->command_line = FALSE;
605 /* Set the value of the new or redefined macro */
607 m->replacement = string_copy(s);
614 /*************************************************
615 * Read configuration line *
616 *************************************************/
618 /* A logical line of text is read from the configuration file into the big
619 buffer, taking account of macros, .includes, and continuations. The size of
620 big_buffer is increased if necessary. The count of configuration lines is
621 maintained. Physical input lines starting with # (ignoring leading white space,
622 and after macro replacement) and empty logical lines are always ignored.
623 Leading and trailing spaces are removed.
625 If we hit a line of the form "begin xxxx", the xxxx is placed in the
626 next_section vector, and the function returns NULL, indicating the end of a
627 configuration section. On end-of-file, NULL is returned with next_section
632 Returns: a pointer to the first non-blank in the line,
633 or NULL if eof or end of section is reached
637 get_config_line(void)
639 int startoffset = 0; /* To first non-blank char in logical line */
640 int len = 0; /* Of logical line so far */
646 /* Loop for handling continuation lines, skipping comments, and dealing with
651 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
653 if (config_file_stack != NULL) /* EOF inside .include */
655 (void)fclose(config_file);
656 config_file = config_file_stack->file;
657 config_filename = config_file_stack->filename;
658 config_lineno = config_file_stack->lineno;
659 config_file_stack = config_file_stack->next;
663 /* EOF at top level */
665 if (cstate_stack_ptr >= 0)
666 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
667 "Unexpected end of configuration file: .endif missing");
669 if (len != 0) break; /* EOF after continuation */
670 next_section[0] = 0; /* EOF at start of logical line */
675 newlen = len + Ustrlen(big_buffer + len);
677 /* Handle pathologically long physical lines - yes, it did happen - by
678 extending big_buffer at this point. The code also copes with very long
681 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
684 big_buffer_size += BIG_BUFFER_SIZE;
685 newbuffer = store_malloc(big_buffer_size);
687 /* This use of strcpy is OK because we know that the string in the old
688 buffer is shorter than the new buffer. */
690 Ustrcpy(newbuffer, big_buffer);
691 store_free(big_buffer);
692 big_buffer = newbuffer;
693 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
695 newlen += Ustrlen(big_buffer + newlen);
698 /* Find the true start of the physical line - leading spaces are always
701 ss = big_buffer + len;
702 while (isspace(*ss)) ss++;
704 /* Process the physical line for macros. If this is the start of the logical
705 line, skip over initial text at the start of the line if it starts with an
706 upper case character followed by a sequence of name characters and an equals
707 sign, because that is the definition of a new macro, and we don't do
708 replacement therein. */
711 if (len == 0 && isupper(*s))
713 while (isalnum(*s) || *s == '_') s++;
714 while (isspace(*s)) s++;
715 if (*s != '=') s = ss; /* Not a macro definition */
718 /* For each defined macro, scan the line (from after XXX= if present),
719 replacing all occurrences of the macro. */
722 for (m = macros; m != NULL; m = m->next)
727 while ((p = Ustrstr(t, m->name)) != NULL)
730 int namelen = Ustrlen(m->name);
731 int replen = Ustrlen(m->replacement);
733 /* Expand the buffer if necessary */
735 while (newlen - namelen + replen + 1 > big_buffer_size)
737 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
738 uschar *newbuffer = store_malloc(newsize);
739 memcpy(newbuffer, big_buffer, newlen + 1);
740 p = newbuffer + (p - big_buffer);
741 s = newbuffer + (s - big_buffer);
742 ss = newbuffer + (ss - big_buffer);
743 t = newbuffer + (t - big_buffer);
744 big_buffer_size = newsize;
745 store_free(big_buffer);
746 big_buffer = newbuffer;
749 /* Shuffle the remaining characters up or down in the buffer before
750 copying in the replacement text. Don't rescan the replacement for this
754 moveby = replen - namelen;
757 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
760 Ustrncpy(p, m->replacement, replen);
766 /* An empty macro replacement at the start of a line could mean that ss no
767 longer points to the first non-blank character. */
769 while (isspace(*ss)) ss++;
771 /* Check for comment lines - these are physical lines. */
773 if (*ss == '#') continue;
775 /* Handle conditionals, which are also applied to physical lines. Conditions
776 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
777 expansion occured on the rest of the line. A preliminary test for the leading
778 '.' saves effort on most lines. */
784 /* Search the list of conditional directives */
786 for (i = 0; i < cond_list_size; i++)
789 cond_item *c = cond_list+i;
790 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
792 /* The following character must be white space or end of string */
794 n = ss[1 + c->namelen];
795 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
797 /* .ifdef and .ifndef push the current state onto the stack, then set
798 a new one from the table. Stack overflow is an error */
802 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
803 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
804 ".%s nested too deeply", c->name);
805 cstate_stack[++cstate_stack_ptr] = cstate;
806 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
809 /* For any of the others, stack underflow is an error. The next state
810 comes either from the stack (.endif) or from the table. */
814 if (cstate_stack_ptr < 0)
815 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
816 ".%s without matching .ifdef", c->name);
817 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
818 next_cstate[cstate][macro_found? c->action1 : c->action2];
821 /* Having dealt with a directive, break the loop */
826 /* If we have handled a conditional directive, continue with the next
827 physical line. Otherwise, fall through. */
829 if (i < cond_list_size) continue;
832 /* If the conditional state is not 0 (actively using these lines), ignore
835 if (cstate != 0) continue; /* Conditional skip */
837 /* Handle .include lines - these are also physical lines. */
839 if (Ustrncmp(ss, ".include", 8) == 0 &&
841 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
844 int include_if_exists = isspace(ss[8])? 0 : 10;
845 config_file_item *save;
848 ss += 9 + include_if_exists;
849 while (isspace(*ss)) ss++;
850 t = ss + Ustrlen(ss);
851 while (t > ss && isspace(t[-1])) t--;
852 if (*ss == '\"' && t[-1] == '\"')
860 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
861 "absolute path \"%s\"", ss);
863 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
865 save = store_get(sizeof(config_file_item));
866 save->next = config_file_stack;
867 config_file_stack = save;
868 save->file = config_file;
869 save->filename = config_filename;
870 save->lineno = config_lineno;
872 config_file = Ufopen(ss, "rb");
873 if (config_file == NULL)
874 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
875 "configuration file %s", ss);
876 config_filename = string_copy(ss);
881 /* If this is the start of the logical line, remember where the non-blank
882 data starts. Otherwise shuffle down continuation lines to remove leading
886 startoffset = ss - big_buffer;
889 s = big_buffer + len;
892 memmove(s, ss, (newlen - len) - (ss - s) + 1);
897 /* Accept the new addition to the line. Remove trailing white space. */
900 while (len > 0 && isspace(big_buffer[len-1])) len--;
903 /* We are done if the line does not end in backslash and contains some data.
904 Empty logical lines are ignored. For continuations, remove the backslash and
905 go round the loop to read the continuation line. */
909 if (big_buffer[len-1] != '\\') break; /* End of logical line */
910 big_buffer[--len] = 0; /* Remove backslash */
912 } /* Loop for reading multiple physical lines */
914 /* We now have a logical line. Test for the end of a configuration section (or,
915 more accurately, for the start of the next section). Place the name of the next
916 section in next_section, and return NULL. If the name given is longer than
917 next_section, truncate it. It will be unrecognized later, because all the known
918 section names do fit. Leave space for pluralizing. */
920 s = big_buffer + startoffset; /* First non-space character */
921 if (strncmpic(s, US"begin ", 6) == 0)
924 while (isspace(*s)) s++;
925 if (big_buffer + len - s > sizeof(next_section) - 2)
926 s[sizeof(next_section) - 2] = 0;
927 Ustrcpy(next_section, s);
931 /* Return the first non-blank character. */
938 /*************************************************
940 *************************************************/
942 /* The yield is the pointer to the next uschar. Names longer than the
943 output space are silently truncated. This function is also used from acl.c when
947 name where to put the name
951 Returns: new input pointer
955 readconf_readname(uschar *name, int len, uschar *s)
958 while (isspace(*s)) s++;
961 while (isalnum(*s) || *s == '_')
963 if (p < len-1) name[p++] = *s;
968 while (isspace(*s)) s++;
975 /*************************************************
976 * Read a time value *
977 *************************************************/
979 /* This function is also called from outside, to read argument
980 time values. The format of a time value is:
982 [<n>w][<n>d][<n>h][<n>m][<n>s]
984 as long as at least one is present. If a format error is encountered,
985 return a negative value. The value must be terminated by the given
990 terminator required terminating character
991 return_msec if TRUE, allow fractional seconds and return milliseconds
993 Returns: the time value, or -1 on syntax error
994 value is seconds if return_msec is FALSE
995 value is milliseconds if return_msec is TRUE
999 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
1007 if (!isdigit(*s)) return -1;
1008 (void)sscanf(CS s, "%d%n", &value, &count);
1013 case 'w': value *= 7;
1014 case 'd': value *= 24;
1015 case 'h': value *= 60;
1016 case 'm': value *= 60;
1021 if (!return_msec) return -1;
1022 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1024 if (*s++ != 's') return -1;
1025 yield += (int)(fraction * 1000.0);
1031 if (return_msec) value *= 1000;
1033 if (*s == terminator) return yield;
1035 /* Control never reaches here. */
1040 /*************************************************
1041 * Read a fixed point value *
1042 *************************************************/
1044 /* The value is returned *1000
1048 terminator required terminator
1050 Returns: the value, or -1 on error
1054 readconf_readfixed(uschar *s, int terminator)
1058 if (!isdigit(*s)) return -1;
1059 (void)sscanf(CS s, "%d%n", &value, &count);
1061 yield = value * 1000;
1065 while (isdigit((*(++s))))
1067 yield += (*s - '0') * m;
1072 return (*s == terminator)? yield : (-1);
1077 /*************************************************
1078 * Find option in list *
1079 *************************************************/
1081 /* The lists are always in order, so binary chop can be used.
1084 name the option name to search for
1085 ol the first entry in the option list
1086 last one more than the offset of the last entry in the option list
1088 Returns: pointer to an option entry, or NULL if not found
1092 find_option(uschar *name, optionlist *ol, int last)
1095 while (last > first)
1097 int middle = (first + last)/2;
1098 int c = Ustrcmp(name, ol[middle].name);
1099 if (c == 0) return ol + middle;
1100 else if (c > 0) first = middle + 1;
1108 /*************************************************
1109 * Find a set flag in option list *
1110 *************************************************/
1112 /* Because some versions of Unix make no restrictions on the values of uids and
1113 gids (even negative ones), we cannot represent "unset" by a special value.
1114 There is therefore a separate boolean variable for each one indicating whether
1115 a value is set or not. This function returns a pointer to the boolean, given
1116 the original option name. It is a major disaster if the flag cannot be found.
1119 name the name of the uid or gid option
1120 oltop points to the start of the relevant option list
1121 last one more than the offset of the last item in the option list
1122 data_block NULL when reading main options => data values in the option
1123 list are absolute addresses; otherwise they are byte offsets
1124 in data_block (used for driver options)
1126 Returns: a pointer to the boolean flag.
1130 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1134 sprintf(CS name2, "*set_%.50s", name);
1135 ol = find_option(name2, oltop, last);
1136 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1137 "Exim internal error: missing set flag for %s", name);
1138 return (data_block == NULL)? (BOOL *)(ol->value) :
1139 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1145 /*************************************************
1146 * Output extra characters message and die *
1147 *************************************************/
1149 /* Called when an option line has junk on the end. Sometimes this is because
1150 the sysadmin thinks comments are permitted.
1153 s points to the extra characters
1154 t1..t3 strings to insert in the log message
1156 Returns: doesn't return; dies
1160 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1162 uschar *comment = US"";
1163 if (*s == '#') comment = US" (# is comment only at line start)";
1164 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1165 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1170 /*************************************************
1171 * Read rewrite information *
1172 *************************************************/
1174 /* Each line of rewrite information contains:
1176 . A complete address in the form user@domain, possibly with
1177 leading * for each part; or alternatively, a regex.
1179 . A replacement string (which will be expanded).
1181 . An optional sequence of one-letter flags, indicating which
1182 headers etc. to apply this rule to.
1184 All this is decoded and placed into a control block. The OR of the flags is
1185 maintained in a common word.
1188 p points to the string that makes up the rule
1189 existflags points to the overall flag word
1190 isglobal TRUE if reading global rewrite rules
1192 Returns: the control block for the parsed rule.
1195 static rewrite_rule *
1196 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1198 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1201 next->key = string_dequote(&p);
1203 while (isspace(*p)) p++;
1205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1206 "missing rewrite replacement string");
1209 next->replacement = string_dequote(&p);
1211 while (*p != 0) switch (*p++)
1213 case ' ': case '\t': break;
1215 case 'q': next->flags |= rewrite_quit; break;
1216 case 'w': next->flags |= rewrite_whole; break;
1218 case 'h': next->flags |= rewrite_all_headers; break;
1219 case 's': next->flags |= rewrite_sender; break;
1220 case 'f': next->flags |= rewrite_from; break;
1221 case 't': next->flags |= rewrite_to; break;
1222 case 'c': next->flags |= rewrite_cc; break;
1223 case 'b': next->flags |= rewrite_bcc; break;
1224 case 'r': next->flags |= rewrite_replyto; break;
1226 case 'E': next->flags |= rewrite_all_envelope; break;
1227 case 'F': next->flags |= rewrite_envfrom; break;
1228 case 'T': next->flags |= rewrite_envto; break;
1230 case 'Q': next->flags |= rewrite_qualify; break;
1231 case 'R': next->flags |= rewrite_repeat; break;
1234 next->flags |= rewrite_smtp;
1235 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1236 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1237 "rewrite rule has the S flag but is not a regular expression");
1241 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1242 "unknown rewrite flag character '%c' "
1243 "(could be missing quotes round replacement item)", p[-1]);
1247 /* If no action flags are set, set all the "normal" rewrites. */
1249 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1250 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1252 /* Remember which exist, for optimization, and return the rule */
1254 *existflags |= next->flags;
1261 /*************************************************
1262 * Read global rewrite information *
1263 *************************************************/
1265 /* Each line is a single rewrite rule; it is parsed into a control block
1266 by readconf_one_rewrite(), and its flags are ORed into the global flag
1267 word rewrite_existflags. */
1270 readconf_rewrites(void)
1272 rewrite_rule **chain = &global_rewrite_rules;
1275 while ((p = get_config_line()) != NULL)
1277 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1279 chain = &(next->next);
1285 /*************************************************
1287 *************************************************/
1289 /* Strings are read into the normal store pool. As long we aren't too
1290 near the end of the current block, the string will just use what is necessary
1291 on the top of the stacking pool, because string_cat() uses the extension
1295 s the rest of the input line
1296 name the option name (for errors)
1298 Returns: pointer to the string
1302 read_string(uschar *s, uschar *name)
1307 if (*s != '\"') return string_copy(s);
1310 yield = string_dequote(&s);
1312 if (s == ss+1 || s[-1] != '\"')
1313 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1314 "missing quote at end of string value for %s", name);
1316 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1322 /*************************************************
1323 * Handle option line *
1324 *************************************************/
1326 /* This function is called from several places to process a line containing the
1327 setting of an option. The first argument is the line to be decoded; it has been
1328 checked not to be empty and not to start with '#'. Trailing newlines and white
1329 space have been removed. The second argument is a pointer to the list of
1330 variable names that are to be recognized, together with their types and
1331 locations, and the third argument gives the number of entries in the list.
1333 The fourth argument is a pointer to a data block. If it is NULL, then the data
1334 values in the options list are absolute addresses. Otherwise, they are byte
1335 offsets in the data block.
1337 String option data may continue onto several lines; this function reads further
1338 data from config_file if necessary.
1340 The yield of this function is normally zero. If a string continues onto
1341 multiple lines, then the data value is permitted to be followed by a comma
1342 or a semicolon (for use in drivers) and the yield is that character.
1345 buffer contains the configuration line to be handled
1346 oltop points to the start of the relevant option list
1347 last one more than the offset of the last item in the option list
1348 data_block NULL when reading main options => data values in the option
1349 list are absolute addresses; otherwise they are byte offsets
1350 in data_block when they have opt_public set; otherwise
1351 they are byte offsets in data_block->options_block.
1352 unknown_txt format string to use in panic message for unknown option;
1353 must contain %s for option name
1354 if given as NULL, don't panic on unknown option
1356 Returns: TRUE if an option was read successfully,
1357 FALSE false for an unknown option if unknown_txt == NULL,
1358 otherwise panic and die on an unknown option
1362 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1363 void *data_block, uschar *unknown_txt)
1367 int n, count, type, value;
1371 BOOL boolvalue = TRUE;
1372 BOOL freesptr = TRUE;
1373 BOOL extra_condition = FALSE;
1374 optionlist *ol, *ol2;
1378 uschar *inttype = US"";
1381 uschar *saved_condition, *strtemp;
1382 uschar **str_target;
1386 /* There may be leading spaces; thereafter, we expect an option name starting
1389 while (isspace(*s)) s++;
1391 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1393 /* Read the name of the option, and skip any subsequent white space. If
1394 it turns out that what we read was "hide", set the flag indicating that
1395 this is a secure option, and loop to read the next word. */
1397 for (n = 0; n < 2; n++)
1399 while (isalnum(*s) || *s == '_')
1401 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1405 while (isspace(*s)) s++;
1406 if (Ustrcmp(name, "hide") != 0) break;
1407 issecure = opt_secure;
1411 /* Deal with "no_" or "not_" here for booleans */
1413 if (Ustrncmp(name, "no_", 3) == 0)
1419 if (Ustrncmp(name, "not_", 4) == 0)
1425 /* Search the list for the given name. A non-existent name, or an option that
1426 is set twice, is a disaster. */
1428 ol = find_option(name + offset, oltop, last);
1432 if (unknown_txt == NULL) return FALSE;
1433 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1436 if ((ol->type & opt_set) != 0)
1438 uschar *mname = name;
1439 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1440 if (Ustrcmp(mname, "condition") == 0)
1441 extra_condition = TRUE;
1443 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1444 "\"%s\" option set for the second time", mname);
1447 ol->type |= opt_set | issecure;
1448 type = ol->type & opt_mask;
1450 /* Types with data values must be followed by '='; the "no[t]_" prefix
1451 applies only to boolean values. */
1453 if (type < opt_bool || type > opt_bool_last)
1456 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1457 "negation prefix applied to a non-boolean option");
1459 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1460 "unexpected end of line (data missing) after %s", name);
1462 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1465 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1466 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1467 ultimately expands to one of those values. */
1469 else if (*s != 0 && (offset != 0 || *s != '='))
1470 extra_chars_error(s, US"boolean option ", name, US"");
1472 /* Skip white space after = */
1474 if (*s == '=') while (isspace((*(++s))));
1476 /* If there is a data block and the opt_public flag is not set, change
1477 the data block pointer to the private options block. */
1479 if (data_block != NULL && (ol->type & opt_public) == 0)
1480 data_block = (void *)(((driver_instance *)data_block)->options_block);
1482 /* Now get the data according to the type. */
1486 /* If a string value is not enclosed in quotes, it consists of
1487 the rest of the current line, verbatim. Otherwise, string escapes
1490 A transport is specified as a string, which is then looked up in the
1491 list of transports. A search type is specified as one of a number of
1494 A set or rewrite rules for a driver is specified as a string, which is
1495 then parsed into a suitable chain of control blocks.
1497 Uids and gids are specified as strings which are then looked up in the
1498 passwd file. Lists of uids and gids are similarly specified as colon-
1499 separated strings. */
1504 case opt_expand_uid:
1505 case opt_expand_gid:
1510 reset_point = sptr = read_string(s, name);
1512 /* Having read a string, we now have several different ways of using it,
1513 depending on the data type, so do another switch. If keeping the actual
1514 string is not required (because it is interpreted), freesptr is set TRUE,
1515 and at the end we reset the pool. */
1519 /* If this was a string, set the variable to point to the new string,
1520 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1521 rules, we still keep the string (for printing), and parse the rules into a
1522 control block and flags word. */
1525 if (data_block == NULL)
1526 str_target = (uschar **)(ol->value);
1528 str_target = (uschar **)((uschar *)data_block + (long int)(ol->value));
1529 if (extra_condition)
1531 /* We already have a condition, we're conducting a crude hack to let
1532 multiple condition rules be chained together, despite storing them in
1534 saved_condition = *str_target;
1535 strtemp = string_sprintf("${if and{{bool_lax{%s}}{bool_lax{%s}}}}",
1536 saved_condition, sptr);
1537 *str_target = string_copy_malloc(strtemp);
1538 /* TODO(pdp): there is a memory leak here when we set 3 or more
1539 conditions; I still don't understand the store mechanism enough
1540 to know what's the safe way to free content from an earlier store.
1541 AFAICT, stores stack, so freeing an early stored item also stores
1542 all data alloc'd after it. If we knew conditions were adjacent,
1543 we could survive that, but we don't. So I *think* we need to take
1544 another bit from opt_type to indicate "malloced"; this seems like
1545 quite a hack, especially for this one case. It also means that
1546 we can't ever reclaim the store from the *first* condition.
1548 Because we only do this once, near process start-up, I'm prepared to
1549 let this slide for the time being, even though it rankles. */
1559 if (data_block == NULL)
1560 *((uschar **)(ol->value)) = sptr;
1562 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1564 if (type == opt_rewrite)
1569 rewrite_rule **chain;
1572 sprintf(CS name2, "*%.50s_rules", name);
1573 ol2 = find_option(name2, oltop, last);
1574 sprintf(CS name2, "*%.50s_flags", name);
1575 ol3 = find_option(name2, oltop, last);
1577 if (ol2 == NULL || ol3 == NULL)
1578 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1579 "rewrite rules not available for driver");
1581 if (data_block == NULL)
1583 chain = (rewrite_rule **)(ol2->value);
1584 flagptr = (int *)(ol3->value);
1588 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1589 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1592 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1595 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1597 chain = &(next->next);
1600 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1601 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1602 "non-header rewrite - not allowed at transport time -");
1606 /* If it was an expanded uid, see if there is any expansion to be
1607 done by checking for the presence of a $ character. If there is, save it
1608 in the corresponding *expand_user option field. Otherwise, fall through
1609 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1612 case opt_expand_uid:
1613 sprintf(CS name2, "*expand_%.50s", name);
1614 ol2 = find_option(name2, oltop, last);
1617 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1619 if (data_block == NULL)
1620 *((uschar **)(ol2->value)) = ss;
1622 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1626 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1632 /* Look up a fixed uid, and also make use of the corresponding gid
1633 if a passwd entry is returned and the gid has not been set. */
1636 if (!route_finduser(sptr, &pw, &uid))
1637 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1638 if (data_block == NULL)
1639 *((uid_t *)(ol->value)) = uid;
1641 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1643 /* Set the flag indicating a fixed value is set */
1645 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1647 /* Handle matching gid if we have a passwd entry: done by finding the
1648 same name with terminating "user" changed to "group"; if not found,
1649 ignore. Also ignore if the value is already set. */
1651 if (pw == NULL) break;
1652 Ustrcpy(name+Ustrlen(name)-4, "group");
1653 ol2 = find_option(name, oltop, last);
1654 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1655 (ol2->type & opt_mask) == opt_expand_gid))
1657 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1660 if (data_block == NULL)
1661 *((gid_t *)(ol2->value)) = pw->pw_gid;
1663 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1669 /* If it was an expanded gid, see if there is any expansion to be
1670 done by checking for the presence of a $ character. If there is, save it
1671 in the corresponding *expand_user option field. Otherwise, fall through
1672 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1675 case opt_expand_gid:
1676 sprintf(CS name2, "*expand_%.50s", name);
1677 ol2 = find_option(name2, oltop, last);
1680 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1682 if (data_block == NULL)
1683 *((uschar **)(ol2->value)) = ss;
1685 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1689 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1695 /* Handle freestanding gid */
1698 if (!route_findgroup(sptr, &gid))
1699 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1700 if (data_block == NULL)
1701 *((gid_t *)(ol->value)) = gid;
1703 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1704 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1707 /* If it was a uid list, look up each individual entry, and build
1708 a vector of uids, with a count in the first element. Put the vector
1709 in malloc store so we can free the string. (We are reading into
1710 permanent store already.) */
1718 uschar *op = expand_string (sptr);
1721 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1722 name, expand_string_message);
1725 if (*p != 0) count++;
1726 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1727 list = store_malloc(count*sizeof(uid_t));
1728 list[ptr++] = (uid_t)(count - 1);
1730 if (data_block == NULL)
1731 *((uid_t **)(ol->value)) = list;
1733 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1739 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1740 if (!route_finduser(big_buffer, NULL, &uid))
1741 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1748 /* If it was a gid list, look up each individual entry, and build
1749 a vector of gids, with a count in the first element. Put the vector
1750 in malloc store so we can free the string. (We are reading into permanent
1759 uschar *op = expand_string (sptr);
1762 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1763 name, expand_string_message);
1766 if (*p != 0) count++;
1767 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1768 list = store_malloc(count*sizeof(gid_t));
1769 list[ptr++] = (gid_t)(count - 1);
1771 if (data_block == NULL)
1772 *((gid_t **)(ol->value)) = list;
1774 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1780 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1781 if (!route_findgroup(big_buffer, &gid))
1782 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1790 /* Release store if the value of the string doesn't need to be kept. */
1792 if (freesptr) store_reset(reset_point);
1795 /* Expanded boolean: if no characters follow, or if there are no dollar
1796 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1797 save the string for later expansion in the alternate place. */
1799 case opt_expand_bool:
1800 if (*s != 0 && Ustrchr(s, '$') != 0)
1802 sprintf(CS name2, "*expand_%.50s", name);
1803 ol2 = find_option(name2, oltop, last);
1806 reset_point = sptr = read_string(s, name);
1807 if (data_block == NULL)
1808 *((uschar **)(ol2->value)) = sptr;
1810 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1817 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1818 look for yes/not/true/false. Some booleans are stored in a single bit in
1819 a single int. There's a special fudge for verify settings; without a suffix
1820 they set both xx_sender and xx_recipient. The table points to the sender
1821 value; search subsequently for the recipient. There's another special case:
1822 opt_bool_set also notes when a boolean has been set. */
1826 case opt_bool_verify:
1830 s = readconf_readname(name2, 64, s);
1831 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1833 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1835 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1836 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1837 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1838 US"for boolean option ", name);
1841 /* Handle single-bit type. */
1843 if (type == opt_bit)
1845 int bit = 1 << ((ol->type >> 16) & 31);
1846 int *ptr = (data_block == NULL)?
1847 (int *)(ol->value) :
1848 (int *)((uschar *)data_block + (long int)ol->value);
1849 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1853 /* Handle full BOOL types */
1855 if (data_block == NULL)
1856 *((BOOL *)(ol->value)) = boolvalue;
1858 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1862 if (type == opt_bool_verify)
1864 sprintf(CS name2, "%.50s_recipient", name + offset);
1865 ol2 = find_option(name2, oltop, last);
1868 if (data_block == NULL)
1869 *((BOOL *)(ol2->value)) = boolvalue;
1871 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1875 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1877 else if (type == opt_bool_set)
1879 sprintf(CS name2, "*set_%.50s", name + offset);
1880 ol2 = find_option(name2, oltop, last);
1883 if (data_block == NULL)
1884 *((BOOL *)(ol2->value)) = TRUE;
1886 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1895 inttype = US"octal ";
1897 /* Integer: a simple(ish) case; allow octal and hex formats, and
1898 suffixes K and M. The different types affect output, not input. */
1907 lvalue = strtol(CS s, CSS &endptr, intbase);
1910 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1913 if (errno != ERANGE)
1915 if (tolower(*endptr) == 'k')
1917 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1918 else lvalue *= 1024;
1921 else if (tolower(*endptr) == 'm')
1923 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1925 else lvalue *= 1024*1024;
1930 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1931 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1932 "absolute value of integer \"%s\" is too large (overflow)", s);
1934 while (isspace(*endptr)) endptr++;
1936 extra_chars_error(endptr, inttype, US"integer value for ", name);
1938 value = (int)lvalue;
1941 if (data_block == NULL)
1942 *((int *)(ol->value)) = value;
1944 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1947 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1954 value = strtol(CS s, CSS &endptr, intbase);
1957 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1960 if (errno != ERANGE)
1962 if (tolower(*endptr) == 'm')
1964 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1968 else if (tolower(*endptr) == 'k')
1974 value = (value + 512)/1024;
1978 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1979 "absolute value of integer \"%s\" is too large (overflow)", s);
1981 while (isspace(*endptr)) endptr++;
1983 extra_chars_error(endptr, inttype, US"integer value for ", name);
1986 if (data_block == NULL)
1987 *((int *)(ol->value)) = value;
1989 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1992 /* Fixed-point number: held to 3 decimal places. */
1995 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1996 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1997 "fixed-point number expected for %s", name);
1999 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2000 "integer \"%s\" is too large (overflow)", s);
2004 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2005 "integer \"%s\" is too large (overflow)", s);
2007 if (s[count] == '.')
2010 while (isdigit(s[++count]))
2012 value += (s[count] - '0') * d;
2017 while (isspace(s[count])) count++;
2020 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
2022 if (data_block == NULL)
2023 *((int *)(ol->value)) = value;
2025 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2028 /* There's a special routine to read time values. */
2031 value = readconf_readtime(s, 0, FALSE);
2033 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2035 if (data_block == NULL)
2036 *((int *)(ol->value)) = value;
2038 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
2041 /* A time list is a list of colon-separated times, with the first
2042 element holding the size of the list and the second the number of
2048 int *list = (data_block == NULL)?
2049 (int *)(ol->value) :
2050 (int *)((uschar *)data_block + (long int)(ol->value));
2052 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2055 uschar *snext = Ustrchr(s, ':');
2059 while (ss > s && isspace(ss[-1])) ss--;
2062 value = readconf_readtime(s, terminator, FALSE);
2064 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2066 if (count > 1 && value <= list[count])
2067 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2068 "time value out of order for %s", name);
2069 list[count+1] = value;
2070 if (snext == NULL) break;
2072 while (isspace(*s)) s++;
2075 if (count > list[0] - 2)
2076 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2078 if (count > 0 && list[2] == 0) count = 0;
2090 /*************************************************
2091 * Print a time value *
2092 *************************************************/
2095 Argument: a time value in seconds
2096 Returns: pointer to a fixed buffer containing the time as a string,
2097 in readconf_readtime() format
2101 readconf_printtime(int t)
2104 uschar *p = time_buffer;
2121 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2122 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2123 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2124 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2125 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2132 /*************************************************
2133 * Print an individual option value *
2134 *************************************************/
2136 /* This is used by the -bP option, so prints to the standard output.
2137 The entire options list is passed in as an argument, because some options come
2138 in pairs - typically uid/gid settings, which can either be explicit numerical
2139 values, or strings to be expanded later. If the numerical value is unset,
2140 search for "*expand_<name>" to see if there is a string equivalent.
2143 ol option entry, or NULL for an unknown option
2145 options_block NULL for main configuration options; otherwise points to
2146 a driver block; if the option doesn't have opt_public
2147 set, then options_block->options_block is where the item
2149 oltop points to the option list in which ol exists
2150 last one more than the offset of the last entry in optop
2156 print_ol(optionlist *ol, uschar *name, void *options_block,
2157 optionlist *oltop, int last)
2170 printf("%s is not a known option\n", name);
2174 /* Non-admin callers cannot see options that have been flagged secure by the
2177 if (!admin_user && (ol->type & opt_secure) != 0)
2179 printf("%s = <value not displayable>\n", name);
2183 /* Else show the value of the option */
2186 if (options_block != NULL)
2188 if ((ol->type & opt_public) == 0)
2189 options_block = (void *)(((driver_instance *)options_block)->options_block);
2190 value = (void *)((uschar *)options_block + (long int)value);
2193 switch(ol->type & opt_mask)
2196 case opt_rewrite: /* Show the text value */
2197 s = *((uschar **)value);
2198 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2202 printf("%s = %d\n", name, *((int *)value));
2207 int x = *((int *)value);
2208 if (x != 0 && (x & 1023) == 0)
2212 if ((x & 1023) == 0)
2217 printf("%s = %d%c\n", name, x, c);
2219 else printf("%s = %d\n", name, x);
2225 int x = *((int *)value);
2226 if (x == 0) printf("%s = 0\n", name);
2227 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2228 else printf("%s = %dK\n", name, x);
2233 printf("%s = %#o\n", name, *((int *)value));
2236 /* Can be negative only when "unset", in which case integer */
2240 int x = *((int *)value);
2243 if (x < 0) printf("%s =\n", name); else
2245 printf("%s = %d.", name, x/1000);
2258 /* If the numerical value is unset, try for the string value */
2260 case opt_expand_uid:
2261 if (! *get_set_flag(name, oltop, last, options_block))
2263 sprintf(CS name2, "*expand_%.50s", name);
2264 ol2 = find_option(name2, oltop, last);
2267 void *value2 = ol2->value;
2268 if (options_block != NULL)
2269 value2 = (void *)((uschar *)options_block + (long int)value2);
2270 s = *((uschar **)value2);
2271 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2276 /* Else fall through */
2279 if (! *get_set_flag(name, oltop, last, options_block))
2280 printf("%s =\n", name);
2283 pw = getpwuid(*((uid_t *)value));
2285 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2286 else printf("%s = %s\n", name, pw->pw_name);
2290 /* If the numerical value is unset, try for the string value */
2292 case opt_expand_gid:
2293 if (! *get_set_flag(name, oltop, last, options_block))
2295 sprintf(CS name2, "*expand_%.50s", name);
2296 ol2 = find_option(name2, oltop, last);
2297 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2299 void *value2 = ol2->value;
2300 if (options_block != NULL)
2301 value2 = (void *)((uschar *)options_block + (long int)value2);
2302 s = *((uschar **)value2);
2303 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2308 /* Else fall through */
2311 if (! *get_set_flag(name, oltop, last, options_block))
2312 printf("%s =\n", name);
2315 gr = getgrgid(*((int *)value));
2317 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2318 else printf("%s = %s\n", name, gr->gr_name);
2323 uidlist = *((uid_t **)value);
2324 printf("%s =", name);
2325 if (uidlist != NULL)
2329 for (i = 1; i <= (int)(uidlist[0]); i++)
2331 uschar *name = NULL;
2332 pw = getpwuid(uidlist[i]);
2333 if (pw != NULL) name = US pw->pw_name;
2334 if (name != NULL) printf("%c%s", sep, name);
2335 else printf("%c%ld", sep, (long int)(uidlist[i]));
2343 gidlist = *((gid_t **)value);
2344 printf("%s =", name);
2345 if (gidlist != NULL)
2349 for (i = 1; i <= (int)(gidlist[0]); i++)
2351 uschar *name = NULL;
2352 gr = getgrgid(gidlist[i]);
2353 if (gr != NULL) name = US gr->gr_name;
2354 if (name != NULL) printf("%c%s", sep, name);
2355 else printf("%c%ld", sep, (long int)(gidlist[i]));
2363 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2369 int *list = (int *)value;
2370 printf("%s = ", name);
2371 for (i = 0; i < list[1]; i++)
2372 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2378 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2382 case opt_expand_bool:
2383 sprintf(CS name2, "*expand_%.50s", name);
2384 ol2 = find_option(name2, oltop, last);
2385 if (ol2 != NULL && ol2->value != NULL)
2387 void *value2 = ol2->value;
2388 if (options_block != NULL)
2389 value2 = (void *)((uschar *)options_block + (long int)value2);
2390 s = *((uschar **)value2);
2393 printf("%s = %s\n", name, string_printing(s));
2396 /* s == NULL => string not set; fall through */
2402 case opt_bool_verify:
2404 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2411 /*************************************************
2412 * Print value from main configuration *
2413 *************************************************/
2415 /* This function, called as a result of encountering the -bP option,
2416 causes the value of any main configuration variable to be output if the
2417 second argument is NULL. There are some special values:
2419 all print all main configuration options
2420 configure_file print the name of the configuration file
2421 routers print the routers' configurations
2422 transports print the transports' configuration
2423 authenticators print the authenticators' configuration
2424 macros print the macros' configuration
2425 router_list print a list of router names
2426 transport_list print a list of transport names
2427 authenticator_list print a list of authentication mechanism names
2428 macro_list print a list of macro names
2429 +name print a named list item
2430 local_scan print the local_scan options
2432 If the second argument is not NULL, it must be one of "router", "transport",
2433 "authenticator" or "macro" in which case the first argument identifies the
2434 driver whose options are to be printed.
2437 name option name if type == NULL; else driver name
2438 type NULL or driver type name, as described above
2444 readconf_print(uschar *name, uschar *type)
2446 BOOL names_only = FALSE;
2448 optionlist *ol2 = NULL;
2449 driver_instance *d = NULL;
2460 static uschar *types[] = { US"address", US"domain", US"host",
2462 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2463 &hostlist_anchor, &localpartlist_anchor };
2465 for (i = 0; i < 4; i++)
2467 t = tree_search(*(anchors[i]), name+1);
2471 printf("%slist %s = %s\n", types[i], name+1,
2472 ((namedlist_block *)(t->data.ptr))->string);
2477 printf("no address, domain, host, or local part list called \"%s\" "
2478 "exists\n", name+1);
2483 if (Ustrcmp(name, "configure_file") == 0)
2485 printf("%s\n", CS config_main_filename);
2489 if (Ustrcmp(name, "all") == 0)
2491 for (ol = optionlist_config;
2492 ol < optionlist_config + optionlist_config_size; ol++)
2494 if ((ol->type & opt_hidden) == 0)
2495 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2500 if (Ustrcmp(name, "local_scan") == 0)
2502 #ifndef LOCAL_SCAN_HAS_OPTIONS
2503 printf("local_scan() options are not supported\n");
2505 for (ol = local_scan_options;
2506 ol < local_scan_options + local_scan_options_count; ol++)
2508 print_ol(ol, US ol->name, NULL, local_scan_options,
2509 local_scan_options_count);
2515 if (Ustrcmp(name, "routers") == 0)
2520 else if (Ustrcmp(name, "transports") == 0)
2522 type = US"transport";
2526 else if (Ustrcmp(name, "authenticators") == 0)
2528 type = US"authenticator";
2532 else if (Ustrcmp(name, "macros") == 0)
2538 else if (Ustrcmp(name, "router_list") == 0)
2545 else if (Ustrcmp(name, "transport_list") == 0)
2547 type = US"transport";
2552 else if (Ustrcmp(name, "authenticator_list") == 0)
2554 type = US"authenticator";
2559 else if (Ustrcmp(name, "macro_list") == 0)
2568 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2569 name, NULL, optionlist_config, optionlist_config_size);
2574 /* Handle the options for a router or transport. Skip options that are flagged
2575 as hidden. Some of these are options with names starting with '*', used for
2576 internal alternative representations of other options (which the printing
2577 function will sort out). Others are synonyms kept for backward compatibility.
2580 if (Ustrcmp(type, "router") == 0)
2582 d = (driver_instance *)routers;
2583 ol2 = optionlist_routers;
2584 size = optionlist_routers_size;
2586 else if (Ustrcmp(type, "transport") == 0)
2588 d = (driver_instance *)transports;
2589 ol2 = optionlist_transports;
2590 size = optionlist_transports_size;
2592 else if (Ustrcmp(type, "authenticator") == 0)
2594 d = (driver_instance *)auths;
2595 ol2 = optionlist_auths;
2596 size = optionlist_auths_size;
2599 else if (Ustrcmp(type, "macro") == 0)
2601 /* People store passwords in macros and they were previously not available
2602 for printing. So we have an admin_users restriction. */
2605 fprintf(stderr, "exim: permission denied\n");
2608 for (m = macros; m != NULL; m = m->next)
2610 if (name == NULL || Ustrcmp(name, m->name) == 0)
2613 printf("%s\n", CS m->name);
2615 printf("%s=%s\n", CS m->name, CS m->replacement);
2621 printf("%s %s not found\n", type, name);
2627 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2631 /* Either search for a given driver, or print all of them */
2633 for (; d != NULL; d = d->next)
2636 printf("\n%s %s:\n", d->name, type);
2637 else if (Ustrcmp(d->name, name) != 0) continue;
2639 for (ol = ol2; ol < ol2 + size; ol++)
2641 if ((ol->type & opt_hidden) == 0)
2642 print_ol(ol, US ol->name, d, ol2, size);
2645 for (ol = d->info->options;
2646 ol < d->info->options + *(d->info->options_count); ol++)
2648 if ((ol->type & opt_hidden) == 0)
2649 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2651 if (name != NULL) return;
2653 if (name != NULL) printf("%s %s not found\n", type, name);
2658 /*************************************************
2659 * Read a named list item *
2660 *************************************************/
2662 /* This function reads a name and a list (i.e. string). The name is used to
2663 save the list in a tree, sorted by its name. Each entry also has a number,
2664 which can be used for caching tests, but if the string contains any expansion
2665 items other than $key, the number is set negative to inhibit caching. This
2666 mechanism is used for domain, host, and address lists that are referenced by
2670 anchorp points to the tree anchor
2671 numberp points to the current number for this tree
2672 max the maximum number permitted
2673 s the text of the option line, starting immediately after the name
2675 tname the name of the list type, for messages
2681 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2684 BOOL forcecache = FALSE;
2687 namedlist_block *nb = store_get(sizeof(namedlist_block));
2689 if (Ustrncmp(s, "_cache", 6) == 0)
2696 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2698 if (*numberp >= max)
2699 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2702 while (isspace(*s)) s++;
2704 while (isalnum(*s) || *s == '_') s++;
2705 t = store_get(sizeof(tree_node) + s-ss);
2706 Ustrncpy(t->name, ss, s-ss);
2708 while (isspace(*s)) s++;
2710 if (!tree_insertnode(anchorp, t))
2711 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2712 "duplicate name \"%s\" for a named %s", t->name, tname);
2715 nb->number = *numberp;
2718 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2719 "missing '=' after \"%s\"", t->name);
2720 while (isspace(*s)) s++;
2721 nb->string = read_string(s, t->name);
2722 nb->cache_data = NULL;
2724 /* Check the string for any expansions; if any are found, mark this list
2725 uncacheable unless the user has explicited forced caching. */
2727 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2733 /*************************************************
2734 * Unpick data for a rate limit *
2735 *************************************************/
2737 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2741 s string, in the form t,b,f,l
2742 where t is the threshold (integer)
2743 b is the initial delay (time)
2744 f is the multiplicative factor (fixed point)
2745 k is the maximum time (time)
2746 threshold where to store threshold
2747 base where to store base in milliseconds
2748 factor where to store factor in milliseconds
2749 limit where to store limit
2751 Returns: nothing (panics on error)
2755 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2758 uschar bstring[16], lstring[16];
2760 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2761 factor, lstring) == 4)
2763 *base = readconf_readtime(bstring, 0, TRUE);
2764 *limit = readconf_readtime(lstring, 0, TRUE);
2765 if (*base >= 0 && *limit >= 0) return;
2767 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2773 /*************************************************
2774 * Read main configuration options *
2775 *************************************************/
2777 /* This function is the first to be called for configuration reading. It
2778 opens the configuration file and reads general configuration settings until
2779 it reaches the end of the configuration section. The file is then left open so
2780 that the remaining configuration data can subsequently be read if needed for
2783 The configuration file must be owned either by root or exim, and be writeable
2784 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2785 in the config file, so the test is done on the compiled in values. A slight
2786 anomaly, to be carefully documented.
2788 The name of the configuration file is taken from a list that is included in the
2789 binary of Exim. It can be altered from the command line, but if that is done,
2790 root privilege is immediately withdrawn unless the caller is root or exim.
2791 The first file on the list that exists is used.
2793 For use on multiple systems that share file systems, first look for a
2794 configuration file whose name has the current node name on the end. If that is
2795 not found, try the generic name. For really contorted configurations, that run
2796 multiple Exims with different uid settings, first try adding the effective uid
2797 before the node name. These complications are going to waste resources on most
2798 systems. Therefore they are available only when requested by compile-time
2805 struct stat statbuf;
2806 uschar *s, *filename;
2807 uschar *list = config_main_filelist;
2809 /* Loop through the possible file names */
2811 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2814 /* Cut out all the fancy processing unless specifically wanted */
2816 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2817 uschar *suffix = filename + Ustrlen(filename);
2819 /* Try for the node-specific file if a node name exists */
2821 #ifdef CONFIGURE_FILE_USE_NODE
2823 if (uname(&uts) >= 0)
2825 #ifdef CONFIGURE_FILE_USE_EUID
2826 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2827 config_file = Ufopen(filename, "rb");
2828 if (config_file == NULL)
2829 #endif /* CONFIGURE_FILE_USE_EUID */
2831 sprintf(CS suffix, ".%.256s", uts.nodename);
2832 config_file = Ufopen(filename, "rb");
2835 #endif /* CONFIGURE_FILE_USE_NODE */
2837 /* Otherwise, try the generic name, possibly with the euid added */
2839 #ifdef CONFIGURE_FILE_USE_EUID
2840 if (config_file == NULL)
2842 sprintf(CS suffix, ".%ld", (long int)original_euid);
2843 config_file = Ufopen(filename, "rb");
2845 #endif /* CONFIGURE_FILE_USE_EUID */
2847 /* Finally, try the unadorned name */
2849 if (config_file == NULL)
2852 config_file = Ufopen(filename, "rb");
2854 #else /* if neither defined */
2856 /* This is the common case when the fancy processing is not included. */
2858 config_file = Ufopen(filename, "rb");
2861 /* If the file does not exist, continue to try any others. For any other
2862 error, break out (and die). */
2864 if (config_file != NULL || errno != ENOENT) break;
2867 /* On success, save the name for verification; config_filename is used when
2868 logging configuration errors (it changes for .included files) whereas
2869 config_main_filename is the name shown by -bP. Failure to open a configuration
2870 file is a serious disaster. */
2872 if (config_file != NULL)
2874 config_filename = config_main_filename = string_copy(filename);
2878 if (filename == NULL)
2879 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2880 "%s", config_main_filelist);
2882 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2883 "configuration file %s", filename));
2886 /* Check the status of the file we have opened, if we have retained root
2887 privileges and the file isn't /dev/null (which *should* be 0666). */
2889 if (trusted_config && Ustrcmp(filename, US"/dev/null"))
2891 if (fstat(fileno(config_file), &statbuf) != 0)
2892 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2895 if ((statbuf.st_uid != root_uid /* owner not root */
2896 #ifdef CONFIGURE_OWNER
2897 && statbuf.st_uid != config_uid /* owner not the special one */
2900 (statbuf.st_gid != root_gid /* group not root & */
2901 #ifdef CONFIGURE_GROUP
2902 && statbuf.st_gid != config_gid /* group not the special one */
2904 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2906 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2908 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2909 "wrong owner, group, or mode", big_buffer);
2912 /* Process the main configuration settings. They all begin with a lower case
2913 letter. If we see something starting with an upper case letter, it is taken as
2914 a macro definition. */
2916 while ((s = get_config_line()) != NULL)
2918 if (isupper(s[0])) read_macro_assignment(s);
2920 else if (Ustrncmp(s, "domainlist", 10) == 0)
2921 read_named_list(&domainlist_anchor, &domainlist_count,
2922 MAX_NAMED_LIST, s+10, US"domain list");
2924 else if (Ustrncmp(s, "hostlist", 8) == 0)
2925 read_named_list(&hostlist_anchor, &hostlist_count,
2926 MAX_NAMED_LIST, s+8, US"host list");
2928 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2929 read_named_list(&addresslist_anchor, &addresslist_count,
2930 MAX_NAMED_LIST, s+11, US"address list");
2932 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2933 read_named_list(&localpartlist_anchor, &localpartlist_count,
2934 MAX_NAMED_LIST, s+13, US"local part list");
2937 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2938 NULL, US"main option \"%s\" unknown");
2942 /* If local_sender_retain is set, local_from_check must be unset. */
2944 if (local_sender_retain && local_from_check)
2945 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2946 "local_sender_retain are set; this combination is not allowed");
2948 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2951 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2953 /* The max retry interval must not be greater than 24 hours. */
2955 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2957 /* remote_max_parallel must be > 0 */
2959 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2961 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2962 start of a new SMTP message. */
2964 freeze_tell_config = freeze_tell;
2966 /* The primary host name may be required for expansion of spool_directory
2967 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2968 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2969 canonize it. Some people like upper case letters in their host names, so we
2970 don't force the case. */
2972 if (primary_hostname == NULL)
2976 if (uname(&uts) < 0)
2977 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2978 hostname = US uts.nodename;
2980 if (Ustrchr(hostname, '.') == NULL)
2983 struct hostent *hostdata;
2986 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2987 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2997 #if HAVE_GETIPNODEBYNAME
2999 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
3001 hostdata = gethostbyname2(CS hostname, af);
3004 hostdata = gethostbyname(CS hostname);
3007 if (hostdata != NULL)
3009 hostname = US hostdata->h_name;
3013 if (af == AF_INET) break;
3018 primary_hostname = string_copy(hostname);
3021 /* Set up default value for smtp_active_hostname */
3023 smtp_active_hostname = primary_hostname;
3025 /* If spool_directory wasn't set in the build-time configuration, it must have
3026 got set above. Of course, writing to the log may not work if log_file_path is
3027 not set, but it will at least get to syslog or somewhere, with any luck. */
3029 if (*spool_directory == 0)
3030 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
3033 /* Expand the spool directory name; it may, for example, contain the primary
3034 host name. Same comment about failure. */
3036 s = expand_string(spool_directory);
3038 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
3039 "\"%s\": %s", spool_directory, expand_string_message);
3040 spool_directory = s;
3042 /* Expand log_file_path, which must contain "%s" in any component that isn't
3043 the null string or "syslog". It is also allowed to contain one instance of %D
3044 or %M. However, it must NOT contain % followed by anything else. */
3046 if (*log_file_path != 0)
3049 int sep = ':'; /* Fixed for log file path */
3050 s = expand_string(log_file_path);
3052 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
3053 "\"%s\": %s", log_file_path, expand_string_message);
3056 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3059 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3060 t = Ustrstr(sss, "%s");
3062 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3063 "contain \"%%s\"", sss);
3065 t = Ustrchr(sss, '%');
3068 if ((t[1] != 'D' && t[1] != 'M') || Ustrchr(t+2, '%') != NULL)
3069 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3070 "unexpected \"%%\" character", s);
3077 /* Interpret syslog_facility into an integer argument for 'ident' param to
3078 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3081 if (syslog_facility_str != NULL)
3084 uschar *s = syslog_facility_str;
3086 if ((Ustrlen(syslog_facility_str) >= 4) &&
3087 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3090 for (i = 0; i < syslog_list_size; i++)
3092 if (strcmpic(s, syslog_list[i].name) == 0)
3094 syslog_facility = syslog_list[i].value;
3099 if (i >= syslog_list_size)
3101 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3102 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3106 /* Expand pid_file_path */
3108 if (*pid_file_path != 0)
3110 s = expand_string(pid_file_path);
3112 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3113 "\"%s\": %s", pid_file_path, expand_string_message);
3117 /* Set default value of process_log_path */
3119 if (process_log_path == NULL || *process_log_path =='\0')
3120 process_log_path = string_sprintf("%s/exim-process.info", spool_directory);
3122 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3125 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3127 /* Unpick the SMTP rate limiting options, if set */
3129 if (smtp_ratelimit_mail != NULL)
3131 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3132 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3135 if (smtp_ratelimit_rcpt != NULL)
3137 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3138 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3141 /* The qualify domains default to the primary host name */
3143 if (qualify_domain_sender == NULL)
3144 qualify_domain_sender = primary_hostname;
3145 if (qualify_domain_recipient == NULL)
3146 qualify_domain_recipient = qualify_domain_sender;
3148 /* Setting system_filter_user in the configuration sets the gid as well if a
3149 name is given, but a numerical value does not. */
3151 if (system_filter_uid_set && !system_filter_gid_set)
3153 struct passwd *pw = getpwuid(system_filter_uid);
3155 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3156 (long int)system_filter_uid);
3157 system_filter_gid = pw->pw_gid;
3158 system_filter_gid_set = TRUE;
3161 /* If the errors_reply_to field is set, check that it is syntactically valid
3162 and ensure it contains a domain. */
3164 if (errors_reply_to != NULL)
3167 int start, end, domain;
3168 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3169 &start, &end, &domain, FALSE);
3171 if (recipient == NULL)
3172 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3173 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3176 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3177 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3180 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3181 smtp_accept_max must also be set. */
3183 if (smtp_accept_max == 0 &&
3184 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3185 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3186 "smtp_accept_max must be set if smtp_accept_queue or "
3187 "smtp_accept_max_per_host is set");
3189 /* Set up the host number if anything is specified. It is an expanded string
3190 so that it can be computed from the host name, for example. We do this last
3191 so as to ensure that everything else is set up before the expansion. */
3193 if (host_number_string != NULL)
3197 uschar *s = expand_string(host_number_string);
3199 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
3200 "failed to expand localhost_number \"%s\": %s",
3201 host_number_string, expand_string_message);
3202 n = Ustrtol(s, &end, 0);
3203 while (isspace(*end)) end++;
3205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3206 "localhost_number value is not a number: %s", s);
3207 if (n > LOCALHOST_MAX)
3208 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3209 "localhost_number is greater than the maximum allowed value (%d)",
3215 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3217 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3218 tls_verify_certificates == NULL)
3219 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3220 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3221 (tls_verify_hosts != NULL)? "" : "try_");
3223 /* If openssl_options is set, validate it */
3224 if (openssl_options != NULL)
3227 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3228 "openssl_options is set but we're using GnuTLS");
3231 if (!(tls_openssl_options_parse(openssl_options, &dummy)))
3232 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3233 "openssl_options parse error: %s", openssl_options);
3241 /*************************************************
3242 * Initialize one driver *
3243 *************************************************/
3245 /* This is called once the driver's generic options, if any, have been read.
3246 We can now find the driver, set up defaults for the private options, and
3247 unset any "set" bits in the private options table (which might have been
3248 set by another incarnation of the same driver).
3251 d pointer to driver instance block, with generic
3253 drivers_available vector of available drivers
3254 size_of_info size of each block in drivers_available
3255 class class of driver, for error message
3257 Returns: pointer to the driver info block
3260 static driver_info *
3261 init_driver(driver_instance *d, driver_info *drivers_available,
3262 int size_of_info, uschar *class)
3266 for (dd = drivers_available; dd->driver_name[0] != 0;
3267 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3269 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3272 int len = dd->options_len;
3274 d->options_block = store_get(len);
3275 memcpy(d->options_block, dd->options_block, len);
3276 for (i = 0; i < *(dd->options_count); i++)
3277 dd->options[i].type &= ~opt_set;
3282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3283 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3285 return NULL; /* never obeyed */
3291 /*************************************************
3292 * Initialize driver list *
3293 *************************************************/
3295 /* This function is called for routers, transports, and authentication
3296 mechanisms. It reads the data from the current point in the configuration file
3297 up to the end of the section, and sets up a chain of instance blocks according
3298 to the file's contents. The file will already have been opened by a call to
3299 readconf_main, and must be left open for subsequent reading of further data.
3301 Any errors cause a panic crash. Note that the blocks with names driver_info and
3302 driver_instance must map the first portions of all the _info and _instance
3303 blocks for this shared code to work.
3306 class "router", "transport", or "authenticator"
3307 anchor &routers, &transports, &auths
3308 drivers_available available drivers
3309 size_of_info size of each info block
3310 instance_default points to default data for an instance
3311 instance_size size of instance block
3312 driver_optionlist generic option list
3313 driver_optionlist_count count of generic option list
3319 readconf_driver_init(
3321 driver_instance **anchor,
3322 driver_info *drivers_available,
3324 void *instance_default,
3326 optionlist *driver_optionlist,
3327 int driver_optionlist_count)
3329 driver_instance **p = anchor;
3330 driver_instance *d = NULL;
3333 while ((buffer = get_config_line()) != NULL)
3338 /* Read the first name on the line and test for the start of a new driver. A
3339 macro definition indicates the end of the previous driver. If this isn't the
3340 start of a new driver, the line will be re-read. */
3342 s = readconf_readname(name, sizeof(name), buffer);
3344 /* Handle macro definition, first finishing off the initialization of the
3345 previous driver, if any. */
3347 if (isupper(*name) && *s == '=')
3351 if (d->driver_name == NULL)
3352 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3353 "no driver defined for %s \"%s\"", class, d->name);
3357 read_macro_assignment(buffer);
3361 /* If the line starts with a name terminated by a colon, we are at the
3362 start of the definition of a new driver. The rest of the line must be
3369 /* Finish off initializing the previous driver. */
3373 if (d->driver_name == NULL)
3374 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3375 "no driver defined for %s \"%s\"", class, d->name);
3379 /* Check that we haven't already got a driver of this name */
3381 for (d = *anchor; d != NULL; d = d->next)
3382 if (Ustrcmp(name, d->name) == 0)
3383 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3384 "there are two %ss called \"%s\"", class, name);
3386 /* Set up a new driver instance data block on the chain, with
3387 its default values installed. */
3389 d = store_get(instance_size);
3390 memcpy(d, instance_default, instance_size);
3393 d->name = string_copy(name);
3395 /* Clear out the "set" bits in the generic options */
3397 for (i = 0; i < driver_optionlist_count; i++)
3398 driver_optionlist[i].type &= ~opt_set;
3400 /* Check nothing more on this line, then do the next loop iteration. */
3402 while (isspace(*s)) s++;
3403 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3407 /* Not the start of a new driver. Give an error if we have not set up a
3408 current driver yet. */
3410 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3411 "%s name missing", class);
3413 /* First look to see if this is a generic option; if it is "driver",
3414 initialize the driver. If is it not a generic option, we can look for a
3415 private option provided that the driver has been previously set up. */
3417 if (readconf_handle_option(buffer, driver_optionlist,
3418 driver_optionlist_count, d, NULL))
3420 if (d->info == NULL && d->driver_name != NULL)
3421 init_driver(d, drivers_available, size_of_info, class);
3424 /* Handle private options - pass the generic block because some may
3425 live therein. A flag with each option indicates if it is in the public
3428 else if (d->info != NULL)
3430 readconf_handle_option(buffer, d->info->options,
3431 *(d->info->options_count), d, US"option \"%s\" unknown");
3434 /* The option is not generic and the driver name has not yet been given. */
3436 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3437 "(\"driver\" must be specified before any private options)", name);
3440 /* Run the initialization function for the final driver. */
3444 if (d->driver_name == NULL)
3445 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3446 "no driver defined for %s \"%s\"", class, d->name);
3453 /*************************************************
3454 * Check driver dependency *
3455 *************************************************/
3457 /* This function is passed a driver instance and a string. It checks whether
3458 any of the string options for the driver contains the given string as an
3462 d points to a driver instance block
3463 s the string to search for
3465 Returns: TRUE if a dependency is found
3469 readconf_depends(driver_instance *d, uschar *s)
3471 int count = *(d->info->options_count);
3475 for (ol = d->info->options; ol < d->info->options + count; ol++)
3477 void *options_block;
3479 int type = ol->type & opt_mask;
3480 if (type != opt_stringptr) continue;
3481 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3482 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3483 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3485 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3486 isalnum(ss[Ustrlen(s)])) continue;
3487 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3488 d->name, ol->name, s);
3493 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3500 /*************************************************
3501 * Decode an error type for retries *
3502 *************************************************/
3504 /* This function is global because it is also called from the main
3505 program when testing retry information. It decodes strings such as "quota_7d"
3506 into numerical error codes.
3509 pp points to start of text
3510 p points past end of text
3511 basic_errno points to an int to receive the main error number
3512 more_errno points to an int to receive the secondary error data
3514 Returns: NULL if decoded correctly; else points to error text
3518 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3522 while (q < p && *q != '_') q++;
3525 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3527 *basic_errno = ERRNO_EXIMQUOTA;
3528 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3529 return US"bad time value";
3532 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3534 *basic_errno = ECONNREFUSED;
3537 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3538 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3539 else return US"A or MX expected after \"refused\"";
3543 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3545 *basic_errno = ETIMEDOUT;
3549 int xlen = p - q - 1;
3552 static uschar *extras[] =
3553 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3554 static int values[] =
3555 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3557 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3559 if (strncmpic(x, extras[i], xlen) == 0)
3561 *more_errno = values[i];
3566 if (i >= sizeof(extras)/sizeof(uschar *))
3568 if (strncmpic(x, US"DNS", xlen) == 0)
3570 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3571 "available in retry rules (it has never worked) - treated as "
3574 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3579 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3580 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3581 strncmpic(pp, US"data_4", 6) == 0)
3584 int x = 255; /* means "any 4xx code" */
3585 if (p != pp + 8) bad = TRUE; else
3587 int a = pp[6], b = pp[7];
3591 if (isdigit(b)) x += b - '0';
3592 else if (b == 'x') x += 100;
3595 else if (a != 'x' || b != 'x') bad = TRUE;
3599 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3600 "x is literal and d is any digit", pp);
3602 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3603 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3604 *more_errno = x << 8;
3607 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3608 strncmpic(q+1, US"failed", p-q-1) == 0)
3609 *basic_errno = ERRNO_AUTHFAIL;
3611 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3612 *basic_errno = ERRNO_SMTPCLOSED;
3614 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3615 *basic_errno = ERRNO_TLSREQUIRED;
3617 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3618 return string_sprintf("unknown or malformed retry error \"%.*s\"", (int) (p-pp), pp);
3626 /*************************************************
3627 * Read retry information *
3628 *************************************************/
3630 /* Each line of retry information contains:
3632 . A domain name pattern or an address pattern;
3634 . An error name, possibly with additional data, or *;
3636 . An optional sequence of retry items, each consisting of an identifying
3637 letter, a cutoff time, and optional parameters.
3639 All this is decoded and placed into a control block. */
3642 /* Subroutine to read an argument, preceded by a comma and terminated
3643 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3644 1 = fixed point number (returned *1000).
3647 paddr pointer to pointer to current character; updated
3648 type 0 => read a time; 1 => read a fixed point number
3650 Returns: time in seconds or fixed point number * 1000
3654 retry_arg(uschar **paddr, int type)
3659 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3661 while (isspace(*p)) p++;
3663 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3665 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3666 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3672 return readconf_readtime(pp, *p, FALSE);
3674 return readconf_readfixed(pp, *p);
3676 return 0; /* Keep picky compilers happy */
3679 /* The function proper */
3682 readconf_retries(void)
3684 retry_config **chain = &retries;
3688 while ((p = get_config_line()) != NULL)
3690 retry_rule **rchain;
3693 next = store_get(sizeof(retry_config));
3696 chain = &(next->next);
3697 next->basic_errno = next->more_errno = 0;
3698 next->senders = NULL;
3700 rchain = &(next->rules);
3702 next->pattern = string_dequote(&p);
3703 while (isspace(*p)) p++;
3705 while (mac_isgraph(*p)) p++;
3706 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3707 "missing error type");
3709 /* Test error names for things we understand. */
3711 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3712 &(next->more_errno))) != NULL)
3713 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3715 /* There may be an optional address list of senders to be used as another
3716 constraint on the rule. This was added later, so the syntax is a bit of a
3717 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3720 while (isspace(*p)) p++;
3721 if (Ustrncmp(p, "senders", 7) == 0)
3724 while (isspace(*p)) p++;
3725 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3726 "\"=\" expected after \"senders\" in retry rule");
3727 while (isspace(*p)) p++;
3728 next->senders = string_dequote(&p);
3731 /* Now the retry rules. Keep the maximum timeout encountered. */
3733 while (isspace(*p)) p++;
3737 retry_rule *rule = store_get(sizeof(retry_rule));
3739 rchain = &(rule->next);
3741 rule->rule = toupper(*p++);
3742 rule->timeout = retry_arg(&p, 0);
3743 if (rule->timeout > retry_maximum_timeout)
3744 retry_maximum_timeout = rule->timeout;
3748 case 'F': /* Fixed interval */
3749 rule->p1 = retry_arg(&p, 0);
3752 case 'G': /* Geometrically increasing intervals */
3753 case 'H': /* Ditto, but with randomness */
3754 rule->p1 = retry_arg(&p, 0);
3755 rule->p2 = retry_arg(&p, 1);
3759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3763 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3764 (rule->rule != 'F' && rule->p2 < 1000))
3765 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3766 "bad parameters for retry rule");
3768 while (isspace(*p)) p++;
3772 while (isspace(*p)) p++;
3775 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3782 /*************************************************
3783 * Initialize authenticators *
3784 *************************************************/
3786 /* Read the authenticators section of the configuration file.
3795 auth_instance *au, *bu;
3796 readconf_driver_init(US"authenticator",
3797 (driver_instance **)(&auths), /* chain anchor */
3798 (driver_info *)auths_available, /* available drivers */
3799 sizeof(auth_info), /* size of info block */
3800 &auth_defaults, /* default values for generic options */
3801 sizeof(auth_instance), /* size of instance block */
3802 optionlist_auths, /* generic options */
3803 optionlist_auths_size);
3805 for (au = auths; au != NULL; au = au->next)
3807 if (au->public_name == NULL)
3808 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3809 "the %s authenticator", au->name);
3810 for (bu = au->next; bu != NULL; bu = bu->next)
3812 if (strcmpic(au->public_name, bu->public_name) == 0)
3814 if ((au->client && bu->client) || (au->server && bu->server))
3815 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3816 "(%s and %s) have the same public name (%s)",
3817 (au->client)? US"client" : US"server", au->name, bu->name,
3827 /*************************************************
3828 * Read ACL information *
3829 *************************************************/
3831 /* If this run of Exim is not doing something that involves receiving a
3832 message, we can just skip over the ACL information. No need to parse it.
3834 First, we have a function for acl_read() to call back to get the next line. We
3835 need to remember the line we passed, because at the end it will contain the
3836 name of the next ACL. */
3838 static uschar *acl_line;
3843 acl_line = get_config_line();
3848 /* Now the main function:
3851 skip TRUE when this Exim process is doing something that will
3852 not need the ACL data
3858 readconf_acl(BOOL skip)
3862 /* Not receiving messages, don't need to parse the ACL data */
3866 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3867 while ((p = get_config_line()) != NULL);
3871 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3874 acl_line = get_config_line();
3876 while(acl_line != NULL)
3882 p = readconf_readname(name, sizeof(name), acl_line);
3883 if (isupper(*name) && *p == '=')
3885 read_macro_assignment(acl_line);
3886 acl_line = get_config_line();
3890 if (*p != ':' || name[0] == 0)
3891 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3893 node = store_get(sizeof(tree_node) + Ustrlen(name));
3894 Ustrcpy(node->name, name);
3895 if (!tree_insertnode(&acl_anchor, node))
3896 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3897 "there are two ACLs called \"%s\"", name);
3899 node->data.ptr = acl_read(acl_callback, &error);
3901 if (node->data.ptr == NULL && error != NULL)
3902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3908 /*************************************************
3909 * Read configuration for local_scan() *
3910 *************************************************/
3912 /* This function is called after "begin local_scan" is encountered in the
3913 configuration file. If the local_scan() function allows for configuration
3914 options, we can process them. Otherwise, we expire in a panic.
3921 local_scan_init(void)
3923 #ifndef LOCAL_SCAN_HAS_OPTIONS
3924 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3925 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3929 while ((p = get_config_line()) != NULL)
3931 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3932 NULL, US"local_scan option \"%s\" unknown");
3939 /*************************************************
3940 * Read rest of configuration (after main) *
3941 *************************************************/
3943 /* This function reads the rest of the runtime configuration, after the main
3944 configuration. It is called only when actually needed. Each subsequent section
3945 of the configuration starts with a line of the form
3949 where the name is "routers", "transports", etc. A section is terminated by
3950 hitting the next "begin" line, and the next name is left in next_section.
3951 Because it may confuse people as to whether the names are singular or plural,
3952 we add "s" if it's missing. There is always enough room in next_section for
3953 this. This function is basically just a switch.
3956 skip_acl TRUE if ACL information is not needed
3961 static uschar *section_list[] = {
3971 readconf_rest(BOOL skip_acl)
3975 while(next_section[0] != 0)
3979 int last = sizeof(section_list) / sizeof(uschar *);
3981 int n = Ustrlen(next_section);
3983 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3987 int c = strcmpic(next_section, section_list[mid]);
3989 if (c > 0) first = mid + 1; else last = mid;
3991 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3992 "\"%.*s\" is not a known configuration section name", n, next_section);
3993 mid = (last + first)/2;
3997 if (((had ^= bit) & bit) == 0)
3998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3999 "\"%.*s\" section is repeated in the configuration file", n,
4004 case 0: readconf_acl(skip_acl); break;
4005 case 1: auths_init(); break;
4006 case 2: local_scan_init(); break;
4007 case 3: readconf_retries(); break;
4008 case 4: readconf_rewrites(); break;
4009 case 5: route_init(); break;
4010 case 6: transport_init(); break;
4014 (void)fclose(config_file);
4017 /* End of readconf.c */