1 /* $Cambridge: exim/src/src/readconf.c,v 1.28 2007/01/22 16:29:54 ph10 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_predata", opt_stringptr, &acl_smtp_predata },
154 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
155 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
157 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
159 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
160 { "admin_groups", opt_gidlist, &admin_groups },
161 { "allow_domain_literals", opt_bool, &allow_domain_literals },
162 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
163 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
164 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
165 { "auto_thaw", opt_time, &auto_thaw },
166 #ifdef WITH_CONTENT_SCAN
167 { "av_scanner", opt_stringptr, &av_scanner },
169 { "bi_command", opt_stringptr, &bi_command },
170 #ifdef EXPERIMENTAL_BRIGHTMAIL
171 { "bmi_config_file", opt_stringptr, &bmi_config_file },
173 { "bounce_message_file", opt_stringptr, &bounce_message_file },
174 { "bounce_message_text", opt_stringptr, &bounce_message_text },
175 { "bounce_return_body", opt_bool, &bounce_return_body },
176 { "bounce_return_message", opt_bool, &bounce_return_message },
177 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
178 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
179 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
180 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
181 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
182 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
183 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
184 { "check_log_inodes", opt_int, &check_log_inodes },
185 { "check_log_space", opt_Kint, &check_log_space },
186 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
187 { "check_spool_inodes", opt_int, &check_spool_inodes },
188 { "check_spool_space", opt_Kint, &check_spool_space },
189 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
190 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
191 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
192 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
193 { "delay_warning", opt_timelist, &delay_warning },
194 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
195 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
196 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
197 { "delivery_date_remove", opt_bool, &delivery_date_remove },
198 #ifdef ENABLE_DISABLE_FSYNC
199 { "disable_fsync", opt_bool, &disable_fsync },
201 { "disable_ipv6", opt_bool, &disable_ipv6 },
202 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
203 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
204 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
205 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
206 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
207 { "dns_retrans", opt_time, &dns_retrans },
208 { "dns_retry", opt_int, &dns_retry },
209 /* This option is now a no-op, retained for compability */
210 { "drop_cr", opt_bool, &drop_cr },
211 /*********************************************************/
212 { "envelope_to_remove", opt_bool, &envelope_to_remove },
213 { "errors_copy", opt_stringptr, &errors_copy },
214 { "errors_reply_to", opt_stringptr, &errors_reply_to },
215 { "exim_group", opt_gid, &exim_gid },
216 { "exim_path", opt_stringptr, &exim_path },
217 { "exim_user", opt_uid, &exim_uid },
218 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
219 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
220 { "finduser_retries", opt_int, &finduser_retries },
221 { "freeze_tell", opt_stringptr, &freeze_tell },
222 { "gecos_name", opt_stringptr, &gecos_name },
223 { "gecos_pattern", opt_stringptr, &gecos_pattern },
225 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
226 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
227 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
229 { "header_line_maxsize", opt_int, &header_line_maxsize },
230 { "header_maxsize", opt_int, &header_maxsize },
231 { "headers_charset", opt_stringptr, &headers_charset },
232 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
233 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
234 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
235 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
236 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
237 { "hold_domains", opt_stringptr, &hold_domains },
238 { "host_lookup", opt_stringptr, &host_lookup },
239 { "host_lookup_order", opt_stringptr, &host_lookup_order },
240 { "host_reject_connection", opt_stringptr, &host_reject_connection },
241 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
242 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
244 { "ibase_servers", opt_stringptr, &ibase_servers },
246 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
247 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
248 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
249 { "keep_malformed", opt_time, &keep_malformed },
251 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
252 { "ldap_version", opt_int, &eldap_version },
254 { "local_from_check", opt_bool, &local_from_check },
255 { "local_from_prefix", opt_stringptr, &local_from_prefix },
256 { "local_from_suffix", opt_stringptr, &local_from_suffix },
257 { "local_interfaces", opt_stringptr, &local_interfaces },
258 { "local_scan_timeout", opt_time, &local_scan_timeout },
259 { "local_sender_retain", opt_bool, &local_sender_retain },
260 { "localhost_number", opt_stringptr, &host_number_string },
261 { "log_file_path", opt_stringptr, &log_file_path },
262 { "log_selector", opt_stringptr, &log_selector_string },
263 { "log_timezone", opt_bool, &log_timezone },
264 { "lookup_open_max", opt_int, &lookup_open_max },
265 { "max_username_length", opt_int, &max_username_length },
266 { "message_body_visible", opt_mkint, &message_body_visible },
267 { "message_id_header_domain", opt_stringptr, &message_id_domain },
268 { "message_id_header_text", opt_stringptr, &message_id_text },
269 { "message_logs", opt_bool, &message_logs },
270 { "message_size_limit", opt_stringptr, &message_size_limit },
271 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
272 { "move_frozen_messages", opt_bool, &move_frozen_messages },
274 { "mua_wrapper", opt_bool, &mua_wrapper },
276 { "mysql_servers", opt_stringptr, &mysql_servers },
278 { "never_users", opt_uidlist, &never_users },
280 { "oracle_servers", opt_stringptr, &oracle_servers },
282 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
284 { "perl_at_start", opt_bool, &opt_perl_at_start },
285 { "perl_startup", opt_stringptr, &opt_perl_startup },
288 { "pgsql_servers", opt_stringptr, &pgsql_servers },
290 { "pid_file_path", opt_stringptr, &pid_file_path },
291 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
292 { "preserve_message_logs", opt_bool, &preserve_message_logs },
293 { "primary_hostname", opt_stringptr, &primary_hostname },
294 { "print_topbitchars", opt_bool, &print_topbitchars },
295 { "process_log_path", opt_stringptr, &process_log_path },
296 { "prod_requires_admin", opt_bool, &prod_requires_admin },
297 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
298 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
299 { "queue_domains", opt_stringptr, &queue_domains },
300 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
301 { "queue_only", opt_bool, &queue_only },
302 { "queue_only_file", opt_stringptr, &queue_only_file },
303 { "queue_only_load", opt_fixed, &queue_only_load },
304 { "queue_only_override", opt_bool, &queue_only_override },
305 { "queue_run_in_order", opt_bool, &queue_run_in_order },
306 { "queue_run_max", opt_int, &queue_run_max },
307 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
308 { "receive_timeout", opt_time, &receive_timeout },
309 { "received_header_text", opt_stringptr, &received_header_text },
310 { "received_headers_max", opt_int, &received_headers_max },
311 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
312 { "recipients_max", opt_int, &recipients_max },
313 { "recipients_max_reject", opt_bool, &recipients_max_reject },
314 { "remote_max_parallel", opt_int, &remote_max_parallel },
315 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
316 { "retry_data_expire", opt_time, &retry_data_expire },
317 { "retry_interval_max", opt_time, &retry_interval_max },
318 { "return_path_remove", opt_bool, &return_path_remove },
319 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
320 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
321 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
322 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
323 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
324 { "smtp_accept_max", opt_int, &smtp_accept_max },
325 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
326 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
327 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
328 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
329 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
330 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
331 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
332 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
333 { "smtp_banner", opt_stringptr, &smtp_banner },
334 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
335 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
336 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
337 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
338 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
339 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
340 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
341 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
342 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
343 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
344 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
345 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
346 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
347 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
348 #ifdef WITH_CONTENT_SCAN
349 { "spamd_address", opt_stringptr, &spamd_address },
351 { "split_spool_directory", opt_bool, &split_spool_directory },
352 { "spool_directory", opt_stringptr, &spool_directory },
354 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
356 #ifdef EXPERIMENTAL_SRS
357 { "srs_config", opt_stringptr, &srs_config },
358 { "srs_hashlength", opt_int, &srs_hashlength },
359 { "srs_hashmin", opt_int, &srs_hashmin },
360 { "srs_maxage", opt_int, &srs_maxage },
361 { "srs_secrets", opt_stringptr, &srs_secrets },
362 { "srs_usehash", opt_bool, &srs_usehash },
363 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
365 { "strict_acl_vars", opt_bool, &strict_acl_vars },
366 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
367 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
368 { "syslog_duplication", opt_bool, &syslog_duplication },
369 { "syslog_facility", opt_stringptr, &syslog_facility_str },
370 { "syslog_processname", opt_stringptr, &syslog_processname },
371 { "syslog_timestamp", opt_bool, &syslog_timestamp },
372 { "system_filter", opt_stringptr, &system_filter },
373 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
374 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
375 { "system_filter_group", opt_gid, &system_filter_gid },
376 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
377 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
378 { "system_filter_user", opt_uid, &system_filter_uid },
379 { "tcp_nodelay", opt_bool, &tcp_nodelay },
380 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
381 { "timezone", opt_stringptr, &timezone_string },
383 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
384 { "tls_certificate", opt_stringptr, &tls_certificate },
385 { "tls_crl", opt_stringptr, &tls_crl },
386 { "tls_dhparam", opt_stringptr, &tls_dhparam },
387 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
388 { "tls_privatekey", opt_stringptr, &tls_privatekey },
389 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
390 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
391 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
392 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
393 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
395 { "trusted_groups", opt_gidlist, &trusted_groups },
396 { "trusted_users", opt_uidlist, &trusted_users },
397 { "unknown_login", opt_stringptr, &unknown_login },
398 { "unknown_username", opt_stringptr, &unknown_username },
399 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
400 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
401 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
402 { "warn_message_file", opt_stringptr, &warn_message_file },
403 { "write_rejectlog", opt_bool, &write_rejectlog }
406 static int optionlist_config_size =
407 sizeof(optionlist_config)/sizeof(optionlist);
411 /*************************************************
412 * Find the name of an option *
413 *************************************************/
415 /* This function is to aid debugging. Various functions take arguments that are
416 pointer variables in the options table or in option tables for various drivers.
417 For debugging output, it is useful to be able to find the name of the option
418 which is currently being processed. This function finds it, if it exists, by
419 searching the table(s).
421 Arguments: a value that is presumed to be in the table above
422 Returns: the option name, or an empty string
426 readconf_find_option(void *p)
430 transport_instance *t;
432 for (i = 0; i < optionlist_config_size; i++)
433 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
435 for (r = routers; r != NULL; r = r->next)
437 router_info *ri = r->info;
438 for (i = 0; i < ri->options_count[0]; i++)
440 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
441 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
442 return US ri->options[i].name;
446 for (t = transports; t != NULL; t = t->next)
448 transport_info *ti = t->info;
449 for (i = 0; i < ti->options_count[0]; i++)
451 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
452 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
453 return US ti->options[i].name;
463 /*************************************************
464 * Deal with an assignment to a macro *
465 *************************************************/
467 /* This function is called when a line that starts with an upper case letter is
468 encountered. The argument "line" should contain a complete logical line, and
469 start with the first letter of the macro name. The macro name and the
470 replacement text are extracted and stored. Redefinition of existing,
471 non-command line, macros is permitted using '==' instead of '='.
474 s points to the start of the logical line
480 read_macro_assignment(uschar *s)
486 macro_item *mlast = NULL;
488 while (isalnum(*s) || *s == '_')
490 if (namelen >= sizeof(name) - 1)
491 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
492 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
493 name[namelen++] = *s++;
497 while (isspace(*s)) s++;
499 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
506 while (isspace(*s)) s++;
508 /* If an existing macro of the same name was defined on the command line, we
509 just skip this definition. It's an error to attempt to redefine a macro without
510 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
511 It is also an error to define a macro whose name begins with the name of a
512 previously defined macro. Note: it is documented that the other way round
515 for (m = macros; m != NULL; m = m->next)
517 int len = Ustrlen(m->name);
519 if (Ustrcmp(m->name, name) == 0)
521 if (!m->command_line && !redef)
522 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
523 "defined (use \"==\" if you want to redefine it", name);
527 if (len < namelen && Ustrstr(name, m->name) != NULL)
528 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
529 "a macro because previously defined macro \"%s\" is a substring",
532 /* We cannot have this test, because it is documented that a substring
533 macro is permitted (there is even an example).
535 * if (len > namelen && Ustrstr(m->name, name) != NULL)
536 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
537 * "a macro because it is a substring of previously defined macro \"%s\"",
544 /* Check for an overriding command-line definition. */
546 if (m != NULL && m->command_line) return;
548 /* Redefinition must refer to an existing macro. */
553 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
557 /* We have a new definition. The macro_item structure includes a final vector
558 called "name" which is one byte long. Thus, adding "namelen" gives us enough
559 room to store the "name" string. */
563 m = store_get(sizeof(macro_item) + namelen);
564 if (macros == NULL) macros = m; else mlast->next = m;
565 Ustrncpy(m->name, name, namelen);
566 m->name[namelen] = 0;
568 m->command_line = FALSE;
571 /* Set the value of the new or redefined macro */
573 m->replacement = string_copy(s);
580 /*************************************************
581 * Read configuration line *
582 *************************************************/
584 /* A logical line of text is read from the configuration file into the big
585 buffer, taking account of macros, .includes, and continuations. The size of
586 big_buffer is increased if necessary. The count of configuration lines is
587 maintained. Physical input lines starting with # (ignoring leading white space,
588 and after macro replacement) and empty logical lines are always ignored.
589 Leading and trailing spaces are removed.
591 If we hit a line of the form "begin xxxx", the xxxx is placed in the
592 next_section vector, and the function returns NULL, indicating the end of a
593 configuration section. On end-of-file, NULL is returned with next_section
598 Returns: a pointer to the first non-blank in the line,
599 or NULL if eof or end of section is reached
603 get_config_line(void)
605 int startoffset = 0; /* To first non-blank char in logical line */
606 int len = 0; /* Of logical line so far */
612 /* Loop for handling continuation lines, skipping comments, and dealing with
617 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
619 if (config_file_stack != NULL) /* EOF inside .include */
621 (void)fclose(config_file);
622 config_file = config_file_stack->file;
623 config_filename = config_file_stack->filename;
624 config_lineno = config_file_stack->lineno;
625 config_file_stack = config_file_stack->next;
629 /* EOF at top level */
631 if (cstate_stack_ptr >= 0)
632 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
633 "Unexpected end of configuration file: .endif missing");
635 if (len != 0) break; /* EOF after continuation */
636 next_section[0] = 0; /* EOF at start of logical line */
641 newlen = len + Ustrlen(big_buffer + len);
643 /* Handle pathologically long physical lines - yes, it did happen - by
644 extending big_buffer at this point. The code also copes with very long
647 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
650 big_buffer_size += BIG_BUFFER_SIZE;
651 newbuffer = store_malloc(big_buffer_size);
653 /* This use of strcpy is OK because we know that the string in the old
654 buffer is shorter than the new buffer. */
656 Ustrcpy(newbuffer, big_buffer);
657 store_free(big_buffer);
658 big_buffer = newbuffer;
659 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
661 newlen += Ustrlen(big_buffer + newlen);
664 /* Find the true start of the physical line - leading spaces are always
667 ss = big_buffer + len;
668 while (isspace(*ss)) ss++;
670 /* Process the physical line for macros. If this is the start of the logical
671 line, skip over initial text at the start of the line if it starts with an
672 upper case character followed by a sequence of name characters and an equals
673 sign, because that is the definition of a new macro, and we don't do
674 replacement therein. */
677 if (len == 0 && isupper(*s))
679 while (isalnum(*s) || *s == '_') s++;
680 while (isspace(*s)) s++;
681 if (*s != '=') s = ss; /* Not a macro definition */
684 /* For each defined macro, scan the line (from after XXX= if present),
685 replacing all occurrences of the macro. */
688 for (m = macros; m != NULL; m = m->next)
693 while ((p = Ustrstr(t, m->name)) != NULL)
696 int namelen = Ustrlen(m->name);
697 int replen = Ustrlen(m->replacement);
699 /* Expand the buffer if necessary */
701 while (newlen - namelen + replen + 1 > big_buffer_size)
703 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
704 uschar *newbuffer = store_malloc(newsize);
705 memcpy(newbuffer, big_buffer, newlen + 1);
706 p = newbuffer + (p - big_buffer);
707 s = newbuffer + (s - big_buffer);
708 ss = newbuffer + (ss - big_buffer);
709 t = newbuffer + (t - big_buffer);
710 big_buffer_size = newsize;
711 store_free(big_buffer);
712 big_buffer = newbuffer;
715 /* Shuffle the remaining characters up or down in the buffer before
716 copying in the replacement text. Don't rescan the replacement for this
720 moveby = replen - namelen;
723 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
726 Ustrncpy(p, m->replacement, replen);
732 /* An empty macro replacement at the start of a line could mean that ss no
733 longer points to the first non-blank character. */
735 while (isspace(*ss)) ss++;
737 /* Check for comment lines - these are physical lines. */
739 if (*ss == '#') continue;
741 /* Handle conditionals, which are also applied to physical lines. Conditions
742 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
743 expansion occured on the rest of the line. A preliminary test for the leading
744 '.' saves effort on most lines. */
750 /* Search the list of conditional directives */
752 for (i = 0; i < cond_list_size; i++)
755 cond_item *c = cond_list+i;
756 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
758 /* The following character must be white space or end of string */
760 n = ss[1 + c->namelen];
761 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
763 /* .ifdef and .ifndef push the current state onto the stack, then set
764 a new one from the table. Stack overflow is an error */
768 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
769 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
770 ".%s nested too deeply", c->name);
771 cstate_stack[++cstate_stack_ptr] = cstate;
772 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
775 /* For any of the others, stack underflow is an error. The next state
776 comes either from the stack (.endif) or from the table. */
780 if (cstate_stack_ptr < 0)
781 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
782 ".%s without matching .ifdef", c->name);
783 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
784 next_cstate[cstate][macro_found? c->action1 : c->action2];
787 /* Having dealt with a directive, break the loop */
792 /* If we have handled a conditional directive, continue with the next
793 physical line. Otherwise, fall through. */
795 if (i < cond_list_size) continue;
798 /* If the conditional state is not 0 (actively using these lines), ignore
801 if (cstate != 0) continue; /* Conditional skip */
803 /* Handle .include lines - these are also physical lines. */
805 if (Ustrncmp(ss, ".include", 8) == 0 &&
807 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
810 int include_if_exists = isspace(ss[8])? 0 : 10;
811 config_file_item *save;
814 ss += 9 + include_if_exists;
815 while (isspace(*ss)) ss++;
816 t = ss + Ustrlen(ss);
817 while (t > ss && isspace(t[-1])) t--;
818 if (*ss == '\"' && t[-1] == '\"')
826 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
827 "absolute path \"%s\"", ss);
829 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
831 save = store_get(sizeof(config_file_item));
832 save->next = config_file_stack;
833 config_file_stack = save;
834 save->file = config_file;
835 save->filename = config_filename;
836 save->lineno = config_lineno;
838 config_file = Ufopen(ss, "rb");
839 if (config_file == NULL)
840 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
841 "configuration file %s", ss);
842 config_filename = string_copy(ss);
847 /* If this is the start of the logical line, remember where the non-blank
848 data starts. Otherwise shuffle down continuation lines to remove leading
852 startoffset = ss - big_buffer;
855 s = big_buffer + len;
858 memmove(s, ss, (newlen - len) - (ss - s) + 1);
863 /* Accept the new addition to the line. Remove trailing white space. */
866 while (len > 0 && isspace(big_buffer[len-1])) len--;
869 /* We are done if the line does not end in backslash and contains some data.
870 Empty logical lines are ignored. For continuations, remove the backslash and
871 go round the loop to read the continuation line. */
875 if (big_buffer[len-1] != '\\') break; /* End of logical line */
876 big_buffer[--len] = 0; /* Remove backslash */
878 } /* Loop for reading multiple physical lines */
880 /* We now have a logical line. Test for the end of a configuration section (or,
881 more accurately, for the start of the next section). Place the name of the next
882 section in next_section, and return NULL. If the name given is longer than
883 next_section, truncate it. It will be unrecognized later, because all the known
884 section names do fit. Leave space for pluralizing. */
886 s = big_buffer + startoffset; /* First non-space character */
887 if (strncmpic(s, US"begin ", 6) == 0)
890 while (isspace(*s)) s++;
891 if (big_buffer + len - s > sizeof(next_section) - 2)
892 s[sizeof(next_section) - 2] = 0;
893 Ustrcpy(next_section, s);
897 /* Return the first non-blank character. */
904 /*************************************************
906 *************************************************/
908 /* The yield is the pointer to the next uschar. Names longer than the
909 output space are silently truncated. This function is also used from acl.c when
913 name where to put the name
917 Returns: new input pointer
921 readconf_readname(uschar *name, int len, uschar *s)
924 while (isspace(*s)) s++;
927 while (isalnum(*s) || *s == '_')
929 if (p < len-1) name[p++] = *s;
934 while (isspace(*s)) s++;
941 /*************************************************
942 * Read a time value *
943 *************************************************/
945 /* This function is also called from outside, to read argument
946 time values. The format of a time value is:
948 [<n>w][<n>d][<n>h][<n>m][<n>s]
950 as long as at least one is present. If a format error is encountered,
951 return a negative value. The value must be terminated by the given
956 terminator required terminating character
957 return_msec if TRUE, allow fractional seconds and return milliseconds
959 Returns: the time value, or -1 on syntax error
960 value is seconds if return_msec is FALSE
961 value is milliseconds if return_msec is TRUE
965 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
973 if (!isdigit(*s)) return -1;
974 (void)sscanf(CS s, "%d%n", &value, &count);
979 case 'w': value *= 7;
980 case 'd': value *= 24;
981 case 'h': value *= 60;
982 case 'm': value *= 60;
987 if (!return_msec) return -1;
988 (void)sscanf(CS s, "%lf%n", &fraction, &count);
990 if (*s++ != 's') return -1;
991 yield += (int)(fraction * 1000.0);
997 if (return_msec) value *= 1000;
999 if (*s == terminator) return yield;
1001 /* Control never reaches here. */
1006 /*************************************************
1007 * Read a fixed point value *
1008 *************************************************/
1010 /* The value is returned *1000
1014 terminator required terminator
1016 Returns: the value, or -1 on error
1020 readconf_readfixed(uschar *s, int terminator)
1024 if (!isdigit(*s)) return -1;
1025 (void)sscanf(CS s, "%d%n", &value, &count);
1027 yield = value * 1000;
1031 while (isdigit((*(++s))))
1033 yield += (*s - '0') * m;
1038 return (*s == terminator)? yield : (-1);
1043 /*************************************************
1044 * Find option in list *
1045 *************************************************/
1047 /* The lists are always in order, so binary chop can be used.
1050 name the option name to search for
1051 ol the first entry in the option list
1052 last one more than the offset of the last entry in the option list
1054 Returns: pointer to an option entry, or NULL if not found
1058 find_option(uschar *name, optionlist *ol, int last)
1061 while (last > first)
1063 int middle = (first + last)/2;
1064 int c = Ustrcmp(name, ol[middle].name);
1065 if (c == 0) return ol + middle;
1066 else if (c > 0) first = middle + 1;
1074 /*************************************************
1075 * Find a set flag in option list *
1076 *************************************************/
1078 /* Because some versions of Unix make no restrictions on the values of uids and
1079 gids (even negative ones), we cannot represent "unset" by a special value.
1080 There is therefore a separate boolean variable for each one indicating whether
1081 a value is set or not. This function returns a pointer to the boolean, given
1082 the original option name. It is a major disaster if the flag cannot be found.
1085 name the name of the uid or gid option
1086 oltop points to the start of the relevant option list
1087 last one more than the offset of the last item in the option list
1088 data_block NULL when reading main options => data values in the option
1089 list are absolute addresses; otherwise they are byte offsets
1090 in data_block (used for driver options)
1092 Returns: a pointer to the boolean flag.
1096 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1100 sprintf(CS name2, "*set_%.50s", name);
1101 ol = find_option(name2, oltop, last);
1102 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1103 "Exim internal error: missing set flag for %s", name);
1104 return (data_block == NULL)? (BOOL *)(ol->value) :
1105 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1111 /*************************************************
1112 * Output extra characters message and die *
1113 *************************************************/
1115 /* Called when an option line has junk on the end. Sometimes this is because
1116 the sysadmin thinks comments are permitted.
1119 s points to the extra characters
1120 t1..t3 strings to insert in the log message
1122 Returns: doesn't return; dies
1126 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1128 uschar *comment = US"";
1129 if (*s == '#') comment = US" (# is comment only at line start)";
1130 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1131 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1136 /*************************************************
1137 * Read rewrite information *
1138 *************************************************/
1140 /* Each line of rewrite information contains:
1142 . A complete address in the form user@domain, possibly with
1143 leading * for each part; or alternatively, a regex.
1145 . A replacement string (which will be expanded).
1147 . An optional sequence of one-letter flags, indicating which
1148 headers etc. to apply this rule to.
1150 All this is decoded and placed into a control block. The OR of the flags is
1151 maintained in a common word.
1154 p points to the string that makes up the rule
1155 existflags points to the overall flag word
1156 isglobal TRUE if reading global rewrite rules
1158 Returns: the control block for the parsed rule.
1161 static rewrite_rule *
1162 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1164 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1167 next->key = string_dequote(&p);
1169 while (isspace(*p)) p++;
1171 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1172 "missing rewrite replacement string");
1175 next->replacement = string_dequote(&p);
1177 while (*p != 0) switch (*p++)
1179 case ' ': case '\t': break;
1181 case 'q': next->flags |= rewrite_quit; break;
1182 case 'w': next->flags |= rewrite_whole; break;
1184 case 'h': next->flags |= rewrite_all_headers; break;
1185 case 's': next->flags |= rewrite_sender; break;
1186 case 'f': next->flags |= rewrite_from; break;
1187 case 't': next->flags |= rewrite_to; break;
1188 case 'c': next->flags |= rewrite_cc; break;
1189 case 'b': next->flags |= rewrite_bcc; break;
1190 case 'r': next->flags |= rewrite_replyto; break;
1192 case 'E': next->flags |= rewrite_all_envelope; break;
1193 case 'F': next->flags |= rewrite_envfrom; break;
1194 case 'T': next->flags |= rewrite_envto; break;
1196 case 'Q': next->flags |= rewrite_qualify; break;
1197 case 'R': next->flags |= rewrite_repeat; break;
1200 next->flags |= rewrite_smtp;
1201 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1202 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1203 "rewrite rule has the S flag but is not a regular expression");
1207 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1208 "unknown rewrite flag character '%c' "
1209 "(could be missing quotes round replacement item)", p[-1]);
1213 /* If no action flags are set, set all the "normal" rewrites. */
1215 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1216 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1218 /* Remember which exist, for optimization, and return the rule */
1220 *existflags |= next->flags;
1227 /*************************************************
1228 * Read global rewrite information *
1229 *************************************************/
1231 /* Each line is a single rewrite rule; it is parsed into a control block
1232 by readconf_one_rewrite(), and its flags are ORed into the global flag
1233 word rewrite_existflags. */
1236 readconf_rewrites(void)
1238 rewrite_rule **chain = &global_rewrite_rules;
1241 while ((p = get_config_line()) != NULL)
1243 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1245 chain = &(next->next);
1251 /*************************************************
1253 *************************************************/
1255 /* Strings are read into the normal store pool. As long we aren't too
1256 near the end of the current block, the string will just use what is necessary
1257 on the top of the stacking pool, because string_cat() uses the extension
1261 s the rest of the input line
1262 name the option name (for errors)
1264 Returns: pointer to the string
1268 read_string(uschar *s, uschar *name)
1273 if (*s != '\"') return string_copy(s);
1276 yield = string_dequote(&s);
1278 if (s == ss+1 || s[-1] != '\"')
1279 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1280 "missing quote at end of string value for %s", name);
1282 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1288 /*************************************************
1289 * Handle option line *
1290 *************************************************/
1292 /* This function is called from several places to process a line containing the
1293 setting of an option. The first argument is the line to be decoded; it has been
1294 checked not to be empty and not to start with '#'. Trailing newlines and white
1295 space have been removed. The second argument is a pointer to the list of
1296 variable names that are to be recognized, together with their types and
1297 locations, and the third argument gives the number of entries in the list.
1299 The fourth argument is a pointer to a data block. If it is NULL, then the data
1300 values in the options list are absolute addresses. Otherwise, they are byte
1301 offsets in the data block.
1303 String option data may continue onto several lines; this function reads further
1304 data from config_file if necessary.
1306 The yield of this function is normally zero. If a string continues onto
1307 multiple lines, then the data value is permitted to be followed by a comma
1308 or a semicolon (for use in drivers) and the yield is that character.
1311 buffer contains the configuration line to be handled
1312 oltop points to the start of the relevant option list
1313 last one more than the offset of the last item in the option list
1314 data_block NULL when reading main options => data values in the option
1315 list are absolute addresses; otherwise they are byte offsets
1316 in data_block when they have opt_public set; otherwise
1317 they are byte offsets in data_block->options_block.
1318 unknown_txt format string to use in panic message for unknown option;
1319 must contain %s for option name
1320 if given as NULL, don't panic on unknown option
1322 Returns: TRUE if an option was read successfully,
1323 FALSE false for an unknown option if unknown_txt == NULL,
1324 otherwise panic and die on an unknown option
1328 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1329 void *data_block, uschar *unknown_txt)
1333 int n, count, type, value;
1337 BOOL boolvalue = TRUE;
1338 BOOL freesptr = TRUE;
1339 optionlist *ol, *ol2;
1343 uschar *inttype = US"";
1349 /* There may be leading spaces; thereafter, we expect an option name starting
1352 while (isspace(*s)) s++;
1354 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1356 /* Read the name of the option, and skip any subsequent white space. If
1357 it turns out that what we read was "hide", set the flag indicating that
1358 this is a secure option, and loop to read the next word. */
1360 for (n = 0; n < 2; n++)
1362 while (isalnum(*s) || *s == '_')
1364 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1368 while (isspace(*s)) s++;
1369 if (Ustrcmp(name, "hide") != 0) break;
1370 issecure = opt_secure;
1374 /* Deal with "no_" or "not_" here for booleans */
1376 if (Ustrncmp(name, "no_", 3) == 0)
1382 if (Ustrncmp(name, "not_", 4) == 0)
1388 /* Search the list for the given name. A non-existent name, or an option that
1389 is set twice, is a disaster. */
1391 ol = find_option(name + offset, oltop, last);
1395 if (unknown_txt == NULL) return FALSE;
1396 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1399 if ((ol->type & opt_set) != 0)
1401 uschar *mname = name;
1402 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1403 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1404 "\"%s\" option set for the second time", mname);
1407 ol->type |= opt_set | issecure;
1408 type = ol->type & opt_mask;
1410 /* Types with data values must be followed by '='; the "no[t]_" prefix
1411 applies only to boolean values. */
1413 if (type < opt_bool || type > opt_bool_last)
1416 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1417 "negation prefix applied to a non-boolean option");
1419 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1420 "unexpected end of line (data missing) after %s", name);
1422 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1425 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1426 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1427 ultimately expands to one of those values. */
1429 else if (*s != 0 && (offset != 0 || *s != '='))
1430 extra_chars_error(s, US"boolean option ", name, US"");
1432 /* Skip white space after = */
1434 if (*s == '=') while (isspace((*(++s))));
1436 /* If there is a data block and the opt_public flag is not set, change
1437 the data block pointer to the private options block. */
1439 if (data_block != NULL && (ol->type & opt_public) == 0)
1440 data_block = (void *)(((driver_instance *)data_block)->options_block);
1442 /* Now get the data according to the type. */
1446 /* If a string value is not enclosed in quotes, it consists of
1447 the rest of the current line, verbatim. Otherwise, string escapes
1450 A transport is specified as a string, which is then looked up in the
1451 list of transports. A search type is specified as one of a number of
1454 A set or rewrite rules for a driver is specified as a string, which is
1455 then parsed into a suitable chain of control blocks.
1457 Uids and gids are specified as strings which are then looked up in the
1458 passwd file. Lists of uids and gids are similarly specified as colon-
1459 separated strings. */
1464 case opt_expand_uid:
1465 case opt_expand_gid:
1470 reset_point = sptr = read_string(s, name);
1472 /* Having read a string, we now have several different ways of using it,
1473 depending on the data type, so do another switch. If keeping the actual
1474 string is not required (because it is interpreted), freesptr is set TRUE,
1475 and at the end we reset the pool. */
1479 /* If this was a string, set the variable to point to the new string,
1480 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1481 rules, we still keep the string (for printing), and parse the rules into a
1482 control block and flags word. */
1486 if (data_block == NULL)
1487 *((uschar **)(ol->value)) = sptr;
1489 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1491 if (type == opt_rewrite)
1496 rewrite_rule **chain;
1499 sprintf(CS name2, "*%.50s_rules", name);
1500 ol2 = find_option(name2, oltop, last);
1501 sprintf(CS name2, "*%.50s_flags", name);
1502 ol3 = find_option(name2, oltop, last);
1504 if (ol2 == NULL || ol3 == NULL)
1505 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1506 "rewrite rules not available for driver");
1508 if (data_block == NULL)
1510 chain = (rewrite_rule **)(ol2->value);
1511 flagptr = (int *)(ol3->value);
1515 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1516 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1519 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1522 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1524 chain = &(next->next);
1527 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1528 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1529 "non-header rewrite - not allowed at transport time -");
1533 /* If it was an expanded uid, see if there is any expansion to be
1534 done by checking for the presence of a $ character. If there is, save it
1535 in the corresponding *expand_user option field. Otherwise, fall through
1536 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1539 case opt_expand_uid:
1540 sprintf(CS name2, "*expand_%.50s", name);
1541 ol2 = find_option(name2, oltop, last);
1544 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1546 if (data_block == NULL)
1547 *((uschar **)(ol2->value)) = ss;
1549 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1553 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1559 /* Look up a fixed uid, and also make use of the corresponding gid
1560 if a passwd entry is returned and the gid has not been set. */
1563 if (!route_finduser(sptr, &pw, &uid))
1564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1565 if (data_block == NULL)
1566 *((uid_t *)(ol->value)) = uid;
1568 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1570 /* Set the flag indicating a fixed value is set */
1572 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1574 /* Handle matching gid if we have a passwd entry: done by finding the
1575 same name with terminating "user" changed to "group"; if not found,
1576 ignore. Also ignore if the value is already set. */
1578 if (pw == NULL) break;
1579 Ustrcpy(name+Ustrlen(name)-4, "group");
1580 ol2 = find_option(name, oltop, last);
1581 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1582 (ol2->type & opt_mask) == opt_expand_gid))
1584 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1587 if (data_block == NULL)
1588 *((gid_t *)(ol2->value)) = pw->pw_gid;
1590 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1596 /* If it was an expanded gid, see if there is any expansion to be
1597 done by checking for the presence of a $ character. If there is, save it
1598 in the corresponding *expand_user option field. Otherwise, fall through
1599 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1602 case opt_expand_gid:
1603 sprintf(CS name2, "*expand_%.50s", name);
1604 ol2 = find_option(name2, oltop, last);
1607 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1609 if (data_block == NULL)
1610 *((uschar **)(ol2->value)) = ss;
1612 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1616 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1622 /* Handle freestanding gid */
1625 if (!route_findgroup(sptr, &gid))
1626 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1627 if (data_block == NULL)
1628 *((gid_t *)(ol->value)) = gid;
1630 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1631 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1634 /* If it was a uid list, look up each individual entry, and build
1635 a vector of uids, with a count in the first element. Put the vector
1636 in malloc store so we can free the string. (We are reading into
1637 permanent store already.) */
1645 uschar *op = expand_string (sptr);
1648 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1649 name, expand_string_message);
1652 if (*p != 0) count++;
1653 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1654 list = store_malloc(count*sizeof(uid_t));
1655 list[ptr++] = (uid_t)(count - 1);
1657 if (data_block == NULL)
1658 *((uid_t **)(ol->value)) = list;
1660 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1666 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1667 if (!route_finduser(big_buffer, NULL, &uid))
1668 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1675 /* If it was a gid list, look up each individual entry, and build
1676 a vector of gids, with a count in the first element. Put the vector
1677 in malloc store so we can free the string. (We are reading into permanent
1686 uschar *op = expand_string (sptr);
1689 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1690 name, expand_string_message);
1693 if (*p != 0) count++;
1694 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1695 list = store_malloc(count*sizeof(gid_t));
1696 list[ptr++] = (gid_t)(count - 1);
1698 if (data_block == NULL)
1699 *((gid_t **)(ol->value)) = list;
1701 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1707 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1708 if (!route_findgroup(big_buffer, &gid))
1709 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1717 /* Release store if the value of the string doesn't need to be kept. */
1719 if (freesptr) store_reset(reset_point);
1722 /* Expanded boolean: if no characters follow, or if there are no dollar
1723 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1724 save the string for later expansion in the alternate place. */
1726 case opt_expand_bool:
1727 if (*s != 0 && Ustrchr(s, '$') != 0)
1729 sprintf(CS name2, "*expand_%.50s", name);
1730 ol2 = find_option(name2, oltop, last);
1733 reset_point = sptr = read_string(s, name);
1734 if (data_block == NULL)
1735 *((uschar **)(ol2->value)) = sptr;
1737 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1744 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1745 look for yes/not/true/false. Some booleans are stored in a single bit in
1746 a single int. There's a special fudge for verify settings; without a suffix
1747 they set both xx_sender and xx_recipient. The table points to the sender
1748 value; search subsequently for the recipient. There's another special case:
1749 opt_bool_set also notes when a boolean has been set. */
1753 case opt_bool_verify:
1757 s = readconf_readname(name2, 64, s);
1758 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1760 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1762 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1763 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1764 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1765 US"for boolean option ", name);
1768 /* Handle single-bit type. */
1770 if (type == opt_bit)
1772 int bit = 1 << ((ol->type >> 16) & 31);
1773 int *ptr = (data_block == NULL)?
1774 (int *)(ol->value) :
1775 (int *)((uschar *)data_block + (long int)ol->value);
1776 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1780 /* Handle full BOOL types */
1782 if (data_block == NULL)
1783 *((BOOL *)(ol->value)) = boolvalue;
1785 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1789 if (type == opt_bool_verify)
1791 sprintf(CS name2, "%.50s_recipient", name + offset);
1792 ol2 = find_option(name2, oltop, last);
1795 if (data_block == NULL)
1796 *((BOOL *)(ol2->value)) = boolvalue;
1798 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1802 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1804 else if (type == opt_bool_set)
1806 sprintf(CS name2, "*set_%.50s", name + offset);
1807 ol2 = find_option(name2, oltop, last);
1810 if (data_block == NULL)
1811 *((BOOL *)(ol2->value)) = TRUE;
1813 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1822 inttype = US"octal ";
1824 /* Integer: a simple(ish) case; allow octal and hex formats, and
1825 suffixes K and M. The different types affect output, not input. */
1832 value = strtol(CS s, CSS &endptr, intbase);
1835 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1838 if (errno != ERANGE)
1840 if (tolower(*endptr) == 'k')
1842 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1846 else if (tolower(*endptr) == 'm')
1848 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1850 else value *= 1024*1024;
1855 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1856 "absolute value of integer \"%s\" is too large (overflow)", s);
1858 while (isspace(*endptr)) endptr++;
1860 extra_chars_error(endptr, inttype, US"integer value for ", name);
1863 if (data_block == NULL)
1864 *((int *)(ol->value)) = value;
1866 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1869 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1876 value = strtol(CS s, CSS &endptr, intbase);
1879 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1882 if (errno != ERANGE)
1884 if (tolower(*endptr) == 'm')
1886 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1890 else if (tolower(*endptr) == 'k')
1896 value = (value + 512)/1024;
1900 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1901 "absolute value of integer \"%s\" is too large (overflow)", s);
1903 while (isspace(*endptr)) endptr++;
1905 extra_chars_error(endptr, inttype, US"integer value for ", name);
1908 if (data_block == NULL)
1909 *((int *)(ol->value)) = value;
1911 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1914 /* Fixed-point number: held to 3 decimal places. */
1917 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1918 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1919 "fixed-point number expected for %s", name);
1921 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1922 "integer \"%s\" is too large (overflow)", s);
1926 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1927 "integer \"%s\" is too large (overflow)", s);
1929 if (s[count] == '.')
1932 while (isdigit(s[++count]))
1934 value += (s[count] - '0') * d;
1939 while (isspace(s[count])) count++;
1942 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1944 if (data_block == NULL)
1945 *((int *)(ol->value)) = value;
1947 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1950 /* There's a special routine to read time values. */
1953 value = readconf_readtime(s, 0, FALSE);
1955 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1957 if (data_block == NULL)
1958 *((int *)(ol->value)) = value;
1960 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1963 /* A time list is a list of colon-separated times, with the first
1964 element holding the size of the list and the second the number of
1970 int *list = (data_block == NULL)?
1971 (int *)(ol->value) :
1972 (int *)((uschar *)data_block + (long int)(ol->value));
1974 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1977 uschar *snext = Ustrchr(s, ':');
1981 while (ss > s && isspace(ss[-1])) ss--;
1984 value = readconf_readtime(s, terminator, FALSE);
1986 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1988 if (count > 1 && value <= list[count])
1989 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1990 "time value out of order for %s", name);
1991 list[count+1] = value;
1992 if (snext == NULL) break;
1994 while (isspace(*s)) s++;
1997 if (count > list[0] - 2)
1998 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2000 if (count > 0 && list[2] == 0) count = 0;
2012 /*************************************************
2013 * Print a time value *
2014 *************************************************/
2017 Argument: a time value in seconds
2018 Returns: pointer to a fixed buffer containing the time as a string,
2019 in readconf_readtime() format
2023 readconf_printtime(int t)
2026 uschar *p = time_buffer;
2043 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2044 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2045 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2046 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2047 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2054 /*************************************************
2055 * Print an individual option value *
2056 *************************************************/
2058 /* This is used by the -bP option, so prints to the standard output.
2059 The entire options list is passed in as an argument, because some options come
2060 in pairs - typically uid/gid settings, which can either be explicit numerical
2061 values, or strings to be expanded later. If the numerical value is unset,
2062 search for "*expand_<name>" to see if there is a string equivalent.
2065 ol option entry, or NULL for an unknown option
2067 options_block NULL for main configuration options; otherwise points to
2068 a driver block; if the option doesn't have opt_public
2069 set, then options_block->options_block is where the item
2071 oltop points to the option list in which ol exists
2072 last one more than the offset of the last entry in optop
2078 print_ol(optionlist *ol, uschar *name, void *options_block,
2079 optionlist *oltop, int last)
2092 printf("%s is not a known option\n", name);
2096 /* Non-admin callers cannot see options that have been flagged secure by the
2099 if (!admin_user && (ol->type & opt_secure) != 0)
2101 printf("%s = <value not displayable>\n", name);
2105 /* Else show the value of the option */
2108 if (options_block != NULL)
2110 if ((ol->type & opt_public) == 0)
2111 options_block = (void *)(((driver_instance *)options_block)->options_block);
2112 value = (void *)((uschar *)options_block + (long int)value);
2115 switch(ol->type & opt_mask)
2118 case opt_rewrite: /* Show the text value */
2119 s = *((uschar **)value);
2120 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2124 printf("%s = %d\n", name, *((int *)value));
2129 int x = *((int *)value);
2130 if (x != 0 && (x & 1023) == 0)
2134 if ((x & 1023) == 0)
2139 printf("%s = %d%c\n", name, x, c);
2141 else printf("%s = %d\n", name, x);
2147 int x = *((int *)value);
2148 if (x == 0) printf("%s = 0\n", name);
2149 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2150 else printf("%s = %dK\n", name, x);
2155 printf("%s = %#o\n", name, *((int *)value));
2158 /* Can be negative only when "unset", in which case integer */
2162 int x = *((int *)value);
2165 if (x < 0) printf("%s =\n", name); else
2167 printf("%s = %d.", name, x/1000);
2180 /* If the numerical value is unset, try for the string value */
2182 case opt_expand_uid:
2183 if (! *get_set_flag(name, oltop, last, options_block))
2185 sprintf(CS name2, "*expand_%.50s", name);
2186 ol2 = find_option(name2, oltop, last);
2189 void *value2 = ol2->value;
2190 if (options_block != NULL)
2191 value2 = (void *)((uschar *)options_block + (long int)value2);
2192 s = *((uschar **)value2);
2193 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2198 /* Else fall through */
2201 if (! *get_set_flag(name, oltop, last, options_block))
2202 printf("%s =\n", name);
2205 pw = getpwuid(*((uid_t *)value));
2207 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2208 else printf("%s = %s\n", name, pw->pw_name);
2212 /* If the numerical value is unset, try for the string value */
2214 case opt_expand_gid:
2215 if (! *get_set_flag(name, oltop, last, options_block))
2217 sprintf(CS name2, "*expand_%.50s", name);
2218 ol2 = find_option(name2, oltop, last);
2219 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2221 void *value2 = ol2->value;
2222 if (options_block != NULL)
2223 value2 = (void *)((uschar *)options_block + (long int)value2);
2224 s = *((uschar **)value2);
2225 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2230 /* Else fall through */
2233 if (! *get_set_flag(name, oltop, last, options_block))
2234 printf("%s =\n", name);
2237 gr = getgrgid(*((int *)value));
2239 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2240 else printf("%s = %s\n", name, gr->gr_name);
2245 uidlist = *((uid_t **)value);
2246 printf("%s =", name);
2247 if (uidlist != NULL)
2251 for (i = 1; i <= (int)(uidlist[0]); i++)
2253 uschar *name = NULL;
2254 pw = getpwuid(uidlist[i]);
2255 if (pw != NULL) name = US pw->pw_name;
2256 if (name != NULL) printf("%c%s", sep, name);
2257 else printf("%c%ld", sep, (long int)(uidlist[i]));
2265 gidlist = *((gid_t **)value);
2266 printf("%s =", name);
2267 if (gidlist != NULL)
2271 for (i = 1; i <= (int)(gidlist[0]); i++)
2273 uschar *name = NULL;
2274 gr = getgrgid(gidlist[i]);
2275 if (gr != NULL) name = US gr->gr_name;
2276 if (name != NULL) printf("%c%s", sep, name);
2277 else printf("%c%ld", sep, (long int)(gidlist[i]));
2285 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2291 int *list = (int *)value;
2292 printf("%s = ", name);
2293 for (i = 0; i < list[1]; i++)
2294 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2300 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2304 case opt_expand_bool:
2305 sprintf(CS name2, "*expand_%.50s", name);
2306 ol2 = find_option(name2, oltop, last);
2307 if (ol2 != NULL && ol2->value != NULL)
2309 void *value2 = ol2->value;
2310 if (options_block != NULL)
2311 value2 = (void *)((uschar *)options_block + (long int)value2);
2312 s = *((uschar **)value2);
2315 printf("%s = %s\n", name, string_printing(s));
2318 /* s == NULL => string not set; fall through */
2324 case opt_bool_verify:
2326 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2333 /*************************************************
2334 * Print value from main configuration *
2335 *************************************************/
2337 /* This function, called as a result of encountering the -bP option,
2338 causes the value of any main configuration variable to be output if the
2339 second argument is NULL. There are some special values:
2341 all print all main configuration options
2342 configure_file print the name of the configuration file
2343 routers print the routers' configurations
2344 transports print the transports' configuration
2345 authenticators print the authenticators' configuration
2346 router_list print a list of router names
2347 transport_list print a list of transport names
2348 authenticator_list print a list of authentication mechanism names
2349 +name print a named list item
2350 local_scan print the local_scan options
2352 If the second argument is not NULL, it must be one of "router", "transport", or
2353 "authenticator" in which case the first argument identifies the driver whose
2354 options are to be printed.
2357 name option name if type == NULL; else driver name
2358 type NULL or driver type name, as described above
2364 readconf_print(uschar *name, uschar *type)
2366 BOOL names_only = FALSE;
2368 optionlist *ol2 = NULL;
2369 driver_instance *d = NULL;
2379 static uschar *types[] = { US"address", US"domain", US"host",
2381 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2382 &hostlist_anchor, &localpartlist_anchor };
2384 for (i = 0; i < 4; i++)
2386 t = tree_search(*(anchors[i]), name+1);
2390 printf("%slist %s = %s\n", types[i], name+1,
2391 ((namedlist_block *)(t->data.ptr))->string);
2396 printf("no address, domain, host, or local part list called \"%s\" "
2397 "exists\n", name+1);
2402 if (Ustrcmp(name, "configure_file") == 0)
2404 printf("%s\n", CS config_main_filename);
2408 if (Ustrcmp(name, "all") == 0)
2410 for (ol = optionlist_config;
2411 ol < optionlist_config + optionlist_config_size; ol++)
2413 if ((ol->type & opt_hidden) == 0)
2414 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2419 if (Ustrcmp(name, "local_scan") == 0)
2421 #ifndef LOCAL_SCAN_HAS_OPTIONS
2422 printf("local_scan() options are not supported\n");
2424 for (ol = local_scan_options;
2425 ol < local_scan_options + local_scan_options_count; ol++)
2427 print_ol(ol, US ol->name, NULL, local_scan_options,
2428 local_scan_options_count);
2434 if (Ustrcmp(name, "routers") == 0)
2439 else if (Ustrcmp(name, "transports") == 0)
2441 type = US"transport";
2445 else if (Ustrcmp(name, "authenticators") == 0)
2447 type = US"authenticator";
2451 else if (Ustrcmp(name, "authenticator_list") == 0)
2453 type = US"authenticator";
2458 else if (Ustrcmp(name, "router_list") == 0)
2464 else if (Ustrcmp(name, "transport_list") == 0)
2466 type = US"transport";
2472 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2473 name, NULL, optionlist_config, optionlist_config_size);
2478 /* Handle the options for a router or transport. Skip options that are flagged
2479 as hidden. Some of these are options with names starting with '*', used for
2480 internal alternative representations of other options (which the printing
2481 function will sort out). Others are synonyms kept for backward compatibility.
2484 if (Ustrcmp(type, "router") == 0)
2486 d = (driver_instance *)routers;
2487 ol2 = optionlist_routers;
2488 size = optionlist_routers_size;
2490 else if (Ustrcmp(type, "transport") == 0)
2492 d = (driver_instance *)transports;
2493 ol2 = optionlist_transports;
2494 size = optionlist_transports_size;
2496 else if (Ustrcmp(type, "authenticator") == 0)
2498 d = (driver_instance *)auths;
2499 ol2 = optionlist_auths;
2500 size = optionlist_auths_size;
2505 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2509 /* Either search for a given driver, or print all of them */
2511 for (; d != NULL; d = d->next)
2514 printf("\n%s %s:\n", d->name, type);
2515 else if (Ustrcmp(d->name, name) != 0) continue;
2517 for (ol = ol2; ol < ol2 + size; ol++)
2519 if ((ol->type & opt_hidden) == 0)
2520 print_ol(ol, US ol->name, d, ol2, size);
2523 for (ol = d->info->options;
2524 ol < d->info->options + *(d->info->options_count); ol++)
2526 if ((ol->type & opt_hidden) == 0)
2527 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2529 if (name != NULL) return;
2531 if (name != NULL) printf("%s %s not found\n", type, name);
2536 /*************************************************
2537 * Read a named list item *
2538 *************************************************/
2540 /* This function reads a name and a list (i.e. string). The name is used to
2541 save the list in a tree, sorted by its name. Each entry also has a number,
2542 which can be used for caching tests, but if the string contains any expansion
2543 items other than $key, the number is set negative to inhibit caching. This
2544 mechanism is used for domain, host, and address lists that are referenced by
2548 anchorp points to the tree anchor
2549 numberp points to the current number for this tree
2550 max the maximum number permitted
2551 s the text of the option line, starting immediately after the name
2553 tname the name of the list type, for messages
2559 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2562 BOOL forcecache = FALSE;
2565 namedlist_block *nb = store_get(sizeof(namedlist_block));
2567 if (Ustrncmp(s, "_cache", 6) == 0)
2574 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2576 if (*numberp >= max)
2577 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2580 while (isspace(*s)) s++;
2582 while (isalnum(*s) || *s == '_') s++;
2583 t = store_get(sizeof(tree_node) + s-ss);
2584 Ustrncpy(t->name, ss, s-ss);
2586 while (isspace(*s)) s++;
2588 if (!tree_insertnode(anchorp, t))
2589 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2590 "duplicate name \"%s\" for a named %s", t->name, tname);
2593 nb->number = *numberp;
2596 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2597 "missing '=' after \"%s\"", t->name);
2598 while (isspace(*s)) s++;
2599 nb->string = read_string(s, t->name);
2600 nb->cache_data = NULL;
2602 /* Check the string for any expansions; if any are found, mark this list
2603 uncacheable unless the user has explicited forced caching. */
2605 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2611 /*************************************************
2612 * Unpick data for a rate limit *
2613 *************************************************/
2615 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2619 s string, in the form t,b,f,l
2620 where t is the threshold (integer)
2621 b is the initial delay (time)
2622 f is the multiplicative factor (fixed point)
2623 k is the maximum time (time)
2624 threshold where to store threshold
2625 base where to store base in milliseconds
2626 factor where to store factor in milliseconds
2627 limit where to store limit
2629 Returns: nothing (panics on error)
2633 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2636 uschar bstring[16], lstring[16];
2638 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2639 factor, lstring) == 4)
2641 *base = readconf_readtime(bstring, 0, TRUE);
2642 *limit = readconf_readtime(lstring, 0, TRUE);
2643 if (*base >= 0 && *limit >= 0) return;
2645 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2651 /*************************************************
2652 * Read main configuration options *
2653 *************************************************/
2655 /* This function is the first to be called for configuration reading. It
2656 opens the configuration file and reads general configuration settings until
2657 it reaches the end of the configuration section. The file is then left open so
2658 that the remaining configuration data can subsequently be read if needed for
2661 The configuration file must be owned either by root or exim, and be writeable
2662 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2663 in the config file, so the test is done on the compiled in values. A slight
2664 anomaly, to be carefully documented.
2666 The name of the configuration file is taken from a list that is included in the
2667 binary of Exim. It can be altered from the command line, but if that is done,
2668 root privilege is immediately withdrawn unless the caller is root or exim.
2669 The first file on the list that exists is used.
2671 For use on multiple systems that share file systems, first look for a
2672 configuration file whose name has the current node name on the end. If that is
2673 not found, try the generic name. For really contorted configurations, that run
2674 multiple Exims with different uid settings, first try adding the effective uid
2675 before the node name. These complications are going to waste resources on most
2676 systems. Therefore they are available only when requested by compile-time
2683 struct stat statbuf;
2684 uschar *s, *filename;
2685 uschar *list = config_main_filelist;
2687 /* Loop through the possible file names */
2689 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2692 /* Cut out all the fancy processing unless specifically wanted */
2694 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2695 uschar *suffix = filename + Ustrlen(filename);
2697 /* Try for the node-specific file if a node name exists */
2699 #ifdef CONFIGURE_FILE_USE_NODE
2701 if (uname(&uts) >= 0)
2703 #ifdef CONFIGURE_FILE_USE_EUID
2704 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2705 config_file = Ufopen(filename, "rb");
2706 if (config_file == NULL)
2707 #endif /* CONFIGURE_FILE_USE_EUID */
2709 sprintf(CS suffix, ".%.256s", uts.nodename);
2710 config_file = Ufopen(filename, "rb");
2713 #endif /* CONFIGURE_FILE_USE_NODE */
2715 /* Otherwise, try the generic name, possibly with the euid added */
2717 #ifdef CONFIGURE_FILE_USE_EUID
2718 if (config_file == NULL)
2720 sprintf(CS suffix, ".%ld", (long int)original_euid);
2721 config_file = Ufopen(filename, "rb");
2723 #endif /* CONFIGURE_FILE_USE_EUID */
2725 /* Finally, try the unadorned name */
2727 if (config_file == NULL)
2730 config_file = Ufopen(filename, "rb");
2732 #else /* if neither defined */
2734 /* This is the common case when the fancy processing is not included. */
2736 config_file = Ufopen(filename, "rb");
2739 /* If the file does not exist, continue to try any others. For any other
2740 error, break out (and die). */
2742 if (config_file != NULL || errno != ENOENT) break;
2745 /* On success, save the name for verification; config_filename is used when
2746 logging configuration errors (it changes for .included files) whereas
2747 config_main_filename is the name shown by -bP. Failure to open a configuration
2748 file is a serious disaster. */
2750 if (config_file != NULL)
2752 config_filename = config_main_filename = string_copy(filename);
2756 if (filename == NULL)
2757 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2758 "%s", config_main_filelist);
2760 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2761 "configuration file %s", filename));
2764 /* Check the status of the file we have opened, unless it was specified on
2765 the command line, in which case privilege was given away at the start. */
2767 if (!config_changed)
2769 if (fstat(fileno(config_file), &statbuf) != 0)
2770 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2773 if ((statbuf.st_uid != root_uid && /* owner not root */
2774 statbuf.st_uid != exim_uid /* owner not exim */
2775 #ifdef CONFIGURE_OWNER
2776 && statbuf.st_uid != config_uid /* owner not the special one */
2779 (statbuf.st_gid != exim_gid /* group not exim & */
2780 #ifdef CONFIGURE_GROUP
2781 && statbuf.st_gid != config_gid /* group not the special one */
2783 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2785 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2787 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2788 "wrong owner, group, or mode", big_buffer);
2791 /* Process the main configuration settings. They all begin with a lower case
2792 letter. If we see something starting with an upper case letter, it is taken as
2793 a macro definition. */
2795 while ((s = get_config_line()) != NULL)
2797 if (isupper(s[0])) read_macro_assignment(s);
2799 else if (Ustrncmp(s, "domainlist", 10) == 0)
2800 read_named_list(&domainlist_anchor, &domainlist_count,
2801 MAX_NAMED_LIST, s+10, US"domain list");
2803 else if (Ustrncmp(s, "hostlist", 8) == 0)
2804 read_named_list(&hostlist_anchor, &hostlist_count,
2805 MAX_NAMED_LIST, s+8, US"host list");
2807 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2808 read_named_list(&addresslist_anchor, &addresslist_count,
2809 MAX_NAMED_LIST, s+11, US"address list");
2811 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2812 read_named_list(&localpartlist_anchor, &localpartlist_count,
2813 MAX_NAMED_LIST, s+13, US"local part list");
2816 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2817 NULL, US"main option \"%s\" unknown");
2821 /* If local_sender_retain is set, local_from_check must be unset. */
2823 if (local_sender_retain && local_from_check)
2824 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2825 "local_sender_retain are set; this combination is not allowed");
2827 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2830 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2832 /* The max retry interval must not be greater than 24 hours. */
2834 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2836 /* remote_max_parallel must be > 0 */
2838 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2840 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2841 start of a new SMTP message. */
2843 freeze_tell_config = freeze_tell;
2845 /* The primary host name may be required for expansion of spool_directory
2846 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2847 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2848 canonize it. Some people like upper case letters in their host names, so we
2849 don't force the case. */
2851 if (primary_hostname == NULL)
2855 if (uname(&uts) < 0)
2856 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2857 hostname = US uts.nodename;
2859 if (Ustrchr(hostname, '.') == NULL)
2862 struct hostent *hostdata;
2865 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2866 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2876 #if HAVE_GETIPNODEBYNAME
2878 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2880 hostdata = gethostbyname2(CS hostname, af);
2883 hostdata = gethostbyname(CS hostname);
2886 if (hostdata != NULL)
2888 hostname = US hostdata->h_name;
2892 if (af == AF_INET) break;
2897 primary_hostname = string_copy(hostname);
2900 /* Set up default value for smtp_active_hostname */
2902 smtp_active_hostname = primary_hostname;
2904 /* If spool_directory wasn't set in the build-time configuration, it must have
2905 got set above. Of course, writing to the log may not work if log_file_path is
2906 not set, but it will at least get to syslog or somewhere, with any luck. */
2908 if (*spool_directory == 0)
2909 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2912 /* Expand the spool directory name; it may, for example, contain the primary
2913 host name. Same comment about failure. */
2915 s = expand_string(spool_directory);
2917 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2918 "\"%s\": %s", spool_directory, expand_string_message);
2919 spool_directory = s;
2921 /* Expand log_file_path, which must contain "%s" in any component that isn't
2922 the null string or "syslog". It is also allowed to contain one instance of %D.
2923 However, it must NOT contain % followed by anything else. */
2925 if (*log_file_path != 0)
2928 int sep = ':'; /* Fixed for log file path */
2929 s = expand_string(log_file_path);
2931 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2932 "\"%s\": %s", log_file_path, expand_string_message);
2935 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2938 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2939 t = Ustrstr(sss, "%s");
2941 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2942 "contain \"%%s\"", sss);
2944 t = Ustrchr(sss, '%');
2947 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2948 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2949 "unexpected \"%%\" character", s);
2956 /* Interpret syslog_facility into an integer argument for 'ident' param to
2957 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2960 if (syslog_facility_str != NULL)
2963 uschar *s = syslog_facility_str;
2965 if ((Ustrlen(syslog_facility_str) >= 4) &&
2966 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2969 for (i = 0; i < syslog_list_size; i++)
2971 if (strcmpic(s, syslog_list[i].name) == 0)
2973 syslog_facility = syslog_list[i].value;
2978 if (i >= syslog_list_size)
2980 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2981 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2985 /* Expand pid_file_path */
2987 if (*pid_file_path != 0)
2989 s = expand_string(pid_file_path);
2991 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2992 "\"%s\": %s", pid_file_path, expand_string_message);
2996 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2999 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3001 /* Unpick the SMTP rate limiting options, if set */
3003 if (smtp_ratelimit_mail != NULL)
3005 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3006 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3009 if (smtp_ratelimit_rcpt != NULL)
3011 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3012 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3015 /* The qualify domains default to the primary host name */
3017 if (qualify_domain_sender == NULL)
3018 qualify_domain_sender = primary_hostname;
3019 if (qualify_domain_recipient == NULL)
3020 qualify_domain_recipient = qualify_domain_sender;
3022 /* Setting system_filter_user in the configuration sets the gid as well if a
3023 name is given, but a numerical value does not. */
3025 if (system_filter_uid_set && !system_filter_gid_set)
3027 struct passwd *pw = getpwuid(system_filter_uid);
3029 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3030 (long int)system_filter_uid);
3031 system_filter_gid = pw->pw_gid;
3032 system_filter_gid_set = TRUE;
3035 /* If the errors_reply_to field is set, check that it is syntactically valid
3036 and ensure it contains a domain. */
3038 if (errors_reply_to != NULL)
3041 int start, end, domain;
3042 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3043 &start, &end, &domain, FALSE);
3045 if (recipient == NULL)
3046 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3047 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3050 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3051 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3054 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3055 smtp_accept_max must also be set. */
3057 if (smtp_accept_max == 0 &&
3058 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3059 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3060 "smtp_accept_max must be set if smtp_accept_queue or "
3061 "smtp_accept_max_per_host is set");
3063 /* Set up the host number if anything is specified. It is an expanded string
3064 so that it can be computed from the host name, for example. We do this last
3065 so as to ensure that everything else is set up before the expansion. */
3067 if (host_number_string != NULL)
3070 uschar *s = expand_string(host_number_string);
3071 long int n = Ustrtol(s, &end, 0);
3072 while (isspace(*end)) end++;
3074 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3075 "localhost_number value is not a number: %s", s);
3076 if (n > LOCALHOST_MAX)
3077 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3078 "localhost_number is greater than the maximum allowed value (%d)",
3084 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3086 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3087 tls_verify_certificates == NULL)
3088 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3089 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3090 (tls_verify_hosts != NULL)? "" : "try_");
3096 /*************************************************
3097 * Initialize one driver *
3098 *************************************************/
3100 /* This is called once the driver's generic options, if any, have been read.
3101 We can now find the driver, set up defaults for the private options, and
3102 unset any "set" bits in the private options table (which might have been
3103 set by another incarnation of the same driver).
3106 d pointer to driver instance block, with generic
3108 drivers_available vector of available drivers
3109 size_of_info size of each block in drivers_available
3110 class class of driver, for error message
3112 Returns: pointer to the driver info block
3115 static driver_info *
3116 init_driver(driver_instance *d, driver_info *drivers_available,
3117 int size_of_info, uschar *class)
3121 for (dd = drivers_available; dd->driver_name[0] != 0;
3122 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3124 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3127 int len = dd->options_len;
3129 d->options_block = store_get(len);
3130 memcpy(d->options_block, dd->options_block, len);
3131 for (i = 0; i < *(dd->options_count); i++)
3132 dd->options[i].type &= ~opt_set;
3137 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3138 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3140 return NULL; /* never obeyed */
3146 /*************************************************
3147 * Initialize driver list *
3148 *************************************************/
3150 /* This function is called for routers, transports, and authentication
3151 mechanisms. It reads the data from the current point in the configuration file
3152 up to the end of the section, and sets up a chain of instance blocks according
3153 to the file's contents. The file will already have been opened by a call to
3154 readconf_main, and must be left open for subsequent reading of further data.
3156 Any errors cause a panic crash. Note that the blocks with names driver_info and
3157 driver_instance must map the first portions of all the _info and _instance
3158 blocks for this shared code to work.
3161 class "router", "transport", or "authenticator"
3162 anchor &routers, &transports, &auths
3163 drivers_available available drivers
3164 size_of_info size of each info block
3165 instance_default points to default data for an instance
3166 instance_size size of instance block
3167 driver_optionlist generic option list
3168 driver_optionlist_count count of generic option list
3174 readconf_driver_init(
3176 driver_instance **anchor,
3177 driver_info *drivers_available,
3179 void *instance_default,
3181 optionlist *driver_optionlist,
3182 int driver_optionlist_count)
3184 driver_instance **p = anchor;
3185 driver_instance *d = NULL;
3188 while ((buffer = get_config_line()) != NULL)
3193 /* Read the first name on the line and test for the start of a new driver. A
3194 macro definition indicates the end of the previous driver. If this isn't the
3195 start of a new driver, the line will be re-read. */
3197 s = readconf_readname(name, sizeof(name), buffer);
3199 /* Handle macro definition, first finishing off the initialization of the
3200 previous driver, if any. */
3202 if (isupper(*name) && *s == '=')
3206 if (d->driver_name == NULL)
3207 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3208 "no driver defined for %s \"%s\"", class, d->name);
3212 read_macro_assignment(buffer);
3216 /* If the line starts with a name terminated by a colon, we are at the
3217 start of the definition of a new driver. The rest of the line must be
3224 /* Finish off initializing the previous driver. */
3228 if (d->driver_name == NULL)
3229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3230 "no driver defined for %s \"%s\"", class, d->name);
3234 /* Check that we haven't already got a driver of this name */
3236 for (d = *anchor; d != NULL; d = d->next)
3237 if (Ustrcmp(name, d->name) == 0)
3238 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3239 "there are two %ss called \"%s\"", class, name);
3241 /* Set up a new driver instance data block on the chain, with
3242 its default values installed. */
3244 d = store_get(instance_size);
3245 memcpy(d, instance_default, instance_size);
3248 d->name = string_copy(name);
3250 /* Clear out the "set" bits in the generic options */
3252 for (i = 0; i < driver_optionlist_count; i++)
3253 driver_optionlist[i].type &= ~opt_set;
3255 /* Check nothing more on this line, then do the next loop iteration. */
3257 while (isspace(*s)) s++;
3258 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3262 /* Not the start of a new driver. Give an error if we have not set up a
3263 current driver yet. */
3265 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3266 "%s name missing", class);
3268 /* First look to see if this is a generic option; if it is "driver",
3269 initialize the driver. If is it not a generic option, we can look for a
3270 private option provided that the driver has been previously set up. */
3272 if (readconf_handle_option(buffer, driver_optionlist,
3273 driver_optionlist_count, d, NULL))
3275 if (d->info == NULL && d->driver_name != NULL)
3276 init_driver(d, drivers_available, size_of_info, class);
3279 /* Handle private options - pass the generic block because some may
3280 live therein. A flag with each option indicates if it is in the public
3283 else if (d->info != NULL)
3285 readconf_handle_option(buffer, d->info->options,
3286 *(d->info->options_count), d, US"option \"%s\" unknown");
3289 /* The option is not generic and the driver name has not yet been given. */
3291 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3292 "(\"driver\" must be specified before any private options)", name);
3295 /* Run the initialization function for the final driver. */
3299 if (d->driver_name == NULL)
3300 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3301 "no driver defined for %s \"%s\"", class, d->name);
3308 /*************************************************
3309 * Check driver dependency *
3310 *************************************************/
3312 /* This function is passed a driver instance and a string. It checks whether
3313 any of the string options for the driver contains the given string as an
3317 d points to a driver instance block
3318 s the string to search for
3320 Returns: TRUE if a dependency is found
3324 readconf_depends(driver_instance *d, uschar *s)
3326 int count = *(d->info->options_count);
3330 for (ol = d->info->options; ol < d->info->options + count; ol++)
3332 void *options_block;
3334 int type = ol->type & opt_mask;
3335 if (type != opt_stringptr) continue;
3336 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3337 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3338 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3340 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3341 isalnum(ss[Ustrlen(s)])) continue;
3342 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3343 d->name, ol->name, s);
3348 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3355 /*************************************************
3356 * Decode an error type for retries *
3357 *************************************************/
3359 /* This function is global because it is also called from the main
3360 program when testing retry information. It decodes strings such as "quota_7d"
3361 into numerical error codes.
3364 pp points to start of text
3365 p points past end of text
3366 basic_errno points to an int to receive the main error number
3367 more_errno points to an int to receive the secondary error data
3369 Returns: NULL if decoded correctly; else points to error text
3373 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3377 while (q < p && *q != '_') q++;
3380 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3382 *basic_errno = ERRNO_EXIMQUOTA;
3383 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3384 return US"bad time value";
3387 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3389 *basic_errno = ECONNREFUSED;
3392 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3393 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3394 else return US"A or MX expected after \"refused\"";
3398 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3400 *basic_errno = ETIMEDOUT;
3404 int xlen = p - q - 1;
3407 static uschar *extras[] =
3408 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3409 static int values[] =
3410 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3412 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3414 if (strncmpic(x, extras[i], xlen) == 0)
3416 *more_errno = values[i];
3421 if (i >= sizeof(extras)/sizeof(uschar *))
3423 if (strncmpic(x, US"DNS", xlen) == 0)
3425 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3426 "available in retry rules (it has never worked) - treated as "
3429 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3434 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3435 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3436 strncmpic(pp, US"data_4", 6) == 0)
3439 int x = 255; /* means "any 4xx code" */
3440 if (p != pp + 8) bad = TRUE; else
3442 int a = pp[6], b = pp[7];
3446 if (isdigit(b)) x += b - '0';
3447 else if (b == 'x') x += 100;
3450 else if (a != 'x' || b != 'x') bad = TRUE;
3454 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3455 "x is literal and d is any digit", pp);
3457 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3458 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3459 *more_errno = x << 8;
3462 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3463 strncmpic(q+1, US"failed", p-q-1) == 0)
3464 *basic_errno = ERRNO_AUTHFAIL;
3466 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3467 *basic_errno = ERRNO_SMTPCLOSED;
3469 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3470 *basic_errno = ERRNO_TLSREQUIRED;
3472 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3473 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3481 /*************************************************
3482 * Read retry information *
3483 *************************************************/
3485 /* Each line of retry information contains:
3487 . A domain name pattern or an address pattern;
3489 . An error name, possibly with additional data, or *;
3491 . An optional sequence of retry items, each consisting of an identifying
3492 letter, a cutoff time, and optional parameters.
3494 All this is decoded and placed into a control block. */
3497 /* Subroutine to read an argument, preceded by a comma and terminated
3498 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3499 1 = fixed point number (returned *1000).
3502 paddr pointer to pointer to current character; updated
3503 type 0 => read a time; 1 => read a fixed point number
3505 Returns: time in seconds or fixed point number * 1000
3509 retry_arg(uschar **paddr, int type)
3514 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3516 while (isspace(*p)) p++;
3518 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3520 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3521 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3527 return readconf_readtime(pp, *p, FALSE);
3529 return readconf_readfixed(pp, *p);
3531 return 0; /* Keep picky compilers happy */
3534 /* The function proper */
3537 readconf_retries(void)
3539 retry_config **chain = &retries;
3543 while ((p = get_config_line()) != NULL)
3545 retry_rule **rchain;
3548 next = store_get(sizeof(retry_config));
3551 chain = &(next->next);
3552 next->basic_errno = next->more_errno = 0;
3553 next->senders = NULL;
3555 rchain = &(next->rules);
3557 next->pattern = string_dequote(&p);
3558 while (isspace(*p)) p++;
3560 while (mac_isgraph(*p)) p++;
3561 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3562 "missing error type");
3564 /* Test error names for things we understand. */
3566 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3567 &(next->more_errno))) != NULL)
3568 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3570 /* There may be an optional address list of senders to be used as another
3571 constraint on the rule. This was added later, so the syntax is a bit of a
3572 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3575 while (isspace(*p)) p++;
3576 if (Ustrncmp(p, "senders", 7) == 0)
3579 while (isspace(*p)) p++;
3580 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3581 "\"=\" expected after \"senders\" in retry rule");
3582 while (isspace(*p)) p++;
3583 next->senders = string_dequote(&p);
3586 /* Now the retry rules. Keep the maximum timeout encountered. */
3588 while (isspace(*p)) p++;
3592 retry_rule *rule = store_get(sizeof(retry_rule));
3594 rchain = &(rule->next);
3596 rule->rule = toupper(*p++);
3597 rule->timeout = retry_arg(&p, 0);
3598 if (rule->timeout > retry_maximum_timeout)
3599 retry_maximum_timeout = rule->timeout;
3603 case 'F': /* Fixed interval */
3604 rule->p1 = retry_arg(&p, 0);
3607 case 'G': /* Geometrically increasing intervals */
3608 case 'H': /* Ditto, but with randomness */
3609 rule->p1 = retry_arg(&p, 0);
3610 rule->p2 = retry_arg(&p, 1);
3614 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3618 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3619 (rule->rule != 'F' && rule->p2 < 1000))
3620 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3621 "bad parameters for retry rule");
3623 while (isspace(*p)) p++;
3627 while (isspace(*p)) p++;
3630 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3637 /*************************************************
3638 * Initialize authenticators *
3639 *************************************************/
3641 /* Read the authenticators section of the configuration file.
3650 auth_instance *au, *bu;
3651 readconf_driver_init(US"authenticator",
3652 (driver_instance **)(&auths), /* chain anchor */
3653 (driver_info *)auths_available, /* available drivers */
3654 sizeof(auth_info), /* size of info block */
3655 &auth_defaults, /* default values for generic options */
3656 sizeof(auth_instance), /* size of instance block */
3657 optionlist_auths, /* generic options */
3658 optionlist_auths_size);
3660 for (au = auths; au != NULL; au = au->next)
3662 if (au->public_name == NULL)
3663 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3664 "the %s authenticator", au->name);
3665 for (bu = au->next; bu != NULL; bu = bu->next)
3667 if (strcmpic(au->public_name, bu->public_name) == 0)
3669 if ((au->client && bu->client) || (au->server && bu->server))
3670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3671 "(%s and %s) have the same public name (%s)",
3672 (au->client)? US"client" : US"server", au->name, bu->name,
3682 /*************************************************
3683 * Read ACL information *
3684 *************************************************/
3686 /* If this run of Exim is not doing something that involves receiving a
3687 message, we can just skip over the ACL information. No need to parse it.
3689 First, we have a function for acl_read() to call back to get the next line. We
3690 need to remember the line we passed, because at the end it will contain the
3691 name of the next ACL. */
3693 static uschar *acl_line;
3698 acl_line = get_config_line();
3703 /* Now the main function:
3706 skip TRUE when this Exim process is doing something that will
3707 not need the ACL data
3713 readconf_acl(BOOL skip)
3717 /* Not receiving messages, don't need to parse the ACL data */
3721 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3722 while ((p = get_config_line()) != NULL);
3726 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3729 acl_line = get_config_line();
3731 while(acl_line != NULL)
3737 p = readconf_readname(name, sizeof(name), acl_line);
3738 if (isupper(*name) && *p == '=')
3740 read_macro_assignment(acl_line);
3741 acl_line = get_config_line();
3745 if (*p != ':' || name[0] == 0)
3746 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3748 node = store_get(sizeof(tree_node) + Ustrlen(name));
3749 Ustrcpy(node->name, name);
3750 if (!tree_insertnode(&acl_anchor, node))
3751 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3752 "there are two ACLs called \"%s\"", name);
3754 node->data.ptr = acl_read(acl_callback, &error);
3756 if (node->data.ptr == NULL && error != NULL)
3757 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3763 /*************************************************
3764 * Read configuration for local_scan() *
3765 *************************************************/
3767 /* This function is called after "begin local_scan" is encountered in the
3768 configuration file. If the local_scan() function allows for configuration
3769 options, we can process them. Otherwise, we expire in a panic.
3776 local_scan_init(void)
3778 #ifndef LOCAL_SCAN_HAS_OPTIONS
3779 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3780 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3784 while ((p = get_config_line()) != NULL)
3786 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3787 NULL, US"local_scan option \"%s\" unknown");
3794 /*************************************************
3795 * Read rest of configuration (after main) *
3796 *************************************************/
3798 /* This function reads the rest of the runtime configuration, after the main
3799 configuration. It is called only when actually needed. Each subsequent section
3800 of the configuration starts with a line of the form
3804 where the name is "routers", "transports", etc. A section is terminated by
3805 hitting the next "begin" line, and the next name is left in next_section.
3806 Because it may confuse people as to whether the names are singular or plural,
3807 we add "s" if it's missing. There is always enough room in next_section for
3808 this. This function is basically just a switch.
3811 skip_acl TRUE if ACL information is not needed
3816 static uschar *section_list[] = {
3826 readconf_rest(BOOL skip_acl)
3830 while(next_section[0] != 0)
3834 int last = sizeof(section_list) / sizeof(uschar *);
3836 int n = Ustrlen(next_section);
3838 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3842 int c = strcmpic(next_section, section_list[mid]);
3844 if (c > 0) first = mid + 1; else last = mid;
3846 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3847 "\"%.*s\" is not a known configuration section name", n, next_section);
3848 mid = (last + first)/2;
3852 if (((had ^= bit) & bit) == 0)
3853 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3854 "\"%.*s\" section is repeated in the configuration file", n,
3859 case 0: readconf_acl(skip_acl); break;
3860 case 1: auths_init(); break;
3861 case 2: local_scan_init(); break;
3862 case 3: readconf_retries(); break;
3863 case 4: readconf_rewrites(); break;
3864 case 5: route_init(); break;
3865 case 6: transport_init(); break;
3869 (void)fclose(config_file);
3872 /* End of readconf.c */