1 /* $Cambridge: exim/src/src/readconf.c,v 1.15 2005/11/15 10:08:25 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
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_smtp_auth", opt_stringptr, &acl_smtp_auth },
142 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
143 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
144 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
145 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
146 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
147 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
148 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
149 #ifdef WITH_CONTENT_SCAN
150 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
152 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
153 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
154 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
156 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
158 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
159 { "admin_groups", opt_gidlist, &admin_groups },
160 { "allow_domain_literals", opt_bool, &allow_domain_literals },
161 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
162 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
163 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
164 { "auto_thaw", opt_time, &auto_thaw },
165 #ifdef WITH_CONTENT_SCAN
166 { "av_scanner", opt_stringptr, &av_scanner },
168 { "bi_command", opt_stringptr, &bi_command },
169 #ifdef EXPERIMENTAL_BRIGHTMAIL
170 { "bmi_config_file", opt_stringptr, &bmi_config_file },
172 { "bounce_message_file", opt_stringptr, &bounce_message_file },
173 { "bounce_message_text", opt_stringptr, &bounce_message_text },
174 { "bounce_return_body", opt_bool, &bounce_return_body },
175 { "bounce_return_message", opt_bool, &bounce_return_message },
176 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
177 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
178 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
179 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
180 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
181 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
182 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
183 { "check_log_inodes", opt_int, &check_log_inodes },
184 { "check_log_space", opt_Kint, &check_log_space },
185 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
186 { "check_spool_inodes", opt_int, &check_spool_inodes },
187 { "check_spool_space", opt_Kint, &check_spool_space },
188 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
189 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
190 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
191 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
192 { "delay_warning", opt_timelist, &delay_warning },
193 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
194 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
195 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
196 { "delivery_date_remove", opt_bool, &delivery_date_remove },
197 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
198 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
199 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
200 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
201 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
202 { "dns_retrans", opt_time, &dns_retrans },
203 { "dns_retry", opt_int, &dns_retry },
204 /* This option is now a no-op, retained for compability */
205 { "drop_cr", opt_bool, &drop_cr },
206 /*********************************************************/
207 { "envelope_to_remove", opt_bool, &envelope_to_remove },
208 { "errors_copy", opt_stringptr, &errors_copy },
209 { "errors_reply_to", opt_stringptr, &errors_reply_to },
210 { "exim_group", opt_gid, &exim_gid },
211 { "exim_path", opt_stringptr, &exim_path },
212 { "exim_user", opt_uid, &exim_uid },
213 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
214 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
215 { "finduser_retries", opt_int, &finduser_retries },
216 { "freeze_tell", opt_stringptr, &freeze_tell },
217 { "gecos_name", opt_stringptr, &gecos_name },
218 { "gecos_pattern", opt_stringptr, &gecos_pattern },
219 { "header_line_maxsize", opt_int, &header_line_maxsize },
220 { "header_maxsize", opt_int, &header_maxsize },
221 { "headers_charset", opt_stringptr, &headers_charset },
222 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
223 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
224 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
225 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
226 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
227 { "hold_domains", opt_stringptr, &hold_domains },
228 { "host_lookup", opt_stringptr, &host_lookup },
229 { "host_lookup_order", opt_stringptr, &host_lookup_order },
230 { "host_reject_connection", opt_stringptr, &host_reject_connection },
231 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
232 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
234 { "ibase_servers", opt_stringptr, &ibase_servers },
236 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
237 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
238 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
239 { "keep_malformed", opt_time, &keep_malformed },
241 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
242 { "ldap_version", opt_int, &eldap_version },
244 { "local_from_check", opt_bool, &local_from_check },
245 { "local_from_prefix", opt_stringptr, &local_from_prefix },
246 { "local_from_suffix", opt_stringptr, &local_from_suffix },
247 { "local_interfaces", opt_stringptr, &local_interfaces },
248 { "local_scan_timeout", opt_time, &local_scan_timeout },
249 { "local_sender_retain", opt_bool, &local_sender_retain },
250 { "localhost_number", opt_stringptr, &host_number_string },
251 { "log_file_path", opt_stringptr, &log_file_path },
252 { "log_selector", opt_stringptr, &log_selector_string },
253 { "log_timezone", opt_bool, &log_timezone },
254 { "lookup_open_max", opt_int, &lookup_open_max },
255 { "max_username_length", opt_int, &max_username_length },
256 { "message_body_visible", opt_mkint, &message_body_visible },
257 { "message_id_header_domain", opt_stringptr, &message_id_domain },
258 { "message_id_header_text", opt_stringptr, &message_id_text },
259 { "message_logs", opt_bool, &message_logs },
260 { "message_size_limit", opt_stringptr, &message_size_limit },
261 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
262 { "move_frozen_messages", opt_bool, &move_frozen_messages },
264 { "mua_wrapper", opt_bool, &mua_wrapper },
266 { "mysql_servers", opt_stringptr, &mysql_servers },
268 { "never_users", opt_uidlist, &never_users },
270 { "oracle_servers", opt_stringptr, &oracle_servers },
272 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
274 { "perl_at_start", opt_bool, &opt_perl_at_start },
275 { "perl_startup", opt_stringptr, &opt_perl_startup },
278 { "pgsql_servers", opt_stringptr, &pgsql_servers },
280 { "pid_file_path", opt_stringptr, &pid_file_path },
281 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
282 { "preserve_message_logs", opt_bool, &preserve_message_logs },
283 { "primary_hostname", opt_stringptr, &primary_hostname },
284 { "print_topbitchars", opt_bool, &print_topbitchars },
285 { "process_log_path", opt_stringptr, &process_log_path },
286 { "prod_requires_admin", opt_bool, &prod_requires_admin },
287 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
288 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
289 { "queue_domains", opt_stringptr, &queue_domains },
290 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
291 { "queue_only", opt_bool, &queue_only },
292 { "queue_only_file", opt_stringptr, &queue_only_file },
293 { "queue_only_load", opt_fixed, &queue_only_load },
294 { "queue_only_override", opt_bool, &queue_only_override },
295 { "queue_run_in_order", opt_bool, &queue_run_in_order },
296 { "queue_run_max", opt_int, &queue_run_max },
297 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
298 { "receive_timeout", opt_time, &receive_timeout },
299 { "received_header_text", opt_stringptr, &received_header_text },
300 { "received_headers_max", opt_int, &received_headers_max },
301 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
302 { "recipients_max", opt_int, &recipients_max },
303 { "recipients_max_reject", opt_bool, &recipients_max_reject },
304 { "remote_max_parallel", opt_int, &remote_max_parallel },
305 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
306 { "retry_data_expire", opt_time, &retry_data_expire },
307 { "retry_interval_max", opt_time, &retry_interval_max },
308 { "return_path_remove", opt_bool, &return_path_remove },
309 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
310 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
311 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
312 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
313 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
314 { "smtp_accept_max", opt_int, &smtp_accept_max },
315 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
316 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
317 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
318 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
319 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
320 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
321 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
322 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
323 { "smtp_banner", opt_stringptr, &smtp_banner },
324 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
325 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
326 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
327 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
328 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
329 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
330 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
331 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
332 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
333 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
334 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
335 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
336 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
337 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
338 #ifdef WITH_CONTENT_SCAN
339 { "spamd_address", opt_stringptr, &spamd_address },
341 { "split_spool_directory", opt_bool, &split_spool_directory },
342 { "spool_directory", opt_stringptr, &spool_directory },
344 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
346 #ifdef EXPERIMENTAL_SRS
347 { "srs_config", opt_stringptr, &srs_config },
348 { "srs_hashlength", opt_int, &srs_hashlength },
349 { "srs_hashmin", opt_int, &srs_hashmin },
350 { "srs_maxage", opt_int, &srs_maxage },
351 { "srs_secrets", opt_stringptr, &srs_secrets },
352 { "srs_usehash", opt_bool, &srs_usehash },
353 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
355 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
356 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
357 { "syslog_duplication", opt_bool, &syslog_duplication },
358 { "syslog_facility", opt_stringptr, &syslog_facility_str },
359 { "syslog_processname", opt_stringptr, &syslog_processname },
360 { "syslog_timestamp", opt_bool, &syslog_timestamp },
361 { "system_filter", opt_stringptr, &system_filter },
362 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
363 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
364 { "system_filter_group", opt_gid, &system_filter_gid },
365 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
366 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
367 { "system_filter_user", opt_uid, &system_filter_uid },
368 { "tcp_nodelay", opt_bool, &tcp_nodelay },
369 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
370 { "timezone", opt_stringptr, &timezone_string },
372 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
373 { "tls_certificate", opt_stringptr, &tls_certificate },
374 { "tls_crl", opt_stringptr, &tls_crl },
375 { "tls_dhparam", opt_stringptr, &tls_dhparam },
376 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
377 { "tls_privatekey", opt_stringptr, &tls_privatekey },
378 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
379 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
380 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
381 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
382 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
384 { "trusted_groups", opt_gidlist, &trusted_groups },
385 { "trusted_users", opt_uidlist, &trusted_users },
386 { "unknown_login", opt_stringptr, &unknown_login },
387 { "unknown_username", opt_stringptr, &unknown_username },
388 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
389 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
390 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
391 { "warn_message_file", opt_stringptr, &warn_message_file },
392 { "write_rejectlog", opt_bool, &write_rejectlog }
395 static int optionlist_config_size =
396 sizeof(optionlist_config)/sizeof(optionlist);
400 /*************************************************
401 * Find the name of an option *
402 *************************************************/
404 /* This function is to aid debugging. Various functions take arguments that are
405 pointer variables in the options table or in option tables for various drivers.
406 For debugging output, it is useful to be able to find the name of the option
407 which is currently being processed. This function finds it, if it exists, by
408 searching the table(s).
410 Arguments: a value that is presumed to be in the table above
411 Returns: the option name, or an empty string
415 readconf_find_option(void *p)
419 transport_instance *t;
421 for (i = 0; i < optionlist_config_size; i++)
422 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
424 for (r = routers; r != NULL; r = r->next)
426 router_info *ri = r->info;
427 for (i = 0; i < ri->options_count[0]; i++)
429 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
430 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
431 return US ri->options[i].name;
435 for (t = transports; t != NULL; t = t->next)
437 transport_info *ti = t->info;
438 for (i = 0; i < ti->options_count[0]; i++)
440 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
441 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
442 return US ti->options[i].name;
452 /*************************************************
453 * Deal with an assignment to a macro *
454 *************************************************/
456 /* This function is called when a line that starts with an upper case letter is
457 encountered. The argument "line" should contain a complete logical line, and
458 start with the first letter of the macro name. The macro name and the
459 replacement text are extracted and stored. Redefinition of existing,
460 non-command line, macros is permitted using '==' instead of '='.
463 s points to the start of the logical line
469 read_macro_assignment(uschar *s)
475 macro_item *mlast = NULL;
477 while (isalnum(*s) || *s == '_')
479 if (namelen >= sizeof(name) - 1)
480 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
481 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
482 name[namelen++] = *s++;
486 while (isspace(*s)) s++;
488 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
495 while (isspace(*s)) s++;
497 /* If an existing macro of the same name was defined on the command line, we
498 just skip this definition. It's an error to attempt to redefine a macro without
499 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
500 It is also an error to define a macro whose name begins with the name of a
501 previously defined macro. Note: it is documented that the other way round
504 for (m = macros; m != NULL; m = m->next)
506 int len = Ustrlen(m->name);
508 if (Ustrcmp(m->name, name) == 0)
510 if (!m->command_line && !redef)
511 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
512 "defined (use \"==\" if you want to redefine it", name);
516 if (len < namelen && Ustrstr(name, m->name) != NULL)
517 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
518 "a macro because previously defined macro \"%s\" is a substring",
521 /* We cannot have this test, because it is documented that a substring
522 macro is permitted (there is even an example).
524 * if (len > namelen && Ustrstr(m->name, name) != NULL)
525 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
526 * "a macro because it is a substring of previously defined macro \"%s\"",
533 /* Check for an overriding command-line definition. */
535 if (m != NULL && m->command_line) return;
537 /* Redefinition must refer to an existing macro. */
542 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
546 /* We have a new definition. The macro_item structure includes a final vector
547 called "name" which is one byte long. Thus, adding "namelen" gives us enough
548 room to store the "name" string. */
552 m = store_get(sizeof(macro_item) + namelen);
553 if (macros == NULL) macros = m; else mlast->next = m;
554 Ustrncpy(m->name, name, namelen);
555 m->name[namelen] = 0;
557 m->command_line = FALSE;
560 /* Set the value of the new or redefined macro */
562 m->replacement = string_copy(s);
569 /*************************************************
570 * Read configuration line *
571 *************************************************/
573 /* A logical line of text is read from the configuration file into the big
574 buffer, taking account of macros, .includes, and continuations. The size of
575 big_buffer is increased if necessary. The count of configuration lines is
576 maintained. Physical input lines starting with # (ignoring leading white space,
577 and after macro replacement) and empty logical lines are always ignored.
578 Leading and trailing spaces are removed.
580 If we hit a line of the form "begin xxxx", the xxxx is placed in the
581 next_section vector, and the function returns NULL, indicating the end of a
582 configuration section. On end-of-file, NULL is returned with next_section
587 Returns: a pointer to the first non-blank in the line,
588 or NULL if eof or end of section is reached
592 get_config_line(void)
594 int startoffset = 0; /* To first non-blank char in logical line */
595 int len = 0; /* Of logical line so far */
601 /* Loop for handling continuation lines, skipping comments, and dealing with
606 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
608 if (config_file_stack != NULL) /* EOF inside .include */
610 (void)fclose(config_file);
611 config_file = config_file_stack->file;
612 config_filename = config_file_stack->filename;
613 config_lineno = config_file_stack->lineno;
614 config_file_stack = config_file_stack->next;
618 /* EOF at top level */
620 if (cstate_stack_ptr >= 0)
621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
622 "Unexpected end of configuration file: .endif missing");
624 if (len != 0) break; /* EOF after continuation */
625 next_section[0] = 0; /* EOF at start of logical line */
630 newlen = len + Ustrlen(big_buffer + len);
632 /* Handle pathologically long physical lines - yes, it did happen - by
633 extending big_buffer at this point. The code also copes with very long
636 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
639 big_buffer_size += BIG_BUFFER_SIZE;
640 newbuffer = store_malloc(big_buffer_size);
642 /* This use of strcpy is OK because we know that the string in the old
643 buffer is shorter than the new buffer. */
645 Ustrcpy(newbuffer, big_buffer);
646 store_free(big_buffer);
647 big_buffer = newbuffer;
648 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
650 newlen += Ustrlen(big_buffer + newlen);
653 /* Find the true start of the physical line - leading spaces are always
656 ss = big_buffer + len;
657 while (isspace(*ss)) ss++;
659 /* Process the physical line for macros. If this is the start of the logical
660 line, skip over initial text at the start of the line if it starts with an
661 upper case character followed by a sequence of name characters and an equals
662 sign, because that is the definition of a new macro, and we don't do
663 replacement therein. */
666 if (len == 0 && isupper(*s))
668 while (isalnum(*s) || *s == '_') s++;
669 while (isspace(*s)) s++;
670 if (*s != '=') s = ss; /* Not a macro definition */
673 /* For each defined macro, scan the line (from after XXX= if present),
674 replacing all occurrences of the macro. */
677 for (m = macros; m != NULL; m = m->next)
682 while ((p = Ustrstr(t, m->name)) != NULL)
685 int namelen = Ustrlen(m->name);
686 int replen = Ustrlen(m->replacement);
688 /* Expand the buffer if necessary */
690 while (newlen - namelen + replen + 1 > big_buffer_size)
692 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
693 uschar *newbuffer = store_malloc(newsize);
694 memcpy(newbuffer, big_buffer, newlen + 1);
695 p = newbuffer + (p - big_buffer);
696 s = newbuffer + (s - big_buffer);
697 ss = newbuffer + (ss - big_buffer);
698 t = newbuffer + (t - big_buffer);
699 big_buffer_size = newsize;
700 store_free(big_buffer);
701 big_buffer = newbuffer;
704 /* Shuffle the remaining characters up or down in the buffer before
705 copying in the replacement text. Don't rescan the replacement for this
709 moveby = replen - namelen;
712 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
715 Ustrncpy(p, m->replacement, replen);
721 /* An empty macro replacement at the start of a line could mean that ss no
722 longer points to the first non-blank character. */
724 while (isspace(*ss)) ss++;
726 /* Check for comment lines - these are physical lines. */
728 if (*ss == '#') continue;
730 /* Handle conditionals, which are also applied to physical lines. Conditions
731 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
732 expansion occured on the rest of the line. A preliminary test for the leading
733 '.' saves effort on most lines. */
739 /* Search the list of conditional directives */
741 for (i = 0; i < cond_list_size; i++)
744 cond_item *c = cond_list+i;
745 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
747 /* The following character must be white space or end of string */
749 n = ss[1 + c->namelen];
750 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
752 /* .ifdef and .ifndef push the current state onto the stack, then set
753 a new one from the table. Stack overflow is an error */
757 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
758 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
759 ".%s nested too deeply", c->name);
760 cstate_stack[++cstate_stack_ptr] = cstate;
761 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
764 /* For any of the others, stack underflow is an error. The next state
765 comes either from the stack (.endif) or from the table. */
769 if (cstate_stack_ptr < 0)
770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
771 ".%s without matching .ifdef", c->name);
772 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
773 next_cstate[cstate][macro_found? c->action1 : c->action2];
776 /* Having dealt with a directive, break the loop */
781 /* If we have handled a conditional directive, continue with the next
782 physical line. Otherwise, fall through. */
784 if (i < cond_list_size) continue;
787 /* If the conditional state is not 0 (actively using these lines), ignore
790 if (cstate != 0) continue; /* Conditional skip */
792 /* Handle .include lines - these are also physical lines. */
794 if (Ustrncmp(ss, ".include", 8) == 0 &&
796 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
799 int include_if_exists = isspace(ss[8])? 0 : 10;
800 config_file_item *save;
803 ss += 9 + include_if_exists;
804 while (isspace(*ss)) ss++;
805 t = ss + Ustrlen(ss);
806 while (t > ss && isspace(t[-1])) t--;
807 if (*ss == '\"' && t[-1] == '\"')
814 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
816 save = store_get(sizeof(config_file_item));
817 save->next = config_file_stack;
818 config_file_stack = save;
819 save->file = config_file;
820 save->filename = config_filename;
821 save->lineno = config_lineno;
823 config_file = Ufopen(ss, "rb");
824 if (config_file == NULL)
825 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
826 "configuration file %s", ss);
827 config_filename = string_copy(ss);
832 /* If this is the start of the logical line, remember where the non-blank
833 data starts. Otherwise shuffle down continuation lines to remove leading
837 startoffset = ss - big_buffer;
840 s = big_buffer + len;
843 memmove(s, ss, (newlen - len) - (ss - s) + 1);
848 /* Accept the new addition to the line. Remove trailing white space. */
851 while (len > 0 && isspace(big_buffer[len-1])) len--;
854 /* We are done if the line does not end in backslash and contains some data.
855 Empty logical lines are ignored. For continuations, remove the backslash and
856 go round the loop to read the continuation line. */
860 if (big_buffer[len-1] != '\\') break; /* End of logical line */
861 big_buffer[--len] = 0; /* Remove backslash */
863 } /* Loop for reading multiple physical lines */
865 /* We now have a logical line. Test for the end of a configuration section (or,
866 more accurately, for the start of the next section). Place the name of the next
867 section in next_section, and return NULL. If the name given is longer than
868 next_section, truncate it. It will be unrecognized later, because all the known
869 section names do fit. Leave space for pluralizing. */
871 s = big_buffer + startoffset; /* First non-space character */
872 if (strncmpic(s, US"begin ", 6) == 0)
875 while (isspace(*s)) s++;
876 if (big_buffer + len - s > sizeof(next_section) - 2)
877 s[sizeof(next_section) - 2] = 0;
878 Ustrcpy(next_section, s);
882 /* Return the first non-blank character. */
889 /*************************************************
891 *************************************************/
893 /* The yield is the pointer to the next uschar. Names longer than the
894 output space are silently truncated. This function is also used from acl.c when
898 name where to put the name
902 Returns: new input pointer
906 readconf_readname(uschar *name, int len, uschar *s)
909 while (isspace(*s)) s++;
912 while (isalnum(*s) || *s == '_')
914 if (p < len-1) name[p++] = *s;
919 while (isspace(*s)) s++;
926 /*************************************************
927 * Read a time value *
928 *************************************************/
930 /* This function is also called from outside, to read argument
931 time values. The format of a time value is:
933 [<n>w][<n>d][<n>h][<n>m][<n>s]
935 as long as at least one is present. If a format error is encountered,
936 return a negative value. The value must be terminated by the given
941 terminator required terminating character
942 return_msec if TRUE, allow fractional seconds and return milliseconds
944 Returns: the time value, or -1 on syntax error
945 value is seconds if return_msec is FALSE
946 value is milliseconds if return_msec is TRUE
950 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
958 if (!isdigit(*s)) return -1;
959 (void)sscanf(CS s, "%d%n", &value, &count);
964 case 'w': value *= 7;
965 case 'd': value *= 24;
966 case 'h': value *= 60;
967 case 'm': value *= 60;
972 if (!return_msec) return -1;
973 (void)sscanf(CS s, "%lf%n", &fraction, &count);
975 if (*s++ != 's') return -1;
976 yield += (int)(fraction * 1000.0);
982 if (return_msec) value *= 1000;
984 if (*s == terminator) return yield;
986 /* Control never reaches here. */
991 /*************************************************
992 * Read a fixed point value *
993 *************************************************/
995 /* The value is returned *1000
999 terminator required terminator
1001 Returns: the value, or -1 on error
1005 readconf_readfixed(uschar *s, int terminator)
1009 if (!isdigit(*s)) return -1;
1010 (void)sscanf(CS s, "%d%n", &value, &count);
1012 yield = value * 1000;
1016 while (isdigit((*(++s))))
1018 yield += (*s - '0') * m;
1023 return (*s == terminator)? yield : (-1);
1028 /*************************************************
1029 * Find option in list *
1030 *************************************************/
1032 /* The lists are always in order, so binary chop can be used.
1035 name the option name to search for
1036 ol the first entry in the option list
1037 last one more than the offset of the last entry in the option list
1039 Returns: pointer to an option entry, or NULL if not found
1043 find_option(uschar *name, optionlist *ol, int last)
1046 while (last > first)
1048 int middle = (first + last)/2;
1049 int c = Ustrcmp(name, ol[middle].name);
1050 if (c == 0) return ol + middle;
1051 else if (c > 0) first = middle + 1;
1059 /*************************************************
1060 * Find a set flag in option list *
1061 *************************************************/
1063 /* Because some versions of Unix make no restrictions on the values of uids and
1064 gids (even negative ones), we cannot represent "unset" by a special value.
1065 There is therefore a separate boolean variable for each one indicating whether
1066 a value is set or not. This function returns a pointer to the boolean, given
1067 the original option name. It is a major disaster if the flag cannot be found.
1070 name the name of the uid or gid option
1071 oltop points to the start of the relevant option list
1072 last one more than the offset of the last item in the option list
1073 data_block NULL when reading main options => data values in the option
1074 list are absolute addresses; otherwise they are byte offsets
1075 in data_block (used for driver options)
1077 Returns: a pointer to the boolean flag.
1081 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1085 sprintf(CS name2, "*set_%.50s", name);
1086 ol = find_option(name2, oltop, last);
1087 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1088 "Exim internal error: missing set flag for %s", name);
1089 return (data_block == NULL)? (BOOL *)(ol->value) :
1090 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1096 /*************************************************
1097 * Output extra characters message and die *
1098 *************************************************/
1100 /* Called when an option line has junk on the end. Sometimes this is because
1101 the sysadmin thinks comments are permitted.
1104 s points to the extra characters
1105 t1..t3 strings to insert in the log message
1107 Returns: doesn't return; dies
1111 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1113 uschar *comment = US"";
1114 if (*s == '#') comment = US" (# is comment only at line start)";
1115 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1116 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1121 /*************************************************
1122 * Read rewrite information *
1123 *************************************************/
1125 /* Each line of rewrite information contains:
1127 . A complete address in the form user@domain, possibly with
1128 leading * for each part; or alternatively, a regex.
1130 . A replacement string (which will be expanded).
1132 . An optional sequence of one-letter flags, indicating which
1133 headers etc. to apply this rule to.
1135 All this is decoded and placed into a control block. The OR of the flags is
1136 maintained in a common word.
1139 p points to the string that makes up the rule
1140 existflags points to the overall flag word
1141 isglobal TRUE if reading global rewrite rules
1143 Returns: the control block for the parsed rule.
1146 static rewrite_rule *
1147 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1149 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1152 next->key = string_dequote(&p);
1154 while (isspace(*p)) p++;
1156 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1157 "missing rewrite replacement string");
1160 next->replacement = string_dequote(&p);
1162 while (*p != 0) switch (*p++)
1164 case ' ': case '\t': break;
1166 case 'q': next->flags |= rewrite_quit; break;
1167 case 'w': next->flags |= rewrite_whole; break;
1169 case 'h': next->flags |= rewrite_all_headers; break;
1170 case 's': next->flags |= rewrite_sender; break;
1171 case 'f': next->flags |= rewrite_from; break;
1172 case 't': next->flags |= rewrite_to; break;
1173 case 'c': next->flags |= rewrite_cc; break;
1174 case 'b': next->flags |= rewrite_bcc; break;
1175 case 'r': next->flags |= rewrite_replyto; break;
1177 case 'E': next->flags |= rewrite_all_envelope; break;
1178 case 'F': next->flags |= rewrite_envfrom; break;
1179 case 'T': next->flags |= rewrite_envto; break;
1181 case 'Q': next->flags |= rewrite_qualify; break;
1182 case 'R': next->flags |= rewrite_repeat; break;
1185 next->flags |= rewrite_smtp;
1186 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1187 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1188 "rewrite rule has the S flag but is not a regular expression");
1192 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1193 "unknown rewrite flag character '%c' "
1194 "(could be missing quotes round replacement item)", p[-1]);
1198 /* If no action flags are set, set all the "normal" rewrites. */
1200 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1201 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1203 /* Remember which exist, for optimization, and return the rule */
1205 *existflags |= next->flags;
1212 /*************************************************
1213 * Read global rewrite information *
1214 *************************************************/
1216 /* Each line is a single rewrite rule; it is parsed into a control block
1217 by readconf_one_rewrite(), and its flags are ORed into the global flag
1218 word rewrite_existflags. */
1221 readconf_rewrites(void)
1223 rewrite_rule **chain = &global_rewrite_rules;
1226 while ((p = get_config_line()) != NULL)
1228 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1230 chain = &(next->next);
1236 /*************************************************
1238 *************************************************/
1240 /* Strings are read into the normal store pool. As long we aren't too
1241 near the end of the current block, the string will just use what is necessary
1242 on the top of the stacking pool, because string_cat() uses the extension
1246 s the rest of the input line
1247 name the option name (for errors)
1249 Returns: pointer to the string
1253 read_string(uschar *s, uschar *name)
1258 if (*s != '\"') return string_copy(s);
1261 yield = string_dequote(&s);
1263 if (s == ss+1 || s[-1] != '\"')
1264 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1265 "missing quote at end of string value for %s", name);
1267 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1273 /*************************************************
1274 * Handle option line *
1275 *************************************************/
1277 /* This function is called from several places to process a line containing the
1278 setting of an option. The first argument is the line to be decoded; it has been
1279 checked not to be empty and not to start with '#'. Trailing newlines and white
1280 space have been removed. The second argument is a pointer to the list of
1281 variable names that are to be recognized, together with their types and
1282 locations, and the third argument gives the number of entries in the list.
1284 The fourth argument is a pointer to a data block. If it is NULL, then the data
1285 values in the options list are absolute addresses. Otherwise, they are byte
1286 offsets in the data block.
1288 String option data may continue onto several lines; this function reads further
1289 data from config_file if necessary.
1291 The yield of this function is normally zero. If a string continues onto
1292 multiple lines, then the data value is permitted to be followed by a comma
1293 or a semicolon (for use in drivers) and the yield is that character.
1296 buffer contains the configuration line to be handled
1297 oltop points to the start of the relevant option list
1298 last one more than the offset of the last item in the option list
1299 data_block NULL when reading main options => data values in the option
1300 list are absolute addresses; otherwise they are byte offsets
1301 in data_block when they have opt_public set; otherwise
1302 they are byte offsets in data_block->options_block.
1303 unknown_txt format string to use in panic message for unknown option;
1304 must contain %s for option name
1305 if given as NULL, don't panic on unknown option
1307 Returns: TRUE if an option was read successfully,
1308 FALSE false for an unknown option if unknown_txt == NULL,
1309 otherwise panic and die on an unknown option
1313 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1314 void *data_block, uschar *unknown_txt)
1318 int n, count, type, value;
1322 BOOL boolvalue = TRUE;
1323 BOOL freesptr = TRUE;
1324 optionlist *ol, *ol2;
1328 uschar *inttype = US"";
1334 /* There may be leading spaces; thereafter, we expect an option name starting
1337 while (isspace(*s)) s++;
1339 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1341 /* Read the name of the option, and skip any subsequent white space. If
1342 it turns out that what we read was "hide", set the flag indicating that
1343 this is a secure option, and loop to read the next word. */
1345 for (n = 0; n < 2; n++)
1347 while (isalnum(*s) || *s == '_')
1349 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1353 while (isspace(*s)) s++;
1354 if (Ustrcmp(name, "hide") != 0) break;
1355 issecure = opt_secure;
1359 /* Deal with "no_" or "not_" here for booleans */
1361 if (Ustrncmp(name, "no_", 3) == 0)
1367 if (Ustrncmp(name, "not_", 4) == 0)
1373 /* Search the list for the given name. A non-existent name, or an option that
1374 is set twice, is a disaster. */
1376 ol = find_option(name + offset, oltop, last);
1380 if (unknown_txt == NULL) return FALSE;
1381 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1384 if ((ol->type & opt_set) != 0)
1386 uschar *mname = name;
1387 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1388 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1389 "\"%s\" option set for the second time", mname);
1392 ol->type |= opt_set | issecure;
1393 type = ol->type & opt_mask;
1395 /* Types with data values must be followed by '='; the "no[t]_" prefix
1396 applies only to boolean values. */
1398 if (type < opt_bool || type > opt_bool_last)
1401 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1402 "negation prefix applied to a non-boolean option");
1404 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1405 "unexpected end of line (data missing) after %s", name);
1407 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1410 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1411 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1412 ultimately expands to one of those values. */
1414 else if (*s != 0 && (offset != 0 || *s != '='))
1415 extra_chars_error(s, US"boolean option ", name, US"");
1417 /* Skip white space after = */
1419 if (*s == '=') while (isspace((*(++s))));
1421 /* If there is a data block and the opt_public flag is not set, change
1422 the data block pointer to the private options block. */
1424 if (data_block != NULL && (ol->type & opt_public) == 0)
1425 data_block = (void *)(((driver_instance *)data_block)->options_block);
1427 /* Now get the data according to the type. */
1431 /* If a string value is not enclosed in quotes, it consists of
1432 the rest of the current line, verbatim. Otherwise, string escapes
1435 A transport is specified as a string, which is then looked up in the
1436 list of transports. A search type is specified as one of a number of
1439 A set or rewrite rules for a driver is specified as a string, which is
1440 then parsed into a suitable chain of control blocks.
1442 Uids and gids are specified as strings which are then looked up in the
1443 passwd file. Lists of uids and gids are similarly specified as colon-
1444 separated strings. */
1449 case opt_expand_uid:
1450 case opt_expand_gid:
1455 reset_point = sptr = read_string(s, name);
1457 /* Having read a string, we now have several different ways of using it,
1458 depending on the data type, so do another switch. If keeping the actual
1459 string is not required (because it is interpreted), freesptr is set TRUE,
1460 and at the end we reset the pool. */
1464 /* If this was a string, set the variable to point to the new string,
1465 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1466 rules, we still keep the string (for printing), and parse the rules into a
1467 control block and flags word. */
1471 if (data_block == NULL)
1472 *((uschar **)(ol->value)) = sptr;
1474 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1476 if (type == opt_rewrite)
1481 rewrite_rule **chain;
1484 sprintf(CS name2, "*%.50s_rules", name);
1485 ol2 = find_option(name2, oltop, last);
1486 sprintf(CS name2, "*%.50s_flags", name);
1487 ol3 = find_option(name2, oltop, last);
1489 if (ol2 == NULL || ol3 == NULL)
1490 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1491 "rewrite rules not available for driver");
1493 if (data_block == NULL)
1495 chain = (rewrite_rule **)(ol2->value);
1496 flagptr = (int *)(ol3->value);
1500 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1501 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1504 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1507 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1509 chain = &(next->next);
1512 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1513 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1514 "non-header rewrite - not allowed at transport time -");
1518 /* If it was an expanded uid, see if there is any expansion to be
1519 done by checking for the presence of a $ character. If there is, save it
1520 in the corresponding *expand_user option field. Otherwise, fall through
1521 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1524 case opt_expand_uid:
1525 sprintf(CS name2, "*expand_%.50s", name);
1526 ol2 = find_option(name2, oltop, last);
1529 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1531 if (data_block == NULL)
1532 *((uschar **)(ol2->value)) = ss;
1534 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1538 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1544 /* Look up a fixed uid, and also make use of the corresponding gid
1545 if a passwd entry is returned and the gid has not been set. */
1548 if (!route_finduser(sptr, &pw, &uid))
1549 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1550 if (data_block == NULL)
1551 *((uid_t *)(ol->value)) = uid;
1553 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1555 /* Set the flag indicating a fixed value is set */
1557 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1559 /* Handle matching gid if we have a passwd entry: done by finding the
1560 same name with terminating "user" changed to "group"; if not found,
1561 ignore. Also ignore if the value is already set. */
1563 if (pw == NULL) break;
1564 Ustrcpy(name+Ustrlen(name)-4, "group");
1565 ol2 = find_option(name, oltop, last);
1566 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1567 (ol2->type & opt_mask) == opt_expand_gid))
1569 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1572 if (data_block == NULL)
1573 *((gid_t *)(ol2->value)) = pw->pw_gid;
1575 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1581 /* If it was an expanded gid, see if there is any expansion to be
1582 done by checking for the presence of a $ character. If there is, save it
1583 in the corresponding *expand_user option field. Otherwise, fall through
1584 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1587 case opt_expand_gid:
1588 sprintf(CS name2, "*expand_%.50s", name);
1589 ol2 = find_option(name2, oltop, last);
1592 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1594 if (data_block == NULL)
1595 *((uschar **)(ol2->value)) = ss;
1597 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1601 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1607 /* Handle freestanding gid */
1610 if (!route_findgroup(sptr, &gid))
1611 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1612 if (data_block == NULL)
1613 *((gid_t *)(ol->value)) = gid;
1615 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1616 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1619 /* If it was a uid list, look up each individual entry, and build
1620 a vector of uids, with a count in the first element. Put the vector
1621 in malloc store so we can free the string. (We are reading into
1622 permanent store already.) */
1630 uschar *op = expand_string (sptr);
1633 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1634 name, expand_string_message);
1637 if (*p != 0) count++;
1638 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1639 list = store_malloc(count*sizeof(uid_t));
1640 list[ptr++] = (uid_t)(count - 1);
1642 if (data_block == NULL)
1643 *((uid_t **)(ol->value)) = list;
1645 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1651 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1652 if (!route_finduser(big_buffer, NULL, &uid))
1653 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1660 /* If it was a gid list, look up each individual entry, and build
1661 a vector of gids, with a count in the first element. Put the vector
1662 in malloc store so we can free the string. (We are reading into permanent
1671 uschar *op = expand_string (sptr);
1674 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1675 name, expand_string_message);
1678 if (*p != 0) count++;
1679 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1680 list = store_malloc(count*sizeof(gid_t));
1681 list[ptr++] = (gid_t)(count - 1);
1683 if (data_block == NULL)
1684 *((gid_t **)(ol->value)) = list;
1686 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1692 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1693 if (!route_findgroup(big_buffer, &gid))
1694 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1702 /* Release store if the value of the string doesn't need to be kept. */
1704 if (freesptr) store_reset(reset_point);
1707 /* Expanded boolean: if no characters follow, or if there are no dollar
1708 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1709 save the string for later expansion in the alternate place. */
1711 case opt_expand_bool:
1712 if (*s != 0 && Ustrchr(s, '$') != 0)
1714 sprintf(CS name2, "*expand_%.50s", name);
1715 ol2 = find_option(name2, oltop, last);
1718 reset_point = sptr = read_string(s, name);
1719 if (data_block == NULL)
1720 *((uschar **)(ol2->value)) = sptr;
1722 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1729 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1730 look for yes/not/true/false. Some booleans are stored in a single bit in
1731 a single int. There's a special fudge for verify settings; without a suffix
1732 they set both xx_sender and xx_recipient. The table points to the sender
1733 value; search subsequently for the recipient. There's another special case:
1734 opt_bool_set also notes when a boolean has been set. */
1738 case opt_bool_verify:
1742 s = readconf_readname(name2, 64, s);
1743 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1745 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1747 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1748 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1749 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1750 US"for boolean option ", name);
1753 /* Handle single-bit type. */
1755 if (type == opt_bit)
1757 int bit = 1 << ((ol->type >> 16) & 31);
1758 int *ptr = (data_block == NULL)?
1759 (int *)(ol->value) :
1760 (int *)((uschar *)data_block + (long int)ol->value);
1761 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1765 /* Handle full BOOL types */
1767 if (data_block == NULL)
1768 *((BOOL *)(ol->value)) = boolvalue;
1770 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1774 if (type == opt_bool_verify)
1776 sprintf(CS name2, "%.50s_recipient", name + offset);
1777 ol2 = find_option(name2, oltop, last);
1780 if (data_block == NULL)
1781 *((BOOL *)(ol2->value)) = boolvalue;
1783 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1787 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1789 else if (type == opt_bool_set)
1791 sprintf(CS name2, "*set_%.50s", name + offset);
1792 ol2 = find_option(name2, oltop, last);
1795 if (data_block == NULL)
1796 *((BOOL *)(ol2->value)) = TRUE;
1798 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1807 inttype = US"octal ";
1809 /* Integer: a simple(ish) case; allow octal and hex formats, and
1810 suffixes K and M. The different types affect output, not input. */
1817 value = strtol(CS s, CSS &endptr, intbase);
1820 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1823 if (errno != ERANGE)
1825 if (tolower(*endptr) == 'k')
1827 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1831 else if (tolower(*endptr) == 'm')
1833 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1835 else value *= 1024*1024;
1840 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1841 "absolute value of integer \"%s\" is too large (overflow)", s);
1843 while (isspace(*endptr)) endptr++;
1845 extra_chars_error(endptr, inttype, US"integer value for ", name);
1848 if (data_block == NULL)
1849 *((int *)(ol->value)) = value;
1851 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1854 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1861 value = strtol(CS s, CSS &endptr, intbase);
1864 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1867 if (errno != ERANGE)
1869 if (tolower(*endptr) == 'm')
1871 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1875 else if (tolower(*endptr) == 'k')
1881 value = (value + 512)/1024;
1885 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1886 "absolute value of integer \"%s\" is too large (overflow)", s);
1888 while (isspace(*endptr)) endptr++;
1890 extra_chars_error(endptr, inttype, US"integer value for ", name);
1893 if (data_block == NULL)
1894 *((int *)(ol->value)) = value;
1896 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1899 /* Fixed-point number: held to 3 decimal places. */
1902 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1903 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1904 "fixed-point number expected for %s", name);
1906 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1907 "integer \"%s\" is too large (overflow)", s);
1911 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1912 "integer \"%s\" is too large (overflow)", s);
1914 if (s[count] == '.')
1917 while (isdigit(s[++count]))
1919 value += (s[count] - '0') * d;
1924 while (isspace(s[count])) count++;
1927 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1929 if (data_block == NULL)
1930 *((int *)(ol->value)) = value;
1932 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1935 /* There's a special routine to read time values. */
1938 value = readconf_readtime(s, 0, FALSE);
1940 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1942 if (data_block == NULL)
1943 *((int *)(ol->value)) = value;
1945 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1948 /* A time list is a list of colon-separated times, with the first
1949 element holding the size of the list and the second the number of
1955 int *list = (data_block == NULL)?
1956 (int *)(ol->value) :
1957 (int *)((uschar *)data_block + (long int)(ol->value));
1959 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1962 uschar *snext = Ustrchr(s, ':');
1966 while (ss > s && isspace(ss[-1])) ss--;
1969 value = readconf_readtime(s, terminator, FALSE);
1971 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1973 if (count > 1 && value <= list[count])
1974 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1975 "time value out of order for %s", name);
1976 list[count+1] = value;
1977 if (snext == NULL) break;
1979 while (isspace(*s)) s++;
1982 if (count > list[0] - 2)
1983 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1985 if (count > 0 && list[2] == 0) count = 0;
1997 /*************************************************
1998 * Print a time value *
1999 *************************************************/
2002 Argument: a time value in seconds
2003 Returns: pointer to a fixed buffer containing the time as a string,
2004 in readconf_readtime() format
2008 readconf_printtime(int t)
2011 uschar *p = time_buffer;
2022 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2023 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2024 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2025 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2026 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2033 /*************************************************
2034 * Print an individual option value *
2035 *************************************************/
2037 /* This is used by the -bP option, so prints to the standard output.
2038 The entire options list is passed in as an argument, because some options come
2039 in pairs - typically uid/gid settings, which can either be explicit numerical
2040 values, or strings to be expanded later. If the numerical value is unset,
2041 search for "*expand_<name>" to see if there is a string equivalent.
2044 ol option entry, or NULL for an unknown option
2046 options_block NULL for main configuration options; otherwise points to
2047 a driver block; if the option doesn't have opt_public
2048 set, then options_block->options_block is where the item
2050 oltop points to the option list in which ol exists
2051 last one more than the offset of the last entry in optop
2057 print_ol(optionlist *ol, uschar *name, void *options_block,
2058 optionlist *oltop, int last)
2071 printf("%s is not a known option\n", name);
2075 /* Non-admin callers cannot see options that have been flagged secure by the
2078 if (!admin_user && (ol->type & opt_secure) != 0)
2080 printf("%s = <value not displayable>\n", name);
2084 /* Else show the value of the option */
2087 if (options_block != NULL)
2089 if ((ol->type & opt_public) == 0)
2090 options_block = (void *)(((driver_instance *)options_block)->options_block);
2091 value = (void *)((uschar *)options_block + (long int)value);
2094 switch(ol->type & opt_mask)
2097 case opt_rewrite: /* Show the text value */
2098 s = *((uschar **)value);
2099 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2103 printf("%s = %d\n", name, *((int *)value));
2108 int x = *((int *)value);
2109 if (x != 0 && (x & 1023) == 0)
2113 if ((x & 1023) == 0)
2118 printf("%s = %d%c\n", name, x, c);
2120 else printf("%s = %d\n", name, x);
2126 int x = *((int *)value);
2127 if (x == 0) printf("%s = 0\n", name);
2128 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2129 else printf("%s = %dK\n", name, x);
2134 printf("%s = %#o\n", name, *((int *)value));
2137 /* Can be negative only when "unset", in which case integer */
2141 int x = *((int *)value);
2144 if (x < 0) printf("%s =\n", name); else
2146 printf("%s = %d.", name, x/1000);
2159 /* If the numerical value is unset, try for the string value */
2161 case opt_expand_uid:
2162 if (! *get_set_flag(name, oltop, last, options_block))
2164 sprintf(CS name2, "*expand_%.50s", name);
2165 ol2 = find_option(name2, oltop, last);
2168 void *value2 = ol2->value;
2169 if (options_block != NULL)
2170 value2 = (void *)((uschar *)options_block + (long int)value2);
2171 s = *((uschar **)value2);
2172 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2177 /* Else fall through */
2180 if (! *get_set_flag(name, oltop, last, options_block))
2181 printf("%s =\n", name);
2184 pw = getpwuid(*((uid_t *)value));
2186 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2187 else printf("%s = %s\n", name, pw->pw_name);
2191 /* If the numerical value is unset, try for the string value */
2193 case opt_expand_gid:
2194 if (! *get_set_flag(name, oltop, last, options_block))
2196 sprintf(CS name2, "*expand_%.50s", name);
2197 ol2 = find_option(name2, oltop, last);
2198 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2200 void *value2 = ol2->value;
2201 if (options_block != NULL)
2202 value2 = (void *)((uschar *)options_block + (long int)value2);
2203 s = *((uschar **)value2);
2204 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2209 /* Else fall through */
2212 if (! *get_set_flag(name, oltop, last, options_block))
2213 printf("%s =\n", name);
2216 gr = getgrgid(*((int *)value));
2218 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2219 else printf("%s = %s\n", name, gr->gr_name);
2224 uidlist = *((uid_t **)value);
2225 printf("%s =", name);
2226 if (uidlist != NULL)
2230 for (i = 1; i <= (int)(uidlist[0]); i++)
2232 uschar *name = NULL;
2233 pw = getpwuid(uidlist[i]);
2234 if (pw != NULL) name = US pw->pw_name;
2235 if (name != NULL) printf("%c%s", sep, name);
2236 else printf("%c%ld", sep, (long int)(uidlist[i]));
2244 gidlist = *((gid_t **)value);
2245 printf("%s =", name);
2246 if (gidlist != NULL)
2250 for (i = 1; i <= (int)(gidlist[0]); i++)
2252 uschar *name = NULL;
2253 gr = getgrgid(gidlist[i]);
2254 if (gr != NULL) name = US gr->gr_name;
2255 if (name != NULL) printf("%c%s", sep, name);
2256 else printf("%c%ld", sep, (long int)(gidlist[i]));
2264 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2270 int *list = (int *)value;
2271 printf("%s = ", name);
2272 for (i = 0; i < list[1]; i++)
2273 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2279 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2283 case opt_expand_bool:
2284 sprintf(CS name2, "*expand_%.50s", name);
2285 ol2 = find_option(name2, oltop, last);
2286 if (ol2 != NULL && ol2->value != NULL)
2288 void *value2 = ol2->value;
2289 if (options_block != NULL)
2290 value2 = (void *)((uschar *)options_block + (long int)value2);
2291 s = *((uschar **)value2);
2294 printf("%s = %s\n", name, string_printing(s));
2297 /* s == NULL => string not set; fall through */
2303 case opt_bool_verify:
2305 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2312 /*************************************************
2313 * Print value from main configuration *
2314 *************************************************/
2316 /* This function, called as a result of encountering the -bP option,
2317 causes the value of any main configuration variable to be output if the
2318 second argument is NULL. There are some special values:
2320 all print all main configuration options
2321 configure_file print the name of the configuration file
2322 routers print the routers' configurations
2323 transports print the transports' configuration
2324 authenticators print the authenticators' configuration
2325 router_list print a list of router names
2326 transport_list print a list of transport names
2327 authenticator_list print a list of authentication mechanism names
2328 +name print a named list item
2329 local_scan print the local_scan options
2331 If the second argument is not NULL, it must be one of "router", "transport", or
2332 "authenticator" in which case the first argument identifies the driver whose
2333 options are to be printed.
2336 name option name if type == NULL; else driver name
2337 type NULL or driver type name, as described above
2343 readconf_print(uschar *name, uschar *type)
2345 BOOL names_only = FALSE;
2347 optionlist *ol2 = NULL;
2348 driver_instance *d = NULL;
2358 static uschar *types[] = { US"address", US"domain", US"host",
2360 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2361 &hostlist_anchor, &localpartlist_anchor };
2363 for (i = 0; i < 4; i++)
2365 t = tree_search(*(anchors[i]), name+1);
2369 printf("%slist %s = %s\n", types[i], name+1,
2370 ((namedlist_block *)(t->data.ptr))->string);
2375 printf("no address, domain, host, or local part list called \"%s\" "
2376 "exists\n", name+1);
2381 if (Ustrcmp(name, "configure_file") == 0)
2383 printf("%s\n", CS config_main_filename);
2387 if (Ustrcmp(name, "all") == 0)
2389 for (ol = optionlist_config;
2390 ol < optionlist_config + optionlist_config_size; ol++)
2392 if ((ol->type & opt_hidden) == 0)
2393 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2398 if (Ustrcmp(name, "local_scan") == 0)
2400 #ifndef LOCAL_SCAN_HAS_OPTIONS
2401 printf("local_scan() options are not supported\n");
2403 for (ol = local_scan_options;
2404 ol < local_scan_options + local_scan_options_count; ol++)
2406 print_ol(ol, US ol->name, NULL, local_scan_options,
2407 local_scan_options_count);
2413 if (Ustrcmp(name, "routers") == 0)
2418 else if (Ustrcmp(name, "transports") == 0)
2420 type = US"transport";
2424 else if (Ustrcmp(name, "authenticators") == 0)
2426 type = US"authenticator";
2430 else if (Ustrcmp(name, "authenticator_list") == 0)
2432 type = US"authenticator";
2437 else if (Ustrcmp(name, "router_list") == 0)
2443 else if (Ustrcmp(name, "transport_list") == 0)
2445 type = US"transport";
2451 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2452 name, NULL, optionlist_config, optionlist_config_size);
2457 /* Handle the options for a router or transport. Skip options that are flagged
2458 as hidden. Some of these are options with names starting with '*', used for
2459 internal alternative representations of other options (which the printing
2460 function will sort out). Others are synonyms kept for backward compatibility.
2463 if (Ustrcmp(type, "router") == 0)
2465 d = (driver_instance *)routers;
2466 ol2 = optionlist_routers;
2467 size = optionlist_routers_size;
2469 else if (Ustrcmp(type, "transport") == 0)
2471 d = (driver_instance *)transports;
2472 ol2 = optionlist_transports;
2473 size = optionlist_transports_size;
2475 else if (Ustrcmp(type, "authenticator") == 0)
2477 d = (driver_instance *)auths;
2478 ol2 = optionlist_auths;
2479 size = optionlist_auths_size;
2484 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2488 /* Either search for a given driver, or print all of them */
2490 for (; d != NULL; d = d->next)
2493 printf("\n%s %s:\n", d->name, type);
2494 else if (Ustrcmp(d->name, name) != 0) continue;
2496 for (ol = ol2; ol < ol2 + size; ol++)
2498 if ((ol->type & opt_hidden) == 0)
2499 print_ol(ol, US ol->name, d, ol2, size);
2502 for (ol = d->info->options;
2503 ol < d->info->options + *(d->info->options_count); ol++)
2505 if ((ol->type & opt_hidden) == 0)
2506 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2508 if (name != NULL) return;
2510 if (name != NULL) printf("%s %s not found\n", type, name);
2515 /*************************************************
2516 * Read a named list item *
2517 *************************************************/
2519 /* This function reads a name and a list (i.e. string). The name is used to
2520 save the list in a tree, sorted by its name. Each entry also has a number,
2521 which can be used for caching tests, but if the string contains any expansion
2522 items other than $key, the number is set negative to inhibit caching. This
2523 mechanism is used for domain, host, and address lists that are referenced by
2527 anchorp points to the tree anchor
2528 numberp points to the current number for this tree
2529 max the maximum number permitted
2530 s the text of the option line, starting immediately after the name
2532 tname the name of the list type, for messages
2538 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2541 BOOL forcecache = FALSE;
2544 namedlist_block *nb = store_get(sizeof(namedlist_block));
2546 if (Ustrncmp(s, "_cache", 6) == 0)
2553 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2555 if (*numberp >= max)
2556 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2559 while (isspace(*s)) s++;
2561 while (isalnum(*s) || *s == '_') s++;
2562 t = store_get(sizeof(tree_node) + s-ss);
2563 Ustrncpy(t->name, ss, s-ss);
2565 while (isspace(*s)) s++;
2567 if (!tree_insertnode(anchorp, t))
2568 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2569 "duplicate name \"%s\" for a named %s", t->name, tname);
2572 nb->number = *numberp;
2575 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2576 "missing '=' after \"%s\"", t->name);
2577 while (isspace(*s)) s++;
2578 nb->string = read_string(s, t->name);
2579 nb->cache_data = NULL;
2581 /* Check the string for any expansions; if any are found, mark this list
2582 uncacheable unless the user has explicited forced caching. */
2584 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2590 /*************************************************
2591 * Unpick data for a rate limit *
2592 *************************************************/
2594 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2598 s string, in the form t,b,f,l
2599 where t is the threshold (integer)
2600 b is the initial delay (time)
2601 f is the multiplicative factor (fixed point)
2602 k is the maximum time (time)
2603 threshold where to store threshold
2604 base where to store base in milliseconds
2605 factor where to store factor in milliseconds
2606 limit where to store limit
2608 Returns: nothing (panics on error)
2612 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2615 uschar bstring[16], lstring[16];
2617 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2618 factor, lstring) == 4)
2620 *base = readconf_readtime(bstring, 0, TRUE);
2621 *limit = readconf_readtime(lstring, 0, TRUE);
2622 if (*base >= 0 && *limit >= 0) return;
2624 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2630 /*************************************************
2631 * Read main configuration options *
2632 *************************************************/
2634 /* This function is the first to be called for configuration reading. It
2635 opens the configuration file and reads general configuration settings until
2636 it reaches the end of the configuration section. The file is then left open so
2637 that the remaining configuration data can subsequently be read if needed for
2640 The configuration file must be owned either by root or exim, and be writeable
2641 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2642 in the config file, so the test is done on the compiled in values. A slight
2643 anomaly, to be carefully documented.
2645 The name of the configuration file is taken from a list that is included in the
2646 binary of Exim. It can be altered from the command line, but if that is done,
2647 root privilege is immediately withdrawn unless the caller is root or exim.
2648 The first file on the list that exists is used.
2650 For use on multiple systems that share file systems, first look for a
2651 configuration file whose name has the current node name on the end. If that is
2652 not found, try the generic name. For really contorted configurations, that run
2653 multiple Exims with different uid settings, first try adding the effective uid
2654 before the node name. These complications are going to waste resources on most
2655 systems. Therefore they are available only when requested by compile-time
2662 struct stat statbuf;
2663 uschar *s, *filename;
2664 uschar *list = config_main_filelist;
2666 /* Loop through the possible file names */
2668 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2671 /* Cut out all the fancy processing unless specifically wanted */
2673 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2674 uschar *suffix = filename + Ustrlen(filename);
2676 /* Try for the node-specific file if a node name exists */
2678 #ifdef CONFIGURE_FILE_USE_NODE
2680 if (uname(&uts) >= 0)
2682 #ifdef CONFIGURE_FILE_USE_EUID
2683 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2684 config_file = Ufopen(filename, "rb");
2685 if (config_file == NULL)
2686 #endif /* CONFIGURE_FILE_USE_EUID */
2688 sprintf(CS suffix, ".%.256s", uts.nodename);
2689 config_file = Ufopen(filename, "rb");
2692 #endif /* CONFIGURE_FILE_USE_NODE */
2694 /* Otherwise, try the generic name, possibly with the euid added */
2696 #ifdef CONFIGURE_FILE_USE_EUID
2697 if (config_file == NULL)
2699 sprintf(CS suffix, ".%ld", (long int)original_euid);
2700 config_file = Ufopen(filename, "rb");
2702 #endif /* CONFIGURE_FILE_USE_EUID */
2704 /* Finally, try the unadorned name */
2706 if (config_file == NULL)
2709 config_file = Ufopen(filename, "rb");
2711 #else /* if neither defined */
2713 /* This is the common case when the fancy processing is not included. */
2715 config_file = Ufopen(filename, "rb");
2718 /* If the file does not exist, continue to try any others. For any other
2719 error, break out (and die). */
2721 if (config_file != NULL || errno != ENOENT) break;
2724 /* On success, save the name for verification; config_filename is used when
2725 logging configuration errors (it changes for .included files) whereas
2726 config_main_filename is the name shown by -bP. Failure to open a configuration
2727 file is a serious disaster. */
2729 if (config_file != NULL)
2731 config_filename = config_main_filename = string_copy(filename);
2735 if (filename == NULL)
2736 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2737 "%s", config_main_filelist);
2739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2740 "configuration file %s", filename));
2743 /* Check the status of the file we have opened, unless it was specified on
2744 the command line, in which case privilege was given away at the start. */
2746 if (!config_changed)
2748 if (fstat(fileno(config_file), &statbuf) != 0)
2749 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2752 if ((statbuf.st_uid != root_uid && /* owner not root */
2753 statbuf.st_uid != exim_uid /* owner not exim */
2754 #ifdef CONFIGURE_OWNER
2755 && statbuf.st_uid != config_uid /* owner not the special one */
2758 (statbuf.st_gid != exim_gid /* group not exim & */
2759 #ifdef CONFIGURE_GROUP
2760 && statbuf.st_gid != config_gid /* group not the special one */
2762 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2764 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2766 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2767 "wrong owner, group, or mode", big_buffer);
2770 /* Process the main configuration settings. They all begin with a lower case
2771 letter. If we see something starting with an upper case letter, it is taken as
2772 a macro definition. */
2774 while ((s = get_config_line()) != NULL)
2776 if (isupper(s[0])) read_macro_assignment(s);
2778 else if (Ustrncmp(s, "domainlist", 10) == 0)
2779 read_named_list(&domainlist_anchor, &domainlist_count,
2780 MAX_NAMED_LIST, s+10, US"domain list");
2782 else if (Ustrncmp(s, "hostlist", 8) == 0)
2783 read_named_list(&hostlist_anchor, &hostlist_count,
2784 MAX_NAMED_LIST, s+8, US"host list");
2786 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2787 read_named_list(&addresslist_anchor, &addresslist_count,
2788 MAX_NAMED_LIST, s+11, US"address list");
2790 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2791 read_named_list(&localpartlist_anchor, &localpartlist_count,
2792 MAX_NAMED_LIST, s+13, US"local part list");
2795 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2796 NULL, US"main option \"%s\" unknown");
2800 /* If local_sender_retain is set, local_from_check must be unset. */
2802 if (local_sender_retain && local_from_check)
2803 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2804 "local_sender_retain are set; this combination is not allowed");
2806 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2809 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2811 /* remote_max_parallel must be > 0 */
2813 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2815 /* The primary host name may be required for expansion of spool_directory
2816 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2817 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2818 canonize it. Some people like upper case letters in their host names, so we
2819 don't force the case. */
2821 if (primary_hostname == NULL)
2825 if (uname(&uts) < 0)
2826 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2827 hostname = US uts.nodename;
2829 if (Ustrchr(hostname, '.') == NULL)
2832 struct hostent *hostdata;
2835 if (dns_ipv4_lookup == NULL ||
2836 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2846 #if HAVE_GETIPNODEBYNAME
2848 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2850 hostdata = gethostbyname2(CS hostname, af);
2853 hostdata = gethostbyname(CS hostname);
2856 if (hostdata != NULL)
2858 hostname = US hostdata->h_name;
2862 if (af == AF_INET) break;
2867 primary_hostname = string_copy(hostname);
2870 /* Set up default value for smtp_active_hostname */
2872 smtp_active_hostname = primary_hostname;
2874 /* If spool_directory wasn't set in the build-time configuration, it must have
2875 got set above. Of course, writing to the log may not work if log_file_path is
2876 not set, but it will at least get to syslog or somewhere, with any luck. */
2878 if (*spool_directory == 0)
2879 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2882 /* Expand the spool directory name; it may, for example, contain the primary
2883 host name. Same comment about failure. */
2885 s = expand_string(spool_directory);
2887 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2888 "\"%s\": %s", spool_directory, expand_string_message);
2889 spool_directory = s;
2891 /* Expand log_file_path, which must contain "%s" in any component that isn't
2892 the null string or "syslog". It is also allowed to contain one instance of %D.
2893 However, it must NOT contain % followed by anything else. */
2895 if (*log_file_path != 0)
2898 int sep = ':'; /* Fixed for log file path */
2899 s = expand_string(log_file_path);
2901 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2902 "\"%s\": %s", log_file_path, expand_string_message);
2905 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2908 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2909 t = Ustrstr(sss, "%s");
2911 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2912 "contain \"%%s\"", sss);
2914 t = Ustrchr(sss, '%');
2917 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2918 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2919 "unexpected \"%%\" character", s);
2926 /* Interpret syslog_facility into an integer argument for 'ident' param to
2927 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2930 if (syslog_facility_str != NULL)
2933 uschar *s = syslog_facility_str;
2935 if ((Ustrlen(syslog_facility_str) >= 4) &&
2936 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2939 for (i = 0; i < syslog_list_size; i++)
2941 if (strcmpic(s, syslog_list[i].name) == 0)
2943 syslog_facility = syslog_list[i].value;
2948 if (i >= syslog_list_size)
2950 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2951 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2955 /* Expand pid_file_path */
2957 if (*pid_file_path != 0)
2959 s = expand_string(pid_file_path);
2961 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2962 "\"%s\": %s", pid_file_path, expand_string_message);
2966 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2969 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2971 /* Unpick the SMTP rate limiting options, if set */
2973 if (smtp_ratelimit_mail != NULL)
2975 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2976 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
2979 if (smtp_ratelimit_rcpt != NULL)
2981 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
2982 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
2985 /* The qualify domains default to the primary host name */
2987 if (qualify_domain_sender == NULL)
2988 qualify_domain_sender = primary_hostname;
2989 if (qualify_domain_recipient == NULL)
2990 qualify_domain_recipient = qualify_domain_sender;
2992 /* Setting system_filter_user in the configuration sets the gid as well if a
2993 name is given, but a numerical value does not. */
2995 if (system_filter_uid_set && !system_filter_gid_set)
2997 struct passwd *pw = getpwuid(system_filter_uid);
2999 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3000 (long int)system_filter_uid);
3001 system_filter_gid = pw->pw_gid;
3002 system_filter_gid_set = TRUE;
3005 /* If the errors_reply_to field is set, check that it is syntactically valid
3006 and ensure it contains a domain. */
3008 if (errors_reply_to != NULL)
3011 int start, end, domain;
3012 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3013 &start, &end, &domain, FALSE);
3015 if (recipient == NULL)
3016 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3017 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3020 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3021 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3024 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3025 smtp_accept_max must also be set. */
3027 if (smtp_accept_max == 0 &&
3028 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3029 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3030 "smtp_accept_max must be set if smtp_accept_queue or "
3031 "smtp_accept_max_per_host is set");
3033 /* Set up the host number if anything is specified. It is an expanded string
3034 so that it can be computed from the host name, for example. We do this last
3035 so as to ensure that everything else is set up before the expansion. */
3037 if (host_number_string != NULL)
3040 uschar *s = expand_string(host_number_string);
3041 long int n = Ustrtol(s, &end, 0);
3042 while (isspace(*end)) end++;
3044 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3045 "localhost_number value is not a number: %s", s);
3046 if (n > LOCALHOST_MAX)
3047 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3048 "localhost_number is greater than the maximum allowed value (%d)",
3054 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3056 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3057 tls_verify_certificates == NULL)
3058 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3059 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3060 (tls_verify_hosts != NULL)? "" : "try_");
3066 /*************************************************
3067 * Initialize one driver *
3068 *************************************************/
3070 /* This is called once the driver's generic options, if any, have been read.
3071 We can now find the driver, set up defaults for the private options, and
3072 unset any "set" bits in the private options table (which might have been
3073 set by another incarnation of the same driver).
3076 d pointer to driver instance block, with generic
3078 drivers_available vector of available drivers
3079 size_of_info size of each block in drivers_available
3080 class class of driver, for error message
3082 Returns: pointer to the driver info block
3085 static driver_info *
3086 init_driver(driver_instance *d, driver_info *drivers_available,
3087 int size_of_info, uschar *class)
3091 for (dd = drivers_available; dd->driver_name[0] != 0;
3092 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3094 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3097 int len = dd->options_len;
3099 d->options_block = store_get(len);
3100 memcpy(d->options_block, dd->options_block, len);
3101 for (i = 0; i < *(dd->options_count); i++)
3102 dd->options[i].type &= ~opt_set;
3107 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3108 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3110 return NULL; /* never obeyed */
3116 /*************************************************
3117 * Initialize driver list *
3118 *************************************************/
3120 /* This function is called for routers, transports, and authentication
3121 mechanisms. It reads the data from the current point in the configuration file
3122 up to the end of the section, and sets up a chain of instance blocks according
3123 to the file's contents. The file will already have been opened by a call to
3124 readconf_main, and must be left open for subsequent reading of further data.
3126 Any errors cause a panic crash. Note that the blocks with names driver_info and
3127 driver_instance must map the first portions of all the _info and _instance
3128 blocks for this shared code to work.
3131 class "router", "transport", or "authenticator"
3132 anchor &routers, &transports, &auths
3133 drivers_available available drivers
3134 size_of_info size of each info block
3135 instance_default points to default data for an instance
3136 instance_size size of instance block
3137 driver_optionlist generic option list
3138 driver_optionlist_count count of generic option list
3144 readconf_driver_init(
3146 driver_instance **anchor,
3147 driver_info *drivers_available,
3149 void *instance_default,
3151 optionlist *driver_optionlist,
3152 int driver_optionlist_count)
3154 driver_instance **p = anchor;
3155 driver_instance *d = NULL;
3158 while ((buffer = get_config_line()) != NULL)
3163 /* Read the first name on the line and test for the start of a new driver. A
3164 macro definition indicates the end of the previous driver. If this isn't the
3165 start of a new driver, the line will be re-read. */
3167 s = readconf_readname(name, sizeof(name), buffer);
3169 /* Handle macro definition, first finishing off the initialization of the
3170 previous driver, if any. */
3172 if (isupper(*name) && *s == '=')
3176 if (d->driver_name == NULL)
3177 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3178 "no driver defined for %s \"%s\"", class, d->name);
3182 read_macro_assignment(buffer);
3186 /* If the line starts with a name terminated by a colon, we are at the
3187 start of the definition of a new driver. The rest of the line must be
3194 /* Finish off initializing the previous driver. */
3198 if (d->driver_name == NULL)
3199 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3200 "no driver defined for %s \"%s\"", class, d->name);
3204 /* Check that we haven't already got a driver of this name */
3206 for (d = *anchor; d != NULL; d = d->next)
3207 if (Ustrcmp(name, d->name) == 0)
3208 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3209 "there are two %ss called \"%s\"", class, name);
3211 /* Set up a new driver instance data block on the chain, with
3212 its default values installed. */
3214 d = store_get(instance_size);
3215 memcpy(d, instance_default, instance_size);
3218 d->name = string_copy(name);
3220 /* Clear out the "set" bits in the generic options */
3222 for (i = 0; i < driver_optionlist_count; i++)
3223 driver_optionlist[i].type &= ~opt_set;
3225 /* Check nothing more on this line, then do the next loop iteration. */
3227 while (isspace(*s)) s++;
3228 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3232 /* Not the start of a new driver. Give an error if we have not set up a
3233 current driver yet. */
3235 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3236 "%s name missing", class);
3238 /* First look to see if this is a generic option; if it is "driver",
3239 initialize the driver. If is it not a generic option, we can look for a
3240 private option provided that the driver has been previously set up. */
3242 if (readconf_handle_option(buffer, driver_optionlist,
3243 driver_optionlist_count, d, NULL))
3245 if (d->info == NULL && d->driver_name != NULL)
3246 init_driver(d, drivers_available, size_of_info, class);
3249 /* Handle private options - pass the generic block because some may
3250 live therein. A flag with each option indicates if it is in the public
3253 else if (d->info != NULL)
3255 readconf_handle_option(buffer, d->info->options,
3256 *(d->info->options_count), d, US"option \"%s\" unknown");
3259 /* The option is not generic and the driver name has not yet been given. */
3261 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3262 "(\"driver\" must be specified before any private options)", name);
3265 /* Run the initialization function for the final driver. */
3269 if (d->driver_name == NULL)
3270 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3271 "no driver defined for %s \"%s\"", class, d->name);
3278 /*************************************************
3279 * Check driver dependency *
3280 *************************************************/
3282 /* This function is passed a driver instance and a string. It checks whether
3283 any of the string options for the driver contains the given string as an
3287 d points to a driver instance block
3288 s the string to search for
3290 Returns: TRUE if a dependency is found
3294 readconf_depends(driver_instance *d, uschar *s)
3296 int count = *(d->info->options_count);
3300 for (ol = d->info->options; ol < d->info->options + count; ol++)
3302 void *options_block;
3304 int type = ol->type & opt_mask;
3305 if (type != opt_stringptr) continue;
3306 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3307 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3308 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3310 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3311 isalnum(ss[Ustrlen(s)])) continue;
3312 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3313 d->name, ol->name, s);
3318 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3325 /*************************************************
3326 * Decode an error type for retries *
3327 *************************************************/
3329 /* This function is global because it is also called from the main
3330 program when testing retry information. It decodes strings such as "quota_7d"
3331 into numerical error codes.
3334 pp points to start of text
3335 p points past end of text
3336 basic_errno points to an int to receive the main error number
3337 more_errno points to an int to receive the secondary error data
3339 Returns: NULL if decoded correctly; else points to error text
3343 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3347 while (q < p && *q != '_') q++;
3350 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3352 *basic_errno = ERRNO_EXIMQUOTA;
3353 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3354 return US"bad time value";
3357 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3359 *basic_errno = ECONNREFUSED;
3362 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3363 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3364 else return US"A or MX expected after \"refused\"";
3368 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3370 *basic_errno = ETIMEDOUT;
3374 int xlen = p - q - 1;
3377 static uschar *extras[] =
3378 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3379 static int values[] =
3380 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3382 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3384 if (strncmpic(x, extras[i], xlen) == 0)
3386 *more_errno = values[i];
3391 if (i >= sizeof(extras)/sizeof(uschar *))
3393 if (strncmpic(x, US"DNS", xlen) == 0)
3395 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3396 "available in retry rules (it has never worked) - treated as "
3399 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3404 else if (strncmpic(pp, US"rcpt_4", 6) == 0)
3407 int x = 255; /* means "any 4xx code" */
3408 if (p != pp + 8) bad = TRUE; else
3410 int a = pp[6], b = pp[7];
3414 if (isdigit(b)) x += b - '0';
3415 else if (b == 'x') x += 100;
3418 else if (a != 'x' || b != 'x') bad = TRUE;
3421 if (bad) return US"rcpt_4 must be followed by xx, dx, or dd, where "
3422 "x is literal and d is any digit";
3424 *basic_errno = ERRNO_RCPT4XX;
3425 *more_errno = x << 8;
3428 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3429 strncmpic(q+1, US"failed", p-q-1) == 0)
3431 *basic_errno = ERRNO_AUTHFAIL;
3434 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3435 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3443 /*************************************************
3444 * Read retry information *
3445 *************************************************/
3447 /* Each line of retry information contains:
3449 . A domain name pattern or an address pattern;
3451 . An error name, possibly with additional data, or *;
3453 . An optional sequence of retry items, each consisting of an identifying
3454 letter, a cutoff time, and optional parameters.
3456 All this is decoded and placed into a control block. */
3459 /* Subroutine to read an argument, preceded by a comma and terminated
3460 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3461 1 = fixed point number (returned *1000).
3464 paddr pointer to pointer to current character; updated
3465 type 0 => read a time; 1 => read a fixed point number
3467 Returns: time in seconds or fixed point number * 1000
3471 retry_arg(uschar **paddr, int type)
3476 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3478 while (isspace(*p)) p++;
3480 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3482 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3483 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3489 return readconf_readtime(pp, *p, FALSE);
3491 return readconf_readfixed(pp, *p);
3493 return 0; /* Keep picky compilers happy */
3496 /* The function proper */
3499 readconf_retries(void)
3501 retry_config **chain = &retries;
3505 while ((p = get_config_line()) != NULL)
3507 retry_rule **rchain;
3510 next = store_get(sizeof(retry_config));
3513 chain = &(next->next);
3514 next->basic_errno = next->more_errno = 0;
3515 next->senders = NULL;
3517 rchain = &(next->rules);
3519 next->pattern = string_dequote(&p);
3520 while (isspace(*p)) p++;
3522 while (mac_isgraph(*p)) p++;
3523 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3524 "missing error type");
3526 /* Test error names for things we understand. */
3528 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3529 &(next->more_errno))) != NULL)
3530 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3532 /* There may be an optional address list of senders to be used as another
3533 constraint on the rule. This was added later, so the syntax is a bit of a
3534 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3537 while (isspace(*p)) p++;
3538 if (Ustrncmp(p, "senders", 7) == 0)
3541 while (isspace(*p)) p++;
3542 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3543 "\"=\" expected after \"senders\" in retry rule");
3544 while (isspace(*p)) p++;
3545 next->senders = string_dequote(&p);
3548 /* Now the retry rules. Keep the maximum timeout encountered. */
3550 while (isspace(*p)) p++;
3554 retry_rule *rule = store_get(sizeof(retry_rule));
3556 rchain = &(rule->next);
3558 rule->rule = toupper(*p++);
3559 rule->timeout = retry_arg(&p, 0);
3560 if (rule->timeout > retry_maximum_timeout)
3561 retry_maximum_timeout = rule->timeout;
3565 case 'F': /* Fixed interval */
3566 rule->p1 = retry_arg(&p, 0);
3569 case 'G': /* Geometrically increasing intervals */
3570 case 'H': /* Ditto, but with randomness */
3571 rule->p1 = retry_arg(&p, 0);
3572 rule->p2 = retry_arg(&p, 1);
3576 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3580 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3581 (rule->rule != 'F' && rule->p2 < 1000))
3582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3583 "bad parameters for retry rule");
3585 while (isspace(*p)) p++;
3589 while (isspace(*p)) p++;
3592 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3599 /*************************************************
3600 * Initialize authenticators *
3601 *************************************************/
3603 /* Read the authenticators section of the configuration file.
3612 auth_instance *au, *bu;
3613 readconf_driver_init(US"authenticator",
3614 (driver_instance **)(&auths), /* chain anchor */
3615 (driver_info *)auths_available, /* available drivers */
3616 sizeof(auth_info), /* size of info block */
3617 &auth_defaults, /* default values for generic options */
3618 sizeof(auth_instance), /* size of instance block */
3619 optionlist_auths, /* generic options */
3620 optionlist_auths_size);
3622 for (au = auths; au != NULL; au = au->next)
3624 if (au->public_name == NULL)
3625 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3626 "the %s authenticator", au->name);
3627 for (bu = au->next; bu != NULL; bu = bu->next)
3629 if (strcmpic(au->public_name, bu->public_name) == 0)
3631 if ((au->client && bu->client) || (au->server && bu->server))
3632 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3633 "(%s and %s) have the same public name (%s)",
3634 (au->client)? US"client" : US"server", au->name, bu->name,
3644 /*************************************************
3645 * Read ACL information *
3646 *************************************************/
3648 /* If this run of Exim is not doing something that involves receiving a
3649 message, we can just skip over the ACL information. No need to parse it.
3651 First, we have a function for acl_read() to call back to get the next line. We
3652 need to remember the line we passed, because at the end it will contain the
3653 name of the next ACL. */
3655 static uschar *acl_line;
3660 acl_line = get_config_line();
3665 /* Now the main function:
3668 skip TRUE when this Exim process is doing something that will
3669 not need the ACL data
3675 readconf_acl(BOOL skip)
3679 /* Not receiving messages, don't need to parse the ACL data */
3683 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3684 while ((p = get_config_line()) != NULL);
3688 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3691 acl_line = get_config_line();
3693 while(acl_line != NULL)
3699 p = readconf_readname(name, sizeof(name), acl_line);
3700 if (isupper(*name) && *p == '=')
3702 read_macro_assignment(acl_line);
3703 acl_line = get_config_line();
3707 if (*p != ':' || name[0] == 0)
3708 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3710 node = store_get(sizeof(tree_node) + Ustrlen(name));
3711 Ustrcpy(node->name, name);
3712 if (!tree_insertnode(&acl_anchor, node))
3713 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3714 "there are two ACLs called \"%s\"", name);
3716 node->data.ptr = acl_read(acl_callback, &error);
3718 if (node->data.ptr == NULL && error != NULL)
3719 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3725 /*************************************************
3726 * Read configuration for local_scan() *
3727 *************************************************/
3729 /* This function is called after "begin local_scan" is encountered in the
3730 configuration file. If the local_scan() function allows for configuration
3731 options, we can process them. Otherwise, we expire in a panic.
3738 local_scan_init(void)
3740 #ifndef LOCAL_SCAN_HAS_OPTIONS
3741 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3742 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3746 while ((p = get_config_line()) != NULL)
3748 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3749 NULL, US"local_scan option \"%s\" unknown");
3756 /*************************************************
3757 * Read rest of configuration (after main) *
3758 *************************************************/
3760 /* This function reads the rest of the runtime configuration, after the main
3761 configuration. It is called only when actually needed. Each subsequent section
3762 of the configuration starts with a line of the form
3766 where the name is "routers", "transports", etc. A section is terminated by
3767 hitting the next "begin" line, and the next name is left in next_section.
3768 Because it may confuse people as to whether the names are singular or plural,
3769 we add "s" if it's missing. There is always enough room in next_section for
3770 this. This function is basically just a switch.
3773 skip_acl TRUE if ACL information is not needed
3778 static uschar *section_list[] = {
3788 readconf_rest(BOOL skip_acl)
3792 while(next_section[0] != 0)
3796 int last = sizeof(section_list) / sizeof(uschar *);
3798 int n = Ustrlen(next_section);
3800 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3804 int c = strcmpic(next_section, section_list[mid]);
3806 if (c > 0) first = mid + 1; else last = mid;
3808 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3809 "\"%.*s\" is not a known configuration section name", n, next_section);
3810 mid = (last + first)/2;
3814 if (((had ^= bit) & bit) == 0)
3815 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3816 "\"%.*s\" section is repeated in the configuration file", n,
3821 case 0: readconf_acl(skip_acl); break;
3822 case 1: auths_init(); break;
3823 case 2: local_scan_init(); break;
3824 case 3: readconf_retries(); break;
3825 case 4: readconf_rewrites(); break;
3826 case 5: route_init(); break;
3827 case 6: transport_init(); break;
3831 (void)fclose(config_file);
3834 /* End of readconf.c */