1 /* $Cambridge: exim/src/src/readconf.c,v 1.34 2008/01/17 13:03:35 tom Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for reading the configuration file, and for displaying
11 overall configuration values. Thanks to Brian Candler for the original
12 implementation of the conditional .ifdef etc. */
16 #define CSTATE_STACK_SIZE 10
19 /* Structure for chain (stack) of .included files */
21 typedef struct config_file_item {
22 struct config_file_item *next;
28 /* Structure of table of conditional words and their state transitions */
30 typedef struct cond_item {
38 /* Structure of table of syslog facility names and values */
40 typedef struct syslog_fac_item {
46 /* Static variables */
48 static config_file_item *config_file_stack = NULL; /* For includes */
50 static uschar *syslog_facility_str = NULL;
51 static uschar next_section[24];
52 static uschar time_buffer[24];
54 /* State variables for conditional loading (.ifdef / .else / .endif) */
56 static int cstate = 0;
57 static int cstate_stack_ptr = -1;
58 static int cstate_stack[CSTATE_STACK_SIZE];
60 /* Table of state transitions for handling conditional inclusions. There are
61 four possible state transitions:
65 .elifdef true (or .else)
68 .endif just causes the previous cstate to be popped off the stack */
70 static int next_cstate[3][4] =
72 /* State 0: reading from file, or reading until next .else or .endif */
74 /* State 1: condition failed, skipping until next .else or .endif */
76 /* State 2: skipping until .endif */
80 /* Table of conditionals and the states to set. For each name, there are four
81 values: the length of the name (to save computing it each time), the state to
82 set if a macro was found in the line, the state to set if a macro was not found
83 in the line, and a stack manipulation setting which is:
85 -1 pull state value off the stack
86 0 don't alter the stack
87 +1 push value onto stack, before setting new state
90 static cond_item cond_list[] = {
91 { US"ifdef", 5, 0, 1, 1 },
92 { US"ifndef", 6, 1, 0, 1 },
93 { US"elifdef", 7, 2, 3, 0 },
94 { US"elifndef", 8, 3, 2, 0 },
95 { US"else", 4, 2, 2, 0 },
96 { US"endif", 5, 0, 0, -1 }
99 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
101 /* Table of syslog facility names and their values */
103 static syslog_fac_item syslog_list[] = {
104 { US"mail", LOG_MAIL },
105 { US"user", LOG_USER },
106 { US"news", LOG_NEWS },
107 { US"uucp", LOG_UUCP },
108 { US"local0", LOG_LOCAL0 },
109 { US"local1", LOG_LOCAL1 },
110 { US"local2", LOG_LOCAL2 },
111 { US"local3", LOG_LOCAL3 },
112 { US"local4", LOG_LOCAL4 },
113 { US"local5", LOG_LOCAL5 },
114 { US"local6", LOG_LOCAL6 },
115 { US"local7", LOG_LOCAL7 },
116 { US"daemon", LOG_DAEMON }
119 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
124 /*************************************************
125 * Main configuration options *
126 *************************************************/
128 /* The list of options that can be set in the main configuration file. This
129 must be in alphabetic order because it is searched by binary chop. */
131 static optionlist optionlist_config[] = {
132 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
133 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
134 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
135 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
136 { "accept_8bitmime", opt_bool, &accept_8bitmime },
137 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
138 #ifdef WITH_CONTENT_SCAN
139 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
141 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
142 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
143 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
144 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
145 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
146 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
147 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
148 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
149 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
150 #ifdef WITH_CONTENT_SCAN
151 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
153 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
154 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
155 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
156 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
158 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
160 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
161 { "admin_groups", opt_gidlist, &admin_groups },
162 { "allow_domain_literals", opt_bool, &allow_domain_literals },
163 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
164 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
165 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
166 { "auto_thaw", opt_time, &auto_thaw },
167 #ifdef WITH_CONTENT_SCAN
168 { "av_scanner", opt_stringptr, &av_scanner },
170 { "bi_command", opt_stringptr, &bi_command },
171 #ifdef EXPERIMENTAL_BRIGHTMAIL
172 { "bmi_config_file", opt_stringptr, &bmi_config_file },
174 { "bounce_message_file", opt_stringptr, &bounce_message_file },
175 { "bounce_message_text", opt_stringptr, &bounce_message_text },
176 { "bounce_return_body", opt_bool, &bounce_return_body },
177 { "bounce_return_message", opt_bool, &bounce_return_message },
178 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
179 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
180 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
181 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
182 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
183 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
184 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
185 { "check_log_inodes", opt_int, &check_log_inodes },
186 { "check_log_space", opt_Kint, &check_log_space },
187 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
188 { "check_spool_inodes", opt_int, &check_spool_inodes },
189 { "check_spool_space", opt_Kint, &check_spool_space },
190 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
191 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
192 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
193 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
194 #ifdef EXPERIMENTAL_DCC
195 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
196 { "dccifd_address", opt_stringptr, &dccifd_address },
197 { "dccifd_options", opt_stringptr, &dccifd_options },
199 { "delay_warning", opt_timelist, &delay_warning },
200 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
201 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
202 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
203 { "delivery_date_remove", opt_bool, &delivery_date_remove },
204 #ifdef ENABLE_DISABLE_FSYNC
205 { "disable_fsync", opt_bool, &disable_fsync },
207 { "disable_ipv6", opt_bool, &disable_ipv6 },
208 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
209 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
210 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
211 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
212 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
213 { "dns_retrans", opt_time, &dns_retrans },
214 { "dns_retry", opt_int, &dns_retry },
215 /* This option is now a no-op, retained for compability */
216 { "drop_cr", opt_bool, &drop_cr },
217 /*********************************************************/
218 { "dsn_from", opt_stringptr, &dsn_from },
219 { "envelope_to_remove", opt_bool, &envelope_to_remove },
220 { "errors_copy", opt_stringptr, &errors_copy },
221 { "errors_reply_to", opt_stringptr, &errors_reply_to },
222 { "exim_group", opt_gid, &exim_gid },
223 { "exim_path", opt_stringptr, &exim_path },
224 { "exim_user", opt_uid, &exim_uid },
225 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
226 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
227 { "finduser_retries", opt_int, &finduser_retries },
228 { "freeze_tell", opt_stringptr, &freeze_tell },
229 { "gecos_name", opt_stringptr, &gecos_name },
230 { "gecos_pattern", opt_stringptr, &gecos_pattern },
232 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
233 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
234 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
236 { "header_line_maxsize", opt_int, &header_line_maxsize },
237 { "header_maxsize", opt_int, &header_maxsize },
238 { "headers_charset", opt_stringptr, &headers_charset },
239 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
240 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
241 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
242 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
243 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
244 { "hold_domains", opt_stringptr, &hold_domains },
245 { "host_lookup", opt_stringptr, &host_lookup },
246 { "host_lookup_order", opt_stringptr, &host_lookup_order },
247 { "host_reject_connection", opt_stringptr, &host_reject_connection },
248 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
249 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
251 { "ibase_servers", opt_stringptr, &ibase_servers },
253 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
254 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
255 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
256 { "keep_malformed", opt_time, &keep_malformed },
258 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
259 { "ldap_version", opt_int, &eldap_version },
261 { "local_from_check", opt_bool, &local_from_check },
262 { "local_from_prefix", opt_stringptr, &local_from_prefix },
263 { "local_from_suffix", opt_stringptr, &local_from_suffix },
264 { "local_interfaces", opt_stringptr, &local_interfaces },
265 { "local_scan_timeout", opt_time, &local_scan_timeout },
266 { "local_sender_retain", opt_bool, &local_sender_retain },
267 { "localhost_number", opt_stringptr, &host_number_string },
268 { "log_file_path", opt_stringptr, &log_file_path },
269 { "log_selector", opt_stringptr, &log_selector_string },
270 { "log_timezone", opt_bool, &log_timezone },
271 { "lookup_open_max", opt_int, &lookup_open_max },
272 { "max_username_length", opt_int, &max_username_length },
273 { "message_body_newlines", opt_bool, &message_body_newlines },
274 { "message_body_visible", opt_mkint, &message_body_visible },
275 { "message_id_header_domain", opt_stringptr, &message_id_domain },
276 { "message_id_header_text", opt_stringptr, &message_id_text },
277 { "message_logs", opt_bool, &message_logs },
278 { "message_size_limit", opt_stringptr, &message_size_limit },
279 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
280 { "move_frozen_messages", opt_bool, &move_frozen_messages },
282 { "mua_wrapper", opt_bool, &mua_wrapper },
284 { "mysql_servers", opt_stringptr, &mysql_servers },
286 { "never_users", opt_uidlist, &never_users },
288 { "oracle_servers", opt_stringptr, &oracle_servers },
290 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
292 { "perl_at_start", opt_bool, &opt_perl_at_start },
293 { "perl_startup", opt_stringptr, &opt_perl_startup },
296 { "pgsql_servers", opt_stringptr, &pgsql_servers },
298 { "pid_file_path", opt_stringptr, &pid_file_path },
299 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
300 { "preserve_message_logs", opt_bool, &preserve_message_logs },
301 { "primary_hostname", opt_stringptr, &primary_hostname },
302 { "print_topbitchars", opt_bool, &print_topbitchars },
303 { "process_log_path", opt_stringptr, &process_log_path },
304 { "prod_requires_admin", opt_bool, &prod_requires_admin },
305 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
306 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
307 { "queue_domains", opt_stringptr, &queue_domains },
308 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
309 { "queue_only", opt_bool, &queue_only },
310 { "queue_only_file", opt_stringptr, &queue_only_file },
311 { "queue_only_load", opt_fixed, &queue_only_load },
312 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
313 { "queue_only_override", opt_bool, &queue_only_override },
314 { "queue_run_in_order", opt_bool, &queue_run_in_order },
315 { "queue_run_max", opt_int, &queue_run_max },
316 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
317 { "receive_timeout", opt_time, &receive_timeout },
318 { "received_header_text", opt_stringptr, &received_header_text },
319 { "received_headers_max", opt_int, &received_headers_max },
320 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
321 { "recipients_max", opt_int, &recipients_max },
322 { "recipients_max_reject", opt_bool, &recipients_max_reject },
323 { "remote_max_parallel", opt_int, &remote_max_parallel },
324 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
325 { "retry_data_expire", opt_time, &retry_data_expire },
326 { "retry_interval_max", opt_time, &retry_interval_max },
327 { "return_path_remove", opt_bool, &return_path_remove },
328 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
329 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
330 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
331 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
332 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
333 { "smtp_accept_max", opt_int, &smtp_accept_max },
334 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
335 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
336 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
337 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
338 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
339 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
340 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
341 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
342 { "smtp_banner", opt_stringptr, &smtp_banner },
343 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
344 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
345 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
346 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
347 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
348 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
349 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
350 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
351 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
352 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
353 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
354 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
355 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
356 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
357 #ifdef WITH_CONTENT_SCAN
358 { "spamd_address", opt_stringptr, &spamd_address },
360 { "split_spool_directory", opt_bool, &split_spool_directory },
361 { "spool_directory", opt_stringptr, &spool_directory },
363 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
365 #ifdef EXPERIMENTAL_SRS
366 { "srs_config", opt_stringptr, &srs_config },
367 { "srs_hashlength", opt_int, &srs_hashlength },
368 { "srs_hashmin", opt_int, &srs_hashmin },
369 { "srs_maxage", opt_int, &srs_maxage },
370 { "srs_secrets", opt_stringptr, &srs_secrets },
371 { "srs_usehash", opt_bool, &srs_usehash },
372 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
374 { "strict_acl_vars", opt_bool, &strict_acl_vars },
375 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
376 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
377 { "syslog_duplication", opt_bool, &syslog_duplication },
378 { "syslog_facility", opt_stringptr, &syslog_facility_str },
379 { "syslog_processname", opt_stringptr, &syslog_processname },
380 { "syslog_timestamp", opt_bool, &syslog_timestamp },
381 { "system_filter", opt_stringptr, &system_filter },
382 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
383 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
384 { "system_filter_group", opt_gid, &system_filter_gid },
385 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
386 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
387 { "system_filter_user", opt_uid, &system_filter_uid },
388 { "tcp_nodelay", opt_bool, &tcp_nodelay },
389 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
390 { "timezone", opt_stringptr, &timezone_string },
392 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
393 { "tls_certificate", opt_stringptr, &tls_certificate },
394 { "tls_crl", opt_stringptr, &tls_crl },
395 { "tls_dhparam", opt_stringptr, &tls_dhparam },
396 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
397 { "tls_privatekey", opt_stringptr, &tls_privatekey },
398 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
399 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
400 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
401 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
402 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
404 { "trusted_groups", opt_gidlist, &trusted_groups },
405 { "trusted_users", opt_uidlist, &trusted_users },
406 { "unknown_login", opt_stringptr, &unknown_login },
407 { "unknown_username", opt_stringptr, &unknown_username },
408 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
409 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
410 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
411 { "warn_message_file", opt_stringptr, &warn_message_file },
412 { "write_rejectlog", opt_bool, &write_rejectlog }
415 static int optionlist_config_size =
416 sizeof(optionlist_config)/sizeof(optionlist);
420 /*************************************************
421 * Find the name of an option *
422 *************************************************/
424 /* This function is to aid debugging. Various functions take arguments that are
425 pointer variables in the options table or in option tables for various drivers.
426 For debugging output, it is useful to be able to find the name of the option
427 which is currently being processed. This function finds it, if it exists, by
428 searching the table(s).
430 Arguments: a value that is presumed to be in the table above
431 Returns: the option name, or an empty string
435 readconf_find_option(void *p)
439 transport_instance *t;
441 for (i = 0; i < optionlist_config_size; i++)
442 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
444 for (r = routers; r != NULL; r = r->next)
446 router_info *ri = r->info;
447 for (i = 0; i < ri->options_count[0]; i++)
449 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
450 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
451 return US ri->options[i].name;
455 for (t = transports; t != NULL; t = t->next)
457 transport_info *ti = t->info;
458 for (i = 0; i < ti->options_count[0]; i++)
460 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
461 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
462 return US ti->options[i].name;
472 /*************************************************
473 * Deal with an assignment to a macro *
474 *************************************************/
476 /* This function is called when a line that starts with an upper case letter is
477 encountered. The argument "line" should contain a complete logical line, and
478 start with the first letter of the macro name. The macro name and the
479 replacement text are extracted and stored. Redefinition of existing,
480 non-command line, macros is permitted using '==' instead of '='.
483 s points to the start of the logical line
489 read_macro_assignment(uschar *s)
495 macro_item *mlast = NULL;
497 while (isalnum(*s) || *s == '_')
499 if (namelen >= sizeof(name) - 1)
500 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
501 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
502 name[namelen++] = *s++;
506 while (isspace(*s)) s++;
508 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
515 while (isspace(*s)) s++;
517 /* If an existing macro of the same name was defined on the command line, we
518 just skip this definition. It's an error to attempt to redefine a macro without
519 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
520 It is also an error to define a macro whose name begins with the name of a
521 previously defined macro. Note: it is documented that the other way round
524 for (m = macros; m != NULL; m = m->next)
526 int len = Ustrlen(m->name);
528 if (Ustrcmp(m->name, name) == 0)
530 if (!m->command_line && !redef)
531 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
532 "defined (use \"==\" if you want to redefine it", name);
536 if (len < namelen && Ustrstr(name, m->name) != NULL)
537 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
538 "a macro because previously defined macro \"%s\" is a substring",
541 /* We cannot have this test, because it is documented that a substring
542 macro is permitted (there is even an example).
544 * if (len > namelen && Ustrstr(m->name, name) != NULL)
545 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
546 * "a macro because it is a substring of previously defined macro \"%s\"",
553 /* Check for an overriding command-line definition. */
555 if (m != NULL && m->command_line) return;
557 /* Redefinition must refer to an existing macro. */
562 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
566 /* We have a new definition. The macro_item structure includes a final vector
567 called "name" which is one byte long. Thus, adding "namelen" gives us enough
568 room to store the "name" string. */
572 m = store_get(sizeof(macro_item) + namelen);
573 if (macros == NULL) macros = m; else mlast->next = m;
574 Ustrncpy(m->name, name, namelen);
575 m->name[namelen] = 0;
577 m->command_line = FALSE;
580 /* Set the value of the new or redefined macro */
582 m->replacement = string_copy(s);
589 /*************************************************
590 * Read configuration line *
591 *************************************************/
593 /* A logical line of text is read from the configuration file into the big
594 buffer, taking account of macros, .includes, and continuations. The size of
595 big_buffer is increased if necessary. The count of configuration lines is
596 maintained. Physical input lines starting with # (ignoring leading white space,
597 and after macro replacement) and empty logical lines are always ignored.
598 Leading and trailing spaces are removed.
600 If we hit a line of the form "begin xxxx", the xxxx is placed in the
601 next_section vector, and the function returns NULL, indicating the end of a
602 configuration section. On end-of-file, NULL is returned with next_section
607 Returns: a pointer to the first non-blank in the line,
608 or NULL if eof or end of section is reached
612 get_config_line(void)
614 int startoffset = 0; /* To first non-blank char in logical line */
615 int len = 0; /* Of logical line so far */
621 /* Loop for handling continuation lines, skipping comments, and dealing with
626 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
628 if (config_file_stack != NULL) /* EOF inside .include */
630 (void)fclose(config_file);
631 config_file = config_file_stack->file;
632 config_filename = config_file_stack->filename;
633 config_lineno = config_file_stack->lineno;
634 config_file_stack = config_file_stack->next;
638 /* EOF at top level */
640 if (cstate_stack_ptr >= 0)
641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
642 "Unexpected end of configuration file: .endif missing");
644 if (len != 0) break; /* EOF after continuation */
645 next_section[0] = 0; /* EOF at start of logical line */
650 newlen = len + Ustrlen(big_buffer + len);
652 /* Handle pathologically long physical lines - yes, it did happen - by
653 extending big_buffer at this point. The code also copes with very long
656 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
659 big_buffer_size += BIG_BUFFER_SIZE;
660 newbuffer = store_malloc(big_buffer_size);
662 /* This use of strcpy is OK because we know that the string in the old
663 buffer is shorter than the new buffer. */
665 Ustrcpy(newbuffer, big_buffer);
666 store_free(big_buffer);
667 big_buffer = newbuffer;
668 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
670 newlen += Ustrlen(big_buffer + newlen);
673 /* Find the true start of the physical line - leading spaces are always
676 ss = big_buffer + len;
677 while (isspace(*ss)) ss++;
679 /* Process the physical line for macros. If this is the start of the logical
680 line, skip over initial text at the start of the line if it starts with an
681 upper case character followed by a sequence of name characters and an equals
682 sign, because that is the definition of a new macro, and we don't do
683 replacement therein. */
686 if (len == 0 && isupper(*s))
688 while (isalnum(*s) || *s == '_') s++;
689 while (isspace(*s)) s++;
690 if (*s != '=') s = ss; /* Not a macro definition */
693 /* For each defined macro, scan the line (from after XXX= if present),
694 replacing all occurrences of the macro. */
697 for (m = macros; m != NULL; m = m->next)
702 while ((p = Ustrstr(t, m->name)) != NULL)
705 int namelen = Ustrlen(m->name);
706 int replen = Ustrlen(m->replacement);
708 /* Expand the buffer if necessary */
710 while (newlen - namelen + replen + 1 > big_buffer_size)
712 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
713 uschar *newbuffer = store_malloc(newsize);
714 memcpy(newbuffer, big_buffer, newlen + 1);
715 p = newbuffer + (p - big_buffer);
716 s = newbuffer + (s - big_buffer);
717 ss = newbuffer + (ss - big_buffer);
718 t = newbuffer + (t - big_buffer);
719 big_buffer_size = newsize;
720 store_free(big_buffer);
721 big_buffer = newbuffer;
724 /* Shuffle the remaining characters up or down in the buffer before
725 copying in the replacement text. Don't rescan the replacement for this
729 moveby = replen - namelen;
732 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
735 Ustrncpy(p, m->replacement, replen);
741 /* An empty macro replacement at the start of a line could mean that ss no
742 longer points to the first non-blank character. */
744 while (isspace(*ss)) ss++;
746 /* Check for comment lines - these are physical lines. */
748 if (*ss == '#') continue;
750 /* Handle conditionals, which are also applied to physical lines. Conditions
751 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
752 expansion occured on the rest of the line. A preliminary test for the leading
753 '.' saves effort on most lines. */
759 /* Search the list of conditional directives */
761 for (i = 0; i < cond_list_size; i++)
764 cond_item *c = cond_list+i;
765 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
767 /* The following character must be white space or end of string */
769 n = ss[1 + c->namelen];
770 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
772 /* .ifdef and .ifndef push the current state onto the stack, then set
773 a new one from the table. Stack overflow is an error */
777 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
778 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
779 ".%s nested too deeply", c->name);
780 cstate_stack[++cstate_stack_ptr] = cstate;
781 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
784 /* For any of the others, stack underflow is an error. The next state
785 comes either from the stack (.endif) or from the table. */
789 if (cstate_stack_ptr < 0)
790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
791 ".%s without matching .ifdef", c->name);
792 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
793 next_cstate[cstate][macro_found? c->action1 : c->action2];
796 /* Having dealt with a directive, break the loop */
801 /* If we have handled a conditional directive, continue with the next
802 physical line. Otherwise, fall through. */
804 if (i < cond_list_size) continue;
807 /* If the conditional state is not 0 (actively using these lines), ignore
810 if (cstate != 0) continue; /* Conditional skip */
812 /* Handle .include lines - these are also physical lines. */
814 if (Ustrncmp(ss, ".include", 8) == 0 &&
816 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
819 int include_if_exists = isspace(ss[8])? 0 : 10;
820 config_file_item *save;
823 ss += 9 + include_if_exists;
824 while (isspace(*ss)) ss++;
825 t = ss + Ustrlen(ss);
826 while (t > ss && isspace(t[-1])) t--;
827 if (*ss == '\"' && t[-1] == '\"')
835 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
836 "absolute path \"%s\"", ss);
838 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
840 save = store_get(sizeof(config_file_item));
841 save->next = config_file_stack;
842 config_file_stack = save;
843 save->file = config_file;
844 save->filename = config_filename;
845 save->lineno = config_lineno;
847 config_file = Ufopen(ss, "rb");
848 if (config_file == NULL)
849 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
850 "configuration file %s", ss);
851 config_filename = string_copy(ss);
856 /* If this is the start of the logical line, remember where the non-blank
857 data starts. Otherwise shuffle down continuation lines to remove leading
861 startoffset = ss - big_buffer;
864 s = big_buffer + len;
867 memmove(s, ss, (newlen - len) - (ss - s) + 1);
872 /* Accept the new addition to the line. Remove trailing white space. */
875 while (len > 0 && isspace(big_buffer[len-1])) len--;
878 /* We are done if the line does not end in backslash and contains some data.
879 Empty logical lines are ignored. For continuations, remove the backslash and
880 go round the loop to read the continuation line. */
884 if (big_buffer[len-1] != '\\') break; /* End of logical line */
885 big_buffer[--len] = 0; /* Remove backslash */
887 } /* Loop for reading multiple physical lines */
889 /* We now have a logical line. Test for the end of a configuration section (or,
890 more accurately, for the start of the next section). Place the name of the next
891 section in next_section, and return NULL. If the name given is longer than
892 next_section, truncate it. It will be unrecognized later, because all the known
893 section names do fit. Leave space for pluralizing. */
895 s = big_buffer + startoffset; /* First non-space character */
896 if (strncmpic(s, US"begin ", 6) == 0)
899 while (isspace(*s)) s++;
900 if (big_buffer + len - s > sizeof(next_section) - 2)
901 s[sizeof(next_section) - 2] = 0;
902 Ustrcpy(next_section, s);
906 /* Return the first non-blank character. */
913 /*************************************************
915 *************************************************/
917 /* The yield is the pointer to the next uschar. Names longer than the
918 output space are silently truncated. This function is also used from acl.c when
922 name where to put the name
926 Returns: new input pointer
930 readconf_readname(uschar *name, int len, uschar *s)
933 while (isspace(*s)) s++;
936 while (isalnum(*s) || *s == '_')
938 if (p < len-1) name[p++] = *s;
943 while (isspace(*s)) s++;
950 /*************************************************
951 * Read a time value *
952 *************************************************/
954 /* This function is also called from outside, to read argument
955 time values. The format of a time value is:
957 [<n>w][<n>d][<n>h][<n>m][<n>s]
959 as long as at least one is present. If a format error is encountered,
960 return a negative value. The value must be terminated by the given
965 terminator required terminating character
966 return_msec if TRUE, allow fractional seconds and return milliseconds
968 Returns: the time value, or -1 on syntax error
969 value is seconds if return_msec is FALSE
970 value is milliseconds if return_msec is TRUE
974 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
982 if (!isdigit(*s)) return -1;
983 (void)sscanf(CS s, "%d%n", &value, &count);
988 case 'w': value *= 7;
989 case 'd': value *= 24;
990 case 'h': value *= 60;
991 case 'm': value *= 60;
996 if (!return_msec) return -1;
997 (void)sscanf(CS s, "%lf%n", &fraction, &count);
999 if (*s++ != 's') return -1;
1000 yield += (int)(fraction * 1000.0);
1006 if (return_msec) value *= 1000;
1008 if (*s == terminator) return yield;
1010 /* Control never reaches here. */
1015 /*************************************************
1016 * Read a fixed point value *
1017 *************************************************/
1019 /* The value is returned *1000
1023 terminator required terminator
1025 Returns: the value, or -1 on error
1029 readconf_readfixed(uschar *s, int terminator)
1033 if (!isdigit(*s)) return -1;
1034 (void)sscanf(CS s, "%d%n", &value, &count);
1036 yield = value * 1000;
1040 while (isdigit((*(++s))))
1042 yield += (*s - '0') * m;
1047 return (*s == terminator)? yield : (-1);
1052 /*************************************************
1053 * Find option in list *
1054 *************************************************/
1056 /* The lists are always in order, so binary chop can be used.
1059 name the option name to search for
1060 ol the first entry in the option list
1061 last one more than the offset of the last entry in the option list
1063 Returns: pointer to an option entry, or NULL if not found
1067 find_option(uschar *name, optionlist *ol, int last)
1070 while (last > first)
1072 int middle = (first + last)/2;
1073 int c = Ustrcmp(name, ol[middle].name);
1074 if (c == 0) return ol + middle;
1075 else if (c > 0) first = middle + 1;
1083 /*************************************************
1084 * Find a set flag in option list *
1085 *************************************************/
1087 /* Because some versions of Unix make no restrictions on the values of uids and
1088 gids (even negative ones), we cannot represent "unset" by a special value.
1089 There is therefore a separate boolean variable for each one indicating whether
1090 a value is set or not. This function returns a pointer to the boolean, given
1091 the original option name. It is a major disaster if the flag cannot be found.
1094 name the name of the uid or gid option
1095 oltop points to the start of the relevant option list
1096 last one more than the offset of the last item in the option list
1097 data_block NULL when reading main options => data values in the option
1098 list are absolute addresses; otherwise they are byte offsets
1099 in data_block (used for driver options)
1101 Returns: a pointer to the boolean flag.
1105 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1109 sprintf(CS name2, "*set_%.50s", name);
1110 ol = find_option(name2, oltop, last);
1111 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1112 "Exim internal error: missing set flag for %s", name);
1113 return (data_block == NULL)? (BOOL *)(ol->value) :
1114 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1120 /*************************************************
1121 * Output extra characters message and die *
1122 *************************************************/
1124 /* Called when an option line has junk on the end. Sometimes this is because
1125 the sysadmin thinks comments are permitted.
1128 s points to the extra characters
1129 t1..t3 strings to insert in the log message
1131 Returns: doesn't return; dies
1135 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1137 uschar *comment = US"";
1138 if (*s == '#') comment = US" (# is comment only at line start)";
1139 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1140 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1145 /*************************************************
1146 * Read rewrite information *
1147 *************************************************/
1149 /* Each line of rewrite information contains:
1151 . A complete address in the form user@domain, possibly with
1152 leading * for each part; or alternatively, a regex.
1154 . A replacement string (which will be expanded).
1156 . An optional sequence of one-letter flags, indicating which
1157 headers etc. to apply this rule to.
1159 All this is decoded and placed into a control block. The OR of the flags is
1160 maintained in a common word.
1163 p points to the string that makes up the rule
1164 existflags points to the overall flag word
1165 isglobal TRUE if reading global rewrite rules
1167 Returns: the control block for the parsed rule.
1170 static rewrite_rule *
1171 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1173 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1176 next->key = string_dequote(&p);
1178 while (isspace(*p)) p++;
1180 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1181 "missing rewrite replacement string");
1184 next->replacement = string_dequote(&p);
1186 while (*p != 0) switch (*p++)
1188 case ' ': case '\t': break;
1190 case 'q': next->flags |= rewrite_quit; break;
1191 case 'w': next->flags |= rewrite_whole; break;
1193 case 'h': next->flags |= rewrite_all_headers; break;
1194 case 's': next->flags |= rewrite_sender; break;
1195 case 'f': next->flags |= rewrite_from; break;
1196 case 't': next->flags |= rewrite_to; break;
1197 case 'c': next->flags |= rewrite_cc; break;
1198 case 'b': next->flags |= rewrite_bcc; break;
1199 case 'r': next->flags |= rewrite_replyto; break;
1201 case 'E': next->flags |= rewrite_all_envelope; break;
1202 case 'F': next->flags |= rewrite_envfrom; break;
1203 case 'T': next->flags |= rewrite_envto; break;
1205 case 'Q': next->flags |= rewrite_qualify; break;
1206 case 'R': next->flags |= rewrite_repeat; break;
1209 next->flags |= rewrite_smtp;
1210 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1211 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1212 "rewrite rule has the S flag but is not a regular expression");
1216 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1217 "unknown rewrite flag character '%c' "
1218 "(could be missing quotes round replacement item)", p[-1]);
1222 /* If no action flags are set, set all the "normal" rewrites. */
1224 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1225 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1227 /* Remember which exist, for optimization, and return the rule */
1229 *existflags |= next->flags;
1236 /*************************************************
1237 * Read global rewrite information *
1238 *************************************************/
1240 /* Each line is a single rewrite rule; it is parsed into a control block
1241 by readconf_one_rewrite(), and its flags are ORed into the global flag
1242 word rewrite_existflags. */
1245 readconf_rewrites(void)
1247 rewrite_rule **chain = &global_rewrite_rules;
1250 while ((p = get_config_line()) != NULL)
1252 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1254 chain = &(next->next);
1260 /*************************************************
1262 *************************************************/
1264 /* Strings are read into the normal store pool. As long we aren't too
1265 near the end of the current block, the string will just use what is necessary
1266 on the top of the stacking pool, because string_cat() uses the extension
1270 s the rest of the input line
1271 name the option name (for errors)
1273 Returns: pointer to the string
1277 read_string(uschar *s, uschar *name)
1282 if (*s != '\"') return string_copy(s);
1285 yield = string_dequote(&s);
1287 if (s == ss+1 || s[-1] != '\"')
1288 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1289 "missing quote at end of string value for %s", name);
1291 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1297 /*************************************************
1298 * Handle option line *
1299 *************************************************/
1301 /* This function is called from several places to process a line containing the
1302 setting of an option. The first argument is the line to be decoded; it has been
1303 checked not to be empty and not to start with '#'. Trailing newlines and white
1304 space have been removed. The second argument is a pointer to the list of
1305 variable names that are to be recognized, together with their types and
1306 locations, and the third argument gives the number of entries in the list.
1308 The fourth argument is a pointer to a data block. If it is NULL, then the data
1309 values in the options list are absolute addresses. Otherwise, they are byte
1310 offsets in the data block.
1312 String option data may continue onto several lines; this function reads further
1313 data from config_file if necessary.
1315 The yield of this function is normally zero. If a string continues onto
1316 multiple lines, then the data value is permitted to be followed by a comma
1317 or a semicolon (for use in drivers) and the yield is that character.
1320 buffer contains the configuration line to be handled
1321 oltop points to the start of the relevant option list
1322 last one more than the offset of the last item in the option list
1323 data_block NULL when reading main options => data values in the option
1324 list are absolute addresses; otherwise they are byte offsets
1325 in data_block when they have opt_public set; otherwise
1326 they are byte offsets in data_block->options_block.
1327 unknown_txt format string to use in panic message for unknown option;
1328 must contain %s for option name
1329 if given as NULL, don't panic on unknown option
1331 Returns: TRUE if an option was read successfully,
1332 FALSE false for an unknown option if unknown_txt == NULL,
1333 otherwise panic and die on an unknown option
1337 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1338 void *data_block, uschar *unknown_txt)
1342 int n, count, type, value;
1346 BOOL boolvalue = TRUE;
1347 BOOL freesptr = TRUE;
1348 optionlist *ol, *ol2;
1352 uschar *inttype = US"";
1358 /* There may be leading spaces; thereafter, we expect an option name starting
1361 while (isspace(*s)) s++;
1363 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1365 /* Read the name of the option, and skip any subsequent white space. If
1366 it turns out that what we read was "hide", set the flag indicating that
1367 this is a secure option, and loop to read the next word. */
1369 for (n = 0; n < 2; n++)
1371 while (isalnum(*s) || *s == '_')
1373 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1377 while (isspace(*s)) s++;
1378 if (Ustrcmp(name, "hide") != 0) break;
1379 issecure = opt_secure;
1383 /* Deal with "no_" or "not_" here for booleans */
1385 if (Ustrncmp(name, "no_", 3) == 0)
1391 if (Ustrncmp(name, "not_", 4) == 0)
1397 /* Search the list for the given name. A non-existent name, or an option that
1398 is set twice, is a disaster. */
1400 ol = find_option(name + offset, oltop, last);
1404 if (unknown_txt == NULL) return FALSE;
1405 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1408 if ((ol->type & opt_set) != 0)
1410 uschar *mname = name;
1411 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1412 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1413 "\"%s\" option set for the second time", mname);
1416 ol->type |= opt_set | issecure;
1417 type = ol->type & opt_mask;
1419 /* Types with data values must be followed by '='; the "no[t]_" prefix
1420 applies only to boolean values. */
1422 if (type < opt_bool || type > opt_bool_last)
1425 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1426 "negation prefix applied to a non-boolean option");
1428 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1429 "unexpected end of line (data missing) after %s", name);
1431 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1434 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1435 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1436 ultimately expands to one of those values. */
1438 else if (*s != 0 && (offset != 0 || *s != '='))
1439 extra_chars_error(s, US"boolean option ", name, US"");
1441 /* Skip white space after = */
1443 if (*s == '=') while (isspace((*(++s))));
1445 /* If there is a data block and the opt_public flag is not set, change
1446 the data block pointer to the private options block. */
1448 if (data_block != NULL && (ol->type & opt_public) == 0)
1449 data_block = (void *)(((driver_instance *)data_block)->options_block);
1451 /* Now get the data according to the type. */
1455 /* If a string value is not enclosed in quotes, it consists of
1456 the rest of the current line, verbatim. Otherwise, string escapes
1459 A transport is specified as a string, which is then looked up in the
1460 list of transports. A search type is specified as one of a number of
1463 A set or rewrite rules for a driver is specified as a string, which is
1464 then parsed into a suitable chain of control blocks.
1466 Uids and gids are specified as strings which are then looked up in the
1467 passwd file. Lists of uids and gids are similarly specified as colon-
1468 separated strings. */
1473 case opt_expand_uid:
1474 case opt_expand_gid:
1479 reset_point = sptr = read_string(s, name);
1481 /* Having read a string, we now have several different ways of using it,
1482 depending on the data type, so do another switch. If keeping the actual
1483 string is not required (because it is interpreted), freesptr is set TRUE,
1484 and at the end we reset the pool. */
1488 /* If this was a string, set the variable to point to the new string,
1489 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1490 rules, we still keep the string (for printing), and parse the rules into a
1491 control block and flags word. */
1495 if (data_block == NULL)
1496 *((uschar **)(ol->value)) = sptr;
1498 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1500 if (type == opt_rewrite)
1505 rewrite_rule **chain;
1508 sprintf(CS name2, "*%.50s_rules", name);
1509 ol2 = find_option(name2, oltop, last);
1510 sprintf(CS name2, "*%.50s_flags", name);
1511 ol3 = find_option(name2, oltop, last);
1513 if (ol2 == NULL || ol3 == NULL)
1514 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1515 "rewrite rules not available for driver");
1517 if (data_block == NULL)
1519 chain = (rewrite_rule **)(ol2->value);
1520 flagptr = (int *)(ol3->value);
1524 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1525 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1528 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1531 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1533 chain = &(next->next);
1536 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1537 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1538 "non-header rewrite - not allowed at transport time -");
1542 /* If it was an expanded uid, see if there is any expansion to be
1543 done by checking for the presence of a $ character. If there is, save it
1544 in the corresponding *expand_user option field. Otherwise, fall through
1545 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1548 case opt_expand_uid:
1549 sprintf(CS name2, "*expand_%.50s", name);
1550 ol2 = find_option(name2, oltop, last);
1553 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1555 if (data_block == NULL)
1556 *((uschar **)(ol2->value)) = ss;
1558 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1562 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1568 /* Look up a fixed uid, and also make use of the corresponding gid
1569 if a passwd entry is returned and the gid has not been set. */
1572 if (!route_finduser(sptr, &pw, &uid))
1573 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1574 if (data_block == NULL)
1575 *((uid_t *)(ol->value)) = uid;
1577 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1579 /* Set the flag indicating a fixed value is set */
1581 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1583 /* Handle matching gid if we have a passwd entry: done by finding the
1584 same name with terminating "user" changed to "group"; if not found,
1585 ignore. Also ignore if the value is already set. */
1587 if (pw == NULL) break;
1588 Ustrcpy(name+Ustrlen(name)-4, "group");
1589 ol2 = find_option(name, oltop, last);
1590 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1591 (ol2->type & opt_mask) == opt_expand_gid))
1593 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1596 if (data_block == NULL)
1597 *((gid_t *)(ol2->value)) = pw->pw_gid;
1599 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1605 /* If it was an expanded gid, see if there is any expansion to be
1606 done by checking for the presence of a $ character. If there is, save it
1607 in the corresponding *expand_user option field. Otherwise, fall through
1608 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1611 case opt_expand_gid:
1612 sprintf(CS name2, "*expand_%.50s", name);
1613 ol2 = find_option(name2, oltop, last);
1616 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1618 if (data_block == NULL)
1619 *((uschar **)(ol2->value)) = ss;
1621 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1625 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1631 /* Handle freestanding gid */
1634 if (!route_findgroup(sptr, &gid))
1635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1636 if (data_block == NULL)
1637 *((gid_t *)(ol->value)) = gid;
1639 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1640 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1643 /* If it was a uid list, look up each individual entry, and build
1644 a vector of uids, with a count in the first element. Put the vector
1645 in malloc store so we can free the string. (We are reading into
1646 permanent store already.) */
1654 uschar *op = expand_string (sptr);
1657 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1658 name, expand_string_message);
1661 if (*p != 0) count++;
1662 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1663 list = store_malloc(count*sizeof(uid_t));
1664 list[ptr++] = (uid_t)(count - 1);
1666 if (data_block == NULL)
1667 *((uid_t **)(ol->value)) = list;
1669 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1675 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1676 if (!route_finduser(big_buffer, NULL, &uid))
1677 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1684 /* If it was a gid list, look up each individual entry, and build
1685 a vector of gids, with a count in the first element. Put the vector
1686 in malloc store so we can free the string. (We are reading into permanent
1695 uschar *op = expand_string (sptr);
1698 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1699 name, expand_string_message);
1702 if (*p != 0) count++;
1703 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1704 list = store_malloc(count*sizeof(gid_t));
1705 list[ptr++] = (gid_t)(count - 1);
1707 if (data_block == NULL)
1708 *((gid_t **)(ol->value)) = list;
1710 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1716 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1717 if (!route_findgroup(big_buffer, &gid))
1718 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1726 /* Release store if the value of the string doesn't need to be kept. */
1728 if (freesptr) store_reset(reset_point);
1731 /* Expanded boolean: if no characters follow, or if there are no dollar
1732 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1733 save the string for later expansion in the alternate place. */
1735 case opt_expand_bool:
1736 if (*s != 0 && Ustrchr(s, '$') != 0)
1738 sprintf(CS name2, "*expand_%.50s", name);
1739 ol2 = find_option(name2, oltop, last);
1742 reset_point = sptr = read_string(s, name);
1743 if (data_block == NULL)
1744 *((uschar **)(ol2->value)) = sptr;
1746 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1753 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1754 look for yes/not/true/false. Some booleans are stored in a single bit in
1755 a single int. There's a special fudge for verify settings; without a suffix
1756 they set both xx_sender and xx_recipient. The table points to the sender
1757 value; search subsequently for the recipient. There's another special case:
1758 opt_bool_set also notes when a boolean has been set. */
1762 case opt_bool_verify:
1766 s = readconf_readname(name2, 64, s);
1767 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1769 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1771 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1772 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1773 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1774 US"for boolean option ", name);
1777 /* Handle single-bit type. */
1779 if (type == opt_bit)
1781 int bit = 1 << ((ol->type >> 16) & 31);
1782 int *ptr = (data_block == NULL)?
1783 (int *)(ol->value) :
1784 (int *)((uschar *)data_block + (long int)ol->value);
1785 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1789 /* Handle full BOOL types */
1791 if (data_block == NULL)
1792 *((BOOL *)(ol->value)) = boolvalue;
1794 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1798 if (type == opt_bool_verify)
1800 sprintf(CS name2, "%.50s_recipient", name + offset);
1801 ol2 = find_option(name2, oltop, last);
1804 if (data_block == NULL)
1805 *((BOOL *)(ol2->value)) = boolvalue;
1807 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1811 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1813 else if (type == opt_bool_set)
1815 sprintf(CS name2, "*set_%.50s", name + offset);
1816 ol2 = find_option(name2, oltop, last);
1819 if (data_block == NULL)
1820 *((BOOL *)(ol2->value)) = TRUE;
1822 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1831 inttype = US"octal ";
1833 /* Integer: a simple(ish) case; allow octal and hex formats, and
1834 suffixes K and M. The different types affect output, not input. */
1843 lvalue = strtol(CS s, CSS &endptr, intbase);
1846 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1849 if (errno != ERANGE)
1851 if (tolower(*endptr) == 'k')
1853 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1854 else lvalue *= 1024;
1857 else if (tolower(*endptr) == 'm')
1859 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1861 else lvalue *= 1024*1024;
1866 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1867 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1868 "absolute value of integer \"%s\" is too large (overflow)", s);
1870 while (isspace(*endptr)) endptr++;
1872 extra_chars_error(endptr, inttype, US"integer value for ", name);
1874 value = (int)lvalue;
1877 if (data_block == NULL)
1878 *((int *)(ol->value)) = value;
1880 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1883 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1890 value = strtol(CS s, CSS &endptr, intbase);
1893 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1896 if (errno != ERANGE)
1898 if (tolower(*endptr) == 'm')
1900 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1904 else if (tolower(*endptr) == 'k')
1910 value = (value + 512)/1024;
1914 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1915 "absolute value of integer \"%s\" is too large (overflow)", s);
1917 while (isspace(*endptr)) endptr++;
1919 extra_chars_error(endptr, inttype, US"integer value for ", name);
1922 if (data_block == NULL)
1923 *((int *)(ol->value)) = value;
1925 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1928 /* Fixed-point number: held to 3 decimal places. */
1931 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1932 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1933 "fixed-point number expected for %s", name);
1935 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1936 "integer \"%s\" is too large (overflow)", s);
1940 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1941 "integer \"%s\" is too large (overflow)", s);
1943 if (s[count] == '.')
1946 while (isdigit(s[++count]))
1948 value += (s[count] - '0') * d;
1953 while (isspace(s[count])) count++;
1956 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1958 if (data_block == NULL)
1959 *((int *)(ol->value)) = value;
1961 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1964 /* There's a special routine to read time values. */
1967 value = readconf_readtime(s, 0, FALSE);
1969 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1971 if (data_block == NULL)
1972 *((int *)(ol->value)) = value;
1974 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1977 /* A time list is a list of colon-separated times, with the first
1978 element holding the size of the list and the second the number of
1984 int *list = (data_block == NULL)?
1985 (int *)(ol->value) :
1986 (int *)((uschar *)data_block + (long int)(ol->value));
1988 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1991 uschar *snext = Ustrchr(s, ':');
1995 while (ss > s && isspace(ss[-1])) ss--;
1998 value = readconf_readtime(s, terminator, FALSE);
2000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2002 if (count > 1 && value <= list[count])
2003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2004 "time value out of order for %s", name);
2005 list[count+1] = value;
2006 if (snext == NULL) break;
2008 while (isspace(*s)) s++;
2011 if (count > list[0] - 2)
2012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2014 if (count > 0 && list[2] == 0) count = 0;
2026 /*************************************************
2027 * Print a time value *
2028 *************************************************/
2031 Argument: a time value in seconds
2032 Returns: pointer to a fixed buffer containing the time as a string,
2033 in readconf_readtime() format
2037 readconf_printtime(int t)
2040 uschar *p = time_buffer;
2057 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2058 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2059 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2060 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2061 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2068 /*************************************************
2069 * Print an individual option value *
2070 *************************************************/
2072 /* This is used by the -bP option, so prints to the standard output.
2073 The entire options list is passed in as an argument, because some options come
2074 in pairs - typically uid/gid settings, which can either be explicit numerical
2075 values, or strings to be expanded later. If the numerical value is unset,
2076 search for "*expand_<name>" to see if there is a string equivalent.
2079 ol option entry, or NULL for an unknown option
2081 options_block NULL for main configuration options; otherwise points to
2082 a driver block; if the option doesn't have opt_public
2083 set, then options_block->options_block is where the item
2085 oltop points to the option list in which ol exists
2086 last one more than the offset of the last entry in optop
2092 print_ol(optionlist *ol, uschar *name, void *options_block,
2093 optionlist *oltop, int last)
2106 printf("%s is not a known option\n", name);
2110 /* Non-admin callers cannot see options that have been flagged secure by the
2113 if (!admin_user && (ol->type & opt_secure) != 0)
2115 printf("%s = <value not displayable>\n", name);
2119 /* Else show the value of the option */
2122 if (options_block != NULL)
2124 if ((ol->type & opt_public) == 0)
2125 options_block = (void *)(((driver_instance *)options_block)->options_block);
2126 value = (void *)((uschar *)options_block + (long int)value);
2129 switch(ol->type & opt_mask)
2132 case opt_rewrite: /* Show the text value */
2133 s = *((uschar **)value);
2134 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2138 printf("%s = %d\n", name, *((int *)value));
2143 int x = *((int *)value);
2144 if (x != 0 && (x & 1023) == 0)
2148 if ((x & 1023) == 0)
2153 printf("%s = %d%c\n", name, x, c);
2155 else printf("%s = %d\n", name, x);
2161 int x = *((int *)value);
2162 if (x == 0) printf("%s = 0\n", name);
2163 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2164 else printf("%s = %dK\n", name, x);
2169 printf("%s = %#o\n", name, *((int *)value));
2172 /* Can be negative only when "unset", in which case integer */
2176 int x = *((int *)value);
2179 if (x < 0) printf("%s =\n", name); else
2181 printf("%s = %d.", name, x/1000);
2194 /* If the numerical value is unset, try for the string value */
2196 case opt_expand_uid:
2197 if (! *get_set_flag(name, oltop, last, options_block))
2199 sprintf(CS name2, "*expand_%.50s", name);
2200 ol2 = find_option(name2, oltop, last);
2203 void *value2 = ol2->value;
2204 if (options_block != NULL)
2205 value2 = (void *)((uschar *)options_block + (long int)value2);
2206 s = *((uschar **)value2);
2207 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2212 /* Else fall through */
2215 if (! *get_set_flag(name, oltop, last, options_block))
2216 printf("%s =\n", name);
2219 pw = getpwuid(*((uid_t *)value));
2221 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2222 else printf("%s = %s\n", name, pw->pw_name);
2226 /* If the numerical value is unset, try for the string value */
2228 case opt_expand_gid:
2229 if (! *get_set_flag(name, oltop, last, options_block))
2231 sprintf(CS name2, "*expand_%.50s", name);
2232 ol2 = find_option(name2, oltop, last);
2233 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2235 void *value2 = ol2->value;
2236 if (options_block != NULL)
2237 value2 = (void *)((uschar *)options_block + (long int)value2);
2238 s = *((uschar **)value2);
2239 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2244 /* Else fall through */
2247 if (! *get_set_flag(name, oltop, last, options_block))
2248 printf("%s =\n", name);
2251 gr = getgrgid(*((int *)value));
2253 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2254 else printf("%s = %s\n", name, gr->gr_name);
2259 uidlist = *((uid_t **)value);
2260 printf("%s =", name);
2261 if (uidlist != NULL)
2265 for (i = 1; i <= (int)(uidlist[0]); i++)
2267 uschar *name = NULL;
2268 pw = getpwuid(uidlist[i]);
2269 if (pw != NULL) name = US pw->pw_name;
2270 if (name != NULL) printf("%c%s", sep, name);
2271 else printf("%c%ld", sep, (long int)(uidlist[i]));
2279 gidlist = *((gid_t **)value);
2280 printf("%s =", name);
2281 if (gidlist != NULL)
2285 for (i = 1; i <= (int)(gidlist[0]); i++)
2287 uschar *name = NULL;
2288 gr = getgrgid(gidlist[i]);
2289 if (gr != NULL) name = US gr->gr_name;
2290 if (name != NULL) printf("%c%s", sep, name);
2291 else printf("%c%ld", sep, (long int)(gidlist[i]));
2299 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2305 int *list = (int *)value;
2306 printf("%s = ", name);
2307 for (i = 0; i < list[1]; i++)
2308 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2314 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2318 case opt_expand_bool:
2319 sprintf(CS name2, "*expand_%.50s", name);
2320 ol2 = find_option(name2, oltop, last);
2321 if (ol2 != NULL && ol2->value != NULL)
2323 void *value2 = ol2->value;
2324 if (options_block != NULL)
2325 value2 = (void *)((uschar *)options_block + (long int)value2);
2326 s = *((uschar **)value2);
2329 printf("%s = %s\n", name, string_printing(s));
2332 /* s == NULL => string not set; fall through */
2338 case opt_bool_verify:
2340 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2347 /*************************************************
2348 * Print value from main configuration *
2349 *************************************************/
2351 /* This function, called as a result of encountering the -bP option,
2352 causes the value of any main configuration variable to be output if the
2353 second argument is NULL. There are some special values:
2355 all print all main configuration options
2356 configure_file print the name of the configuration file
2357 routers print the routers' configurations
2358 transports print the transports' configuration
2359 authenticators print the authenticators' configuration
2360 router_list print a list of router names
2361 transport_list print a list of transport names
2362 authenticator_list print a list of authentication mechanism names
2363 +name print a named list item
2364 local_scan print the local_scan options
2366 If the second argument is not NULL, it must be one of "router", "transport", or
2367 "authenticator" in which case the first argument identifies the driver whose
2368 options are to be printed.
2371 name option name if type == NULL; else driver name
2372 type NULL or driver type name, as described above
2378 readconf_print(uschar *name, uschar *type)
2380 BOOL names_only = FALSE;
2382 optionlist *ol2 = NULL;
2383 driver_instance *d = NULL;
2393 static uschar *types[] = { US"address", US"domain", US"host",
2395 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2396 &hostlist_anchor, &localpartlist_anchor };
2398 for (i = 0; i < 4; i++)
2400 t = tree_search(*(anchors[i]), name+1);
2404 printf("%slist %s = %s\n", types[i], name+1,
2405 ((namedlist_block *)(t->data.ptr))->string);
2410 printf("no address, domain, host, or local part list called \"%s\" "
2411 "exists\n", name+1);
2416 if (Ustrcmp(name, "configure_file") == 0)
2418 printf("%s\n", CS config_main_filename);
2422 if (Ustrcmp(name, "all") == 0)
2424 for (ol = optionlist_config;
2425 ol < optionlist_config + optionlist_config_size; ol++)
2427 if ((ol->type & opt_hidden) == 0)
2428 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2433 if (Ustrcmp(name, "local_scan") == 0)
2435 #ifndef LOCAL_SCAN_HAS_OPTIONS
2436 printf("local_scan() options are not supported\n");
2438 for (ol = local_scan_options;
2439 ol < local_scan_options + local_scan_options_count; ol++)
2441 print_ol(ol, US ol->name, NULL, local_scan_options,
2442 local_scan_options_count);
2448 if (Ustrcmp(name, "routers") == 0)
2453 else if (Ustrcmp(name, "transports") == 0)
2455 type = US"transport";
2459 else if (Ustrcmp(name, "authenticators") == 0)
2461 type = US"authenticator";
2465 else if (Ustrcmp(name, "authenticator_list") == 0)
2467 type = US"authenticator";
2472 else if (Ustrcmp(name, "router_list") == 0)
2478 else if (Ustrcmp(name, "transport_list") == 0)
2480 type = US"transport";
2486 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2487 name, NULL, optionlist_config, optionlist_config_size);
2492 /* Handle the options for a router or transport. Skip options that are flagged
2493 as hidden. Some of these are options with names starting with '*', used for
2494 internal alternative representations of other options (which the printing
2495 function will sort out). Others are synonyms kept for backward compatibility.
2498 if (Ustrcmp(type, "router") == 0)
2500 d = (driver_instance *)routers;
2501 ol2 = optionlist_routers;
2502 size = optionlist_routers_size;
2504 else if (Ustrcmp(type, "transport") == 0)
2506 d = (driver_instance *)transports;
2507 ol2 = optionlist_transports;
2508 size = optionlist_transports_size;
2510 else if (Ustrcmp(type, "authenticator") == 0)
2512 d = (driver_instance *)auths;
2513 ol2 = optionlist_auths;
2514 size = optionlist_auths_size;
2519 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2523 /* Either search for a given driver, or print all of them */
2525 for (; d != NULL; d = d->next)
2528 printf("\n%s %s:\n", d->name, type);
2529 else if (Ustrcmp(d->name, name) != 0) continue;
2531 for (ol = ol2; ol < ol2 + size; ol++)
2533 if ((ol->type & opt_hidden) == 0)
2534 print_ol(ol, US ol->name, d, ol2, size);
2537 for (ol = d->info->options;
2538 ol < d->info->options + *(d->info->options_count); ol++)
2540 if ((ol->type & opt_hidden) == 0)
2541 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2543 if (name != NULL) return;
2545 if (name != NULL) printf("%s %s not found\n", type, name);
2550 /*************************************************
2551 * Read a named list item *
2552 *************************************************/
2554 /* This function reads a name and a list (i.e. string). The name is used to
2555 save the list in a tree, sorted by its name. Each entry also has a number,
2556 which can be used for caching tests, but if the string contains any expansion
2557 items other than $key, the number is set negative to inhibit caching. This
2558 mechanism is used for domain, host, and address lists that are referenced by
2562 anchorp points to the tree anchor
2563 numberp points to the current number for this tree
2564 max the maximum number permitted
2565 s the text of the option line, starting immediately after the name
2567 tname the name of the list type, for messages
2573 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2576 BOOL forcecache = FALSE;
2579 namedlist_block *nb = store_get(sizeof(namedlist_block));
2581 if (Ustrncmp(s, "_cache", 6) == 0)
2588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2590 if (*numberp >= max)
2591 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2594 while (isspace(*s)) s++;
2596 while (isalnum(*s) || *s == '_') s++;
2597 t = store_get(sizeof(tree_node) + s-ss);
2598 Ustrncpy(t->name, ss, s-ss);
2600 while (isspace(*s)) s++;
2602 if (!tree_insertnode(anchorp, t))
2603 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2604 "duplicate name \"%s\" for a named %s", t->name, tname);
2607 nb->number = *numberp;
2610 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2611 "missing '=' after \"%s\"", t->name);
2612 while (isspace(*s)) s++;
2613 nb->string = read_string(s, t->name);
2614 nb->cache_data = NULL;
2616 /* Check the string for any expansions; if any are found, mark this list
2617 uncacheable unless the user has explicited forced caching. */
2619 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2625 /*************************************************
2626 * Unpick data for a rate limit *
2627 *************************************************/
2629 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2633 s string, in the form t,b,f,l
2634 where t is the threshold (integer)
2635 b is the initial delay (time)
2636 f is the multiplicative factor (fixed point)
2637 k is the maximum time (time)
2638 threshold where to store threshold
2639 base where to store base in milliseconds
2640 factor where to store factor in milliseconds
2641 limit where to store limit
2643 Returns: nothing (panics on error)
2647 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2650 uschar bstring[16], lstring[16];
2652 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2653 factor, lstring) == 4)
2655 *base = readconf_readtime(bstring, 0, TRUE);
2656 *limit = readconf_readtime(lstring, 0, TRUE);
2657 if (*base >= 0 && *limit >= 0) return;
2659 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2665 /*************************************************
2666 * Read main configuration options *
2667 *************************************************/
2669 /* This function is the first to be called for configuration reading. It
2670 opens the configuration file and reads general configuration settings until
2671 it reaches the end of the configuration section. The file is then left open so
2672 that the remaining configuration data can subsequently be read if needed for
2675 The configuration file must be owned either by root or exim, and be writeable
2676 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2677 in the config file, so the test is done on the compiled in values. A slight
2678 anomaly, to be carefully documented.
2680 The name of the configuration file is taken from a list that is included in the
2681 binary of Exim. It can be altered from the command line, but if that is done,
2682 root privilege is immediately withdrawn unless the caller is root or exim.
2683 The first file on the list that exists is used.
2685 For use on multiple systems that share file systems, first look for a
2686 configuration file whose name has the current node name on the end. If that is
2687 not found, try the generic name. For really contorted configurations, that run
2688 multiple Exims with different uid settings, first try adding the effective uid
2689 before the node name. These complications are going to waste resources on most
2690 systems. Therefore they are available only when requested by compile-time
2697 struct stat statbuf;
2698 uschar *s, *filename;
2699 uschar *list = config_main_filelist;
2701 /* Loop through the possible file names */
2703 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2706 /* Cut out all the fancy processing unless specifically wanted */
2708 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2709 uschar *suffix = filename + Ustrlen(filename);
2711 /* Try for the node-specific file if a node name exists */
2713 #ifdef CONFIGURE_FILE_USE_NODE
2715 if (uname(&uts) >= 0)
2717 #ifdef CONFIGURE_FILE_USE_EUID
2718 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2719 config_file = Ufopen(filename, "rb");
2720 if (config_file == NULL)
2721 #endif /* CONFIGURE_FILE_USE_EUID */
2723 sprintf(CS suffix, ".%.256s", uts.nodename);
2724 config_file = Ufopen(filename, "rb");
2727 #endif /* CONFIGURE_FILE_USE_NODE */
2729 /* Otherwise, try the generic name, possibly with the euid added */
2731 #ifdef CONFIGURE_FILE_USE_EUID
2732 if (config_file == NULL)
2734 sprintf(CS suffix, ".%ld", (long int)original_euid);
2735 config_file = Ufopen(filename, "rb");
2737 #endif /* CONFIGURE_FILE_USE_EUID */
2739 /* Finally, try the unadorned name */
2741 if (config_file == NULL)
2744 config_file = Ufopen(filename, "rb");
2746 #else /* if neither defined */
2748 /* This is the common case when the fancy processing is not included. */
2750 config_file = Ufopen(filename, "rb");
2753 /* If the file does not exist, continue to try any others. For any other
2754 error, break out (and die). */
2756 if (config_file != NULL || errno != ENOENT) break;
2759 /* On success, save the name for verification; config_filename is used when
2760 logging configuration errors (it changes for .included files) whereas
2761 config_main_filename is the name shown by -bP. Failure to open a configuration
2762 file is a serious disaster. */
2764 if (config_file != NULL)
2766 config_filename = config_main_filename = string_copy(filename);
2770 if (filename == NULL)
2771 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2772 "%s", config_main_filelist);
2774 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2775 "configuration file %s", filename));
2778 /* Check the status of the file we have opened, unless it was specified on
2779 the command line, in which case privilege was given away at the start. */
2781 if (!config_changed)
2783 if (fstat(fileno(config_file), &statbuf) != 0)
2784 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2787 if ((statbuf.st_uid != root_uid && /* owner not root */
2788 statbuf.st_uid != exim_uid /* owner not exim */
2789 #ifdef CONFIGURE_OWNER
2790 && statbuf.st_uid != config_uid /* owner not the special one */
2793 (statbuf.st_gid != exim_gid /* group not exim & */
2794 #ifdef CONFIGURE_GROUP
2795 && statbuf.st_gid != config_gid /* group not the special one */
2797 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2799 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2801 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2802 "wrong owner, group, or mode", big_buffer);
2805 /* Process the main configuration settings. They all begin with a lower case
2806 letter. If we see something starting with an upper case letter, it is taken as
2807 a macro definition. */
2809 while ((s = get_config_line()) != NULL)
2811 if (isupper(s[0])) read_macro_assignment(s);
2813 else if (Ustrncmp(s, "domainlist", 10) == 0)
2814 read_named_list(&domainlist_anchor, &domainlist_count,
2815 MAX_NAMED_LIST, s+10, US"domain list");
2817 else if (Ustrncmp(s, "hostlist", 8) == 0)
2818 read_named_list(&hostlist_anchor, &hostlist_count,
2819 MAX_NAMED_LIST, s+8, US"host list");
2821 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2822 read_named_list(&addresslist_anchor, &addresslist_count,
2823 MAX_NAMED_LIST, s+11, US"address list");
2825 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2826 read_named_list(&localpartlist_anchor, &localpartlist_count,
2827 MAX_NAMED_LIST, s+13, US"local part list");
2830 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2831 NULL, US"main option \"%s\" unknown");
2835 /* If local_sender_retain is set, local_from_check must be unset. */
2837 if (local_sender_retain && local_from_check)
2838 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2839 "local_sender_retain are set; this combination is not allowed");
2841 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2844 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2846 /* The max retry interval must not be greater than 24 hours. */
2848 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2850 /* remote_max_parallel must be > 0 */
2852 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2854 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2855 start of a new SMTP message. */
2857 freeze_tell_config = freeze_tell;
2859 /* The primary host name may be required for expansion of spool_directory
2860 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2861 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2862 canonize it. Some people like upper case letters in their host names, so we
2863 don't force the case. */
2865 if (primary_hostname == NULL)
2869 if (uname(&uts) < 0)
2870 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2871 hostname = US uts.nodename;
2873 if (Ustrchr(hostname, '.') == NULL)
2876 struct hostent *hostdata;
2879 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2880 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2890 #if HAVE_GETIPNODEBYNAME
2892 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2894 hostdata = gethostbyname2(CS hostname, af);
2897 hostdata = gethostbyname(CS hostname);
2900 if (hostdata != NULL)
2902 hostname = US hostdata->h_name;
2906 if (af == AF_INET) break;
2911 primary_hostname = string_copy(hostname);
2914 /* Set up default value for smtp_active_hostname */
2916 smtp_active_hostname = primary_hostname;
2918 /* If spool_directory wasn't set in the build-time configuration, it must have
2919 got set above. Of course, writing to the log may not work if log_file_path is
2920 not set, but it will at least get to syslog or somewhere, with any luck. */
2922 if (*spool_directory == 0)
2923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2926 /* Expand the spool directory name; it may, for example, contain the primary
2927 host name. Same comment about failure. */
2929 s = expand_string(spool_directory);
2931 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2932 "\"%s\": %s", spool_directory, expand_string_message);
2933 spool_directory = s;
2935 /* Expand log_file_path, which must contain "%s" in any component that isn't
2936 the null string or "syslog". It is also allowed to contain one instance of %D.
2937 However, it must NOT contain % followed by anything else. */
2939 if (*log_file_path != 0)
2942 int sep = ':'; /* Fixed for log file path */
2943 s = expand_string(log_file_path);
2945 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2946 "\"%s\": %s", log_file_path, expand_string_message);
2949 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2952 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2953 t = Ustrstr(sss, "%s");
2955 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2956 "contain \"%%s\"", sss);
2958 t = Ustrchr(sss, '%');
2961 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2962 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2963 "unexpected \"%%\" character", s);
2970 /* Interpret syslog_facility into an integer argument for 'ident' param to
2971 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2974 if (syslog_facility_str != NULL)
2977 uschar *s = syslog_facility_str;
2979 if ((Ustrlen(syslog_facility_str) >= 4) &&
2980 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2983 for (i = 0; i < syslog_list_size; i++)
2985 if (strcmpic(s, syslog_list[i].name) == 0)
2987 syslog_facility = syslog_list[i].value;
2992 if (i >= syslog_list_size)
2994 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2995 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2999 /* Expand pid_file_path */
3001 if (*pid_file_path != 0)
3003 s = expand_string(pid_file_path);
3005 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3006 "\"%s\": %s", pid_file_path, expand_string_message);
3010 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3013 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3015 /* Unpick the SMTP rate limiting options, if set */
3017 if (smtp_ratelimit_mail != NULL)
3019 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3020 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3023 if (smtp_ratelimit_rcpt != NULL)
3025 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3026 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3029 /* The qualify domains default to the primary host name */
3031 if (qualify_domain_sender == NULL)
3032 qualify_domain_sender = primary_hostname;
3033 if (qualify_domain_recipient == NULL)
3034 qualify_domain_recipient = qualify_domain_sender;
3036 /* Setting system_filter_user in the configuration sets the gid as well if a
3037 name is given, but a numerical value does not. */
3039 if (system_filter_uid_set && !system_filter_gid_set)
3041 struct passwd *pw = getpwuid(system_filter_uid);
3043 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3044 (long int)system_filter_uid);
3045 system_filter_gid = pw->pw_gid;
3046 system_filter_gid_set = TRUE;
3049 /* If the errors_reply_to field is set, check that it is syntactically valid
3050 and ensure it contains a domain. */
3052 if (errors_reply_to != NULL)
3055 int start, end, domain;
3056 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3057 &start, &end, &domain, FALSE);
3059 if (recipient == NULL)
3060 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3061 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3064 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3065 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3068 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3069 smtp_accept_max must also be set. */
3071 if (smtp_accept_max == 0 &&
3072 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3073 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3074 "smtp_accept_max must be set if smtp_accept_queue or "
3075 "smtp_accept_max_per_host is set");
3077 /* Set up the host number if anything is specified. It is an expanded string
3078 so that it can be computed from the host name, for example. We do this last
3079 so as to ensure that everything else is set up before the expansion. */
3081 if (host_number_string != NULL)
3084 uschar *s = expand_string(host_number_string);
3085 long int n = Ustrtol(s, &end, 0);
3086 while (isspace(*end)) end++;
3088 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3089 "localhost_number value is not a number: %s", s);
3090 if (n > LOCALHOST_MAX)
3091 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3092 "localhost_number is greater than the maximum allowed value (%d)",
3098 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3100 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3101 tls_verify_certificates == NULL)
3102 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3103 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3104 (tls_verify_hosts != NULL)? "" : "try_");
3110 /*************************************************
3111 * Initialize one driver *
3112 *************************************************/
3114 /* This is called once the driver's generic options, if any, have been read.
3115 We can now find the driver, set up defaults for the private options, and
3116 unset any "set" bits in the private options table (which might have been
3117 set by another incarnation of the same driver).
3120 d pointer to driver instance block, with generic
3122 drivers_available vector of available drivers
3123 size_of_info size of each block in drivers_available
3124 class class of driver, for error message
3126 Returns: pointer to the driver info block
3129 static driver_info *
3130 init_driver(driver_instance *d, driver_info *drivers_available,
3131 int size_of_info, uschar *class)
3135 for (dd = drivers_available; dd->driver_name[0] != 0;
3136 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3138 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3141 int len = dd->options_len;
3143 d->options_block = store_get(len);
3144 memcpy(d->options_block, dd->options_block, len);
3145 for (i = 0; i < *(dd->options_count); i++)
3146 dd->options[i].type &= ~opt_set;
3151 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3152 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3154 return NULL; /* never obeyed */
3160 /*************************************************
3161 * Initialize driver list *
3162 *************************************************/
3164 /* This function is called for routers, transports, and authentication
3165 mechanisms. It reads the data from the current point in the configuration file
3166 up to the end of the section, and sets up a chain of instance blocks according
3167 to the file's contents. The file will already have been opened by a call to
3168 readconf_main, and must be left open for subsequent reading of further data.
3170 Any errors cause a panic crash. Note that the blocks with names driver_info and
3171 driver_instance must map the first portions of all the _info and _instance
3172 blocks for this shared code to work.
3175 class "router", "transport", or "authenticator"
3176 anchor &routers, &transports, &auths
3177 drivers_available available drivers
3178 size_of_info size of each info block
3179 instance_default points to default data for an instance
3180 instance_size size of instance block
3181 driver_optionlist generic option list
3182 driver_optionlist_count count of generic option list
3188 readconf_driver_init(
3190 driver_instance **anchor,
3191 driver_info *drivers_available,
3193 void *instance_default,
3195 optionlist *driver_optionlist,
3196 int driver_optionlist_count)
3198 driver_instance **p = anchor;
3199 driver_instance *d = NULL;
3202 while ((buffer = get_config_line()) != NULL)
3207 /* Read the first name on the line and test for the start of a new driver. A
3208 macro definition indicates the end of the previous driver. If this isn't the
3209 start of a new driver, the line will be re-read. */
3211 s = readconf_readname(name, sizeof(name), buffer);
3213 /* Handle macro definition, first finishing off the initialization of the
3214 previous driver, if any. */
3216 if (isupper(*name) && *s == '=')
3220 if (d->driver_name == NULL)
3221 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3222 "no driver defined for %s \"%s\"", class, d->name);
3226 read_macro_assignment(buffer);
3230 /* If the line starts with a name terminated by a colon, we are at the
3231 start of the definition of a new driver. The rest of the line must be
3238 /* Finish off initializing the previous driver. */
3242 if (d->driver_name == NULL)
3243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3244 "no driver defined for %s \"%s\"", class, d->name);
3248 /* Check that we haven't already got a driver of this name */
3250 for (d = *anchor; d != NULL; d = d->next)
3251 if (Ustrcmp(name, d->name) == 0)
3252 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3253 "there are two %ss called \"%s\"", class, name);
3255 /* Set up a new driver instance data block on the chain, with
3256 its default values installed. */
3258 d = store_get(instance_size);
3259 memcpy(d, instance_default, instance_size);
3262 d->name = string_copy(name);
3264 /* Clear out the "set" bits in the generic options */
3266 for (i = 0; i < driver_optionlist_count; i++)
3267 driver_optionlist[i].type &= ~opt_set;
3269 /* Check nothing more on this line, then do the next loop iteration. */
3271 while (isspace(*s)) s++;
3272 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3276 /* Not the start of a new driver. Give an error if we have not set up a
3277 current driver yet. */
3279 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3280 "%s name missing", class);
3282 /* First look to see if this is a generic option; if it is "driver",
3283 initialize the driver. If is it not a generic option, we can look for a
3284 private option provided that the driver has been previously set up. */
3286 if (readconf_handle_option(buffer, driver_optionlist,
3287 driver_optionlist_count, d, NULL))
3289 if (d->info == NULL && d->driver_name != NULL)
3290 init_driver(d, drivers_available, size_of_info, class);
3293 /* Handle private options - pass the generic block because some may
3294 live therein. A flag with each option indicates if it is in the public
3297 else if (d->info != NULL)
3299 readconf_handle_option(buffer, d->info->options,
3300 *(d->info->options_count), d, US"option \"%s\" unknown");
3303 /* The option is not generic and the driver name has not yet been given. */
3305 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3306 "(\"driver\" must be specified before any private options)", name);
3309 /* Run the initialization function for the final driver. */
3313 if (d->driver_name == NULL)
3314 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3315 "no driver defined for %s \"%s\"", class, d->name);
3322 /*************************************************
3323 * Check driver dependency *
3324 *************************************************/
3326 /* This function is passed a driver instance and a string. It checks whether
3327 any of the string options for the driver contains the given string as an
3331 d points to a driver instance block
3332 s the string to search for
3334 Returns: TRUE if a dependency is found
3338 readconf_depends(driver_instance *d, uschar *s)
3340 int count = *(d->info->options_count);
3344 for (ol = d->info->options; ol < d->info->options + count; ol++)
3346 void *options_block;
3348 int type = ol->type & opt_mask;
3349 if (type != opt_stringptr) continue;
3350 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3351 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3352 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3354 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3355 isalnum(ss[Ustrlen(s)])) continue;
3356 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3357 d->name, ol->name, s);
3362 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3369 /*************************************************
3370 * Decode an error type for retries *
3371 *************************************************/
3373 /* This function is global because it is also called from the main
3374 program when testing retry information. It decodes strings such as "quota_7d"
3375 into numerical error codes.
3378 pp points to start of text
3379 p points past end of text
3380 basic_errno points to an int to receive the main error number
3381 more_errno points to an int to receive the secondary error data
3383 Returns: NULL if decoded correctly; else points to error text
3387 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3391 while (q < p && *q != '_') q++;
3394 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3396 *basic_errno = ERRNO_EXIMQUOTA;
3397 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3398 return US"bad time value";
3401 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3403 *basic_errno = ECONNREFUSED;
3406 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3407 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3408 else return US"A or MX expected after \"refused\"";
3412 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3414 *basic_errno = ETIMEDOUT;
3418 int xlen = p - q - 1;
3421 static uschar *extras[] =
3422 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3423 static int values[] =
3424 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3426 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3428 if (strncmpic(x, extras[i], xlen) == 0)
3430 *more_errno = values[i];
3435 if (i >= sizeof(extras)/sizeof(uschar *))
3437 if (strncmpic(x, US"DNS", xlen) == 0)
3439 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3440 "available in retry rules (it has never worked) - treated as "
3443 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3448 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3449 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3450 strncmpic(pp, US"data_4", 6) == 0)
3453 int x = 255; /* means "any 4xx code" */
3454 if (p != pp + 8) bad = TRUE; else
3456 int a = pp[6], b = pp[7];
3460 if (isdigit(b)) x += b - '0';
3461 else if (b == 'x') x += 100;
3464 else if (a != 'x' || b != 'x') bad = TRUE;
3468 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3469 "x is literal and d is any digit", pp);
3471 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3472 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3473 *more_errno = x << 8;
3476 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3477 strncmpic(q+1, US"failed", p-q-1) == 0)
3478 *basic_errno = ERRNO_AUTHFAIL;
3480 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3481 *basic_errno = ERRNO_SMTPCLOSED;
3483 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3484 *basic_errno = ERRNO_TLSREQUIRED;
3486 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3487 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3495 /*************************************************
3496 * Read retry information *
3497 *************************************************/
3499 /* Each line of retry information contains:
3501 . A domain name pattern or an address pattern;
3503 . An error name, possibly with additional data, or *;
3505 . An optional sequence of retry items, each consisting of an identifying
3506 letter, a cutoff time, and optional parameters.
3508 All this is decoded and placed into a control block. */
3511 /* Subroutine to read an argument, preceded by a comma and terminated
3512 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3513 1 = fixed point number (returned *1000).
3516 paddr pointer to pointer to current character; updated
3517 type 0 => read a time; 1 => read a fixed point number
3519 Returns: time in seconds or fixed point number * 1000
3523 retry_arg(uschar **paddr, int type)
3528 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3530 while (isspace(*p)) p++;
3532 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3534 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3535 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3541 return readconf_readtime(pp, *p, FALSE);
3543 return readconf_readfixed(pp, *p);
3545 return 0; /* Keep picky compilers happy */
3548 /* The function proper */
3551 readconf_retries(void)
3553 retry_config **chain = &retries;
3557 while ((p = get_config_line()) != NULL)
3559 retry_rule **rchain;
3562 next = store_get(sizeof(retry_config));
3565 chain = &(next->next);
3566 next->basic_errno = next->more_errno = 0;
3567 next->senders = NULL;
3569 rchain = &(next->rules);
3571 next->pattern = string_dequote(&p);
3572 while (isspace(*p)) p++;
3574 while (mac_isgraph(*p)) p++;
3575 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3576 "missing error type");
3578 /* Test error names for things we understand. */
3580 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3581 &(next->more_errno))) != NULL)
3582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3584 /* There may be an optional address list of senders to be used as another
3585 constraint on the rule. This was added later, so the syntax is a bit of a
3586 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3589 while (isspace(*p)) p++;
3590 if (Ustrncmp(p, "senders", 7) == 0)
3593 while (isspace(*p)) p++;
3594 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3595 "\"=\" expected after \"senders\" in retry rule");
3596 while (isspace(*p)) p++;
3597 next->senders = string_dequote(&p);
3600 /* Now the retry rules. Keep the maximum timeout encountered. */
3602 while (isspace(*p)) p++;
3606 retry_rule *rule = store_get(sizeof(retry_rule));
3608 rchain = &(rule->next);
3610 rule->rule = toupper(*p++);
3611 rule->timeout = retry_arg(&p, 0);
3612 if (rule->timeout > retry_maximum_timeout)
3613 retry_maximum_timeout = rule->timeout;
3617 case 'F': /* Fixed interval */
3618 rule->p1 = retry_arg(&p, 0);
3621 case 'G': /* Geometrically increasing intervals */
3622 case 'H': /* Ditto, but with randomness */
3623 rule->p1 = retry_arg(&p, 0);
3624 rule->p2 = retry_arg(&p, 1);
3628 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3632 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3633 (rule->rule != 'F' && rule->p2 < 1000))
3634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3635 "bad parameters for retry rule");
3637 while (isspace(*p)) p++;
3641 while (isspace(*p)) p++;
3644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3651 /*************************************************
3652 * Initialize authenticators *
3653 *************************************************/
3655 /* Read the authenticators section of the configuration file.
3664 auth_instance *au, *bu;
3665 readconf_driver_init(US"authenticator",
3666 (driver_instance **)(&auths), /* chain anchor */
3667 (driver_info *)auths_available, /* available drivers */
3668 sizeof(auth_info), /* size of info block */
3669 &auth_defaults, /* default values for generic options */
3670 sizeof(auth_instance), /* size of instance block */
3671 optionlist_auths, /* generic options */
3672 optionlist_auths_size);
3674 for (au = auths; au != NULL; au = au->next)
3676 if (au->public_name == NULL)
3677 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3678 "the %s authenticator", au->name);
3679 for (bu = au->next; bu != NULL; bu = bu->next)
3681 if (strcmpic(au->public_name, bu->public_name) == 0)
3683 if ((au->client && bu->client) || (au->server && bu->server))
3684 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3685 "(%s and %s) have the same public name (%s)",
3686 (au->client)? US"client" : US"server", au->name, bu->name,
3696 /*************************************************
3697 * Read ACL information *
3698 *************************************************/
3700 /* If this run of Exim is not doing something that involves receiving a
3701 message, we can just skip over the ACL information. No need to parse it.
3703 First, we have a function for acl_read() to call back to get the next line. We
3704 need to remember the line we passed, because at the end it will contain the
3705 name of the next ACL. */
3707 static uschar *acl_line;
3712 acl_line = get_config_line();
3717 /* Now the main function:
3720 skip TRUE when this Exim process is doing something that will
3721 not need the ACL data
3727 readconf_acl(BOOL skip)
3731 /* Not receiving messages, don't need to parse the ACL data */
3735 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3736 while ((p = get_config_line()) != NULL);
3740 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3743 acl_line = get_config_line();
3745 while(acl_line != NULL)
3751 p = readconf_readname(name, sizeof(name), acl_line);
3752 if (isupper(*name) && *p == '=')
3754 read_macro_assignment(acl_line);
3755 acl_line = get_config_line();
3759 if (*p != ':' || name[0] == 0)
3760 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3762 node = store_get(sizeof(tree_node) + Ustrlen(name));
3763 Ustrcpy(node->name, name);
3764 if (!tree_insertnode(&acl_anchor, node))
3765 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3766 "there are two ACLs called \"%s\"", name);
3768 node->data.ptr = acl_read(acl_callback, &error);
3770 if (node->data.ptr == NULL && error != NULL)
3771 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3777 /*************************************************
3778 * Read configuration for local_scan() *
3779 *************************************************/
3781 /* This function is called after "begin local_scan" is encountered in the
3782 configuration file. If the local_scan() function allows for configuration
3783 options, we can process them. Otherwise, we expire in a panic.
3790 local_scan_init(void)
3792 #ifndef LOCAL_SCAN_HAS_OPTIONS
3793 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3794 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3798 while ((p = get_config_line()) != NULL)
3800 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3801 NULL, US"local_scan option \"%s\" unknown");
3808 /*************************************************
3809 * Read rest of configuration (after main) *
3810 *************************************************/
3812 /* This function reads the rest of the runtime configuration, after the main
3813 configuration. It is called only when actually needed. Each subsequent section
3814 of the configuration starts with a line of the form
3818 where the name is "routers", "transports", etc. A section is terminated by
3819 hitting the next "begin" line, and the next name is left in next_section.
3820 Because it may confuse people as to whether the names are singular or plural,
3821 we add "s" if it's missing. There is always enough room in next_section for
3822 this. This function is basically just a switch.
3825 skip_acl TRUE if ACL information is not needed
3830 static uschar *section_list[] = {
3840 readconf_rest(BOOL skip_acl)
3844 while(next_section[0] != 0)
3848 int last = sizeof(section_list) / sizeof(uschar *);
3850 int n = Ustrlen(next_section);
3852 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3856 int c = strcmpic(next_section, section_list[mid]);
3858 if (c > 0) first = mid + 1; else last = mid;
3860 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3861 "\"%.*s\" is not a known configuration section name", n, next_section);
3862 mid = (last + first)/2;
3866 if (((had ^= bit) & bit) == 0)
3867 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3868 "\"%.*s\" section is repeated in the configuration file", n,
3873 case 0: readconf_acl(skip_acl); break;
3874 case 1: auths_init(); break;
3875 case 2: local_scan_init(); break;
3876 case 3: readconf_retries(); break;
3877 case 4: readconf_rewrites(); break;
3878 case 5: route_init(); break;
3879 case 6: transport_init(); break;
3883 (void)fclose(config_file);
3886 /* End of readconf.c */