1 /* $Cambridge: exim/src/src/readconf.c,v 1.23 2006/06/28 16:00:24 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for reading the configuration file, and for displaying
11 overall configuration values. Thanks to Brian Candler for the original
12 implementation of the conditional .ifdef etc. */
16 #define CSTATE_STACK_SIZE 10
19 /* Structure for chain (stack) of .included files */
21 typedef struct config_file_item {
22 struct config_file_item *next;
28 /* Structure of table of conditional words and their state transitions */
30 typedef struct cond_item {
38 /* Structure of table of syslog facility names and values */
40 typedef struct syslog_fac_item {
46 /* Static variables */
48 static config_file_item *config_file_stack = NULL; /* For includes */
50 static uschar *syslog_facility_str = NULL;
51 static uschar next_section[24];
52 static uschar time_buffer[24];
54 /* State variables for conditional loading (.ifdef / .else / .endif) */
56 static int cstate = 0;
57 static int cstate_stack_ptr = -1;
58 static int cstate_stack[CSTATE_STACK_SIZE];
60 /* Table of state transitions for handling conditional inclusions. There are
61 four possible state transitions:
65 .elifdef true (or .else)
68 .endif just causes the previous cstate to be popped off the stack */
70 static int next_cstate[3][4] =
72 /* State 0: reading from file, or reading until next .else or .endif */
74 /* State 1: condition failed, skipping until next .else or .endif */
76 /* State 2: skipping until .endif */
80 /* Table of conditionals and the states to set. For each name, there are four
81 values: the length of the name (to save computing it each time), the state to
82 set if a macro was found in the line, the state to set if a macro was not found
83 in the line, and a stack manipulation setting which is:
85 -1 pull state value off the stack
86 0 don't alter the stack
87 +1 push value onto stack, before setting new state
90 static cond_item cond_list[] = {
91 { US"ifdef", 5, 0, 1, 1 },
92 { US"ifndef", 6, 1, 0, 1 },
93 { US"elifdef", 7, 2, 3, 0 },
94 { US"elifndef", 8, 3, 2, 0 },
95 { US"else", 4, 2, 2, 0 },
96 { US"endif", 5, 0, 0, -1 }
99 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
101 /* Table of syslog facility names and their values */
103 static syslog_fac_item syslog_list[] = {
104 { US"mail", LOG_MAIL },
105 { US"user", LOG_USER },
106 { US"news", LOG_NEWS },
107 { US"uucp", LOG_UUCP },
108 { US"local0", LOG_LOCAL0 },
109 { US"local1", LOG_LOCAL1 },
110 { US"local2", LOG_LOCAL2 },
111 { US"local3", LOG_LOCAL3 },
112 { US"local4", LOG_LOCAL4 },
113 { US"local5", LOG_LOCAL5 },
114 { US"local6", LOG_LOCAL6 },
115 { US"local7", LOG_LOCAL7 },
116 { US"daemon", LOG_DAEMON }
119 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
124 /*************************************************
125 * Main configuration options *
126 *************************************************/
128 /* The list of options that can be set in the main configuration file. This
129 must be in alphabetic order because it is searched by binary chop. */
131 static optionlist optionlist_config[] = {
132 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
133 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
134 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
135 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
136 { "accept_8bitmime", opt_bool, &accept_8bitmime },
137 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
138 #ifdef WITH_CONTENT_SCAN
139 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
141 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
142 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
143 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
144 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
145 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
146 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
147 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
148 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
149 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
150 #ifdef WITH_CONTENT_SCAN
151 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
153 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
154 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
155 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
157 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
159 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
160 { "admin_groups", opt_gidlist, &admin_groups },
161 { "allow_domain_literals", opt_bool, &allow_domain_literals },
162 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
163 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
164 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
165 { "auto_thaw", opt_time, &auto_thaw },
166 #ifdef WITH_CONTENT_SCAN
167 { "av_scanner", opt_stringptr, &av_scanner },
169 { "bi_command", opt_stringptr, &bi_command },
170 #ifdef EXPERIMENTAL_BRIGHTMAIL
171 { "bmi_config_file", opt_stringptr, &bmi_config_file },
173 { "bounce_message_file", opt_stringptr, &bounce_message_file },
174 { "bounce_message_text", opt_stringptr, &bounce_message_text },
175 { "bounce_return_body", opt_bool, &bounce_return_body },
176 { "bounce_return_message", opt_bool, &bounce_return_message },
177 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
178 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
179 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
180 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
181 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
182 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
183 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
184 { "check_log_inodes", opt_int, &check_log_inodes },
185 { "check_log_space", opt_Kint, &check_log_space },
186 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
187 { "check_spool_inodes", opt_int, &check_spool_inodes },
188 { "check_spool_space", opt_Kint, &check_spool_space },
189 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
190 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
191 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
192 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
193 { "delay_warning", opt_timelist, &delay_warning },
194 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
195 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
196 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
197 { "delivery_date_remove", opt_bool, &delivery_date_remove },
198 { "disable_ipv6", opt_bool, &disable_ipv6 },
199 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
200 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
201 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
202 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
203 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
204 { "dns_retrans", opt_time, &dns_retrans },
205 { "dns_retry", opt_int, &dns_retry },
206 /* This option is now a no-op, retained for compability */
207 { "drop_cr", opt_bool, &drop_cr },
208 /*********************************************************/
209 { "envelope_to_remove", opt_bool, &envelope_to_remove },
210 { "errors_copy", opt_stringptr, &errors_copy },
211 { "errors_reply_to", opt_stringptr, &errors_reply_to },
212 { "exim_group", opt_gid, &exim_gid },
213 { "exim_path", opt_stringptr, &exim_path },
214 { "exim_user", opt_uid, &exim_uid },
215 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
216 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
217 { "finduser_retries", opt_int, &finduser_retries },
218 { "freeze_tell", opt_stringptr, &freeze_tell },
219 { "gecos_name", opt_stringptr, &gecos_name },
220 { "gecos_pattern", opt_stringptr, &gecos_pattern },
221 { "header_line_maxsize", opt_int, &header_line_maxsize },
222 { "header_maxsize", opt_int, &header_maxsize },
223 { "headers_charset", opt_stringptr, &headers_charset },
224 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
225 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
226 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
227 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
228 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
229 { "hold_domains", opt_stringptr, &hold_domains },
230 { "host_lookup", opt_stringptr, &host_lookup },
231 { "host_lookup_order", opt_stringptr, &host_lookup_order },
232 { "host_reject_connection", opt_stringptr, &host_reject_connection },
233 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
234 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
236 { "ibase_servers", opt_stringptr, &ibase_servers },
238 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
239 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
240 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
241 { "keep_malformed", opt_time, &keep_malformed },
243 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
244 { "ldap_version", opt_int, &eldap_version },
246 { "local_from_check", opt_bool, &local_from_check },
247 { "local_from_prefix", opt_stringptr, &local_from_prefix },
248 { "local_from_suffix", opt_stringptr, &local_from_suffix },
249 { "local_interfaces", opt_stringptr, &local_interfaces },
250 { "local_scan_timeout", opt_time, &local_scan_timeout },
251 { "local_sender_retain", opt_bool, &local_sender_retain },
252 { "localhost_number", opt_stringptr, &host_number_string },
253 { "log_file_path", opt_stringptr, &log_file_path },
254 { "log_selector", opt_stringptr, &log_selector_string },
255 { "log_timezone", opt_bool, &log_timezone },
256 { "lookup_open_max", opt_int, &lookup_open_max },
257 { "max_username_length", opt_int, &max_username_length },
258 { "message_body_visible", opt_mkint, &message_body_visible },
259 { "message_id_header_domain", opt_stringptr, &message_id_domain },
260 { "message_id_header_text", opt_stringptr, &message_id_text },
261 { "message_logs", opt_bool, &message_logs },
262 { "message_size_limit", opt_stringptr, &message_size_limit },
263 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
264 { "move_frozen_messages", opt_bool, &move_frozen_messages },
266 { "mua_wrapper", opt_bool, &mua_wrapper },
268 { "mysql_servers", opt_stringptr, &mysql_servers },
270 { "never_users", opt_uidlist, &never_users },
272 { "oracle_servers", opt_stringptr, &oracle_servers },
274 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
276 { "perl_at_start", opt_bool, &opt_perl_at_start },
277 { "perl_startup", opt_stringptr, &opt_perl_startup },
280 { "pgsql_servers", opt_stringptr, &pgsql_servers },
282 { "pid_file_path", opt_stringptr, &pid_file_path },
283 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
284 { "preserve_message_logs", opt_bool, &preserve_message_logs },
285 { "primary_hostname", opt_stringptr, &primary_hostname },
286 { "print_topbitchars", opt_bool, &print_topbitchars },
287 { "process_log_path", opt_stringptr, &process_log_path },
288 { "prod_requires_admin", opt_bool, &prod_requires_admin },
289 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
290 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
291 { "queue_domains", opt_stringptr, &queue_domains },
292 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
293 { "queue_only", opt_bool, &queue_only },
294 { "queue_only_file", opt_stringptr, &queue_only_file },
295 { "queue_only_load", opt_fixed, &queue_only_load },
296 { "queue_only_override", opt_bool, &queue_only_override },
297 { "queue_run_in_order", opt_bool, &queue_run_in_order },
298 { "queue_run_max", opt_int, &queue_run_max },
299 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
300 { "receive_timeout", opt_time, &receive_timeout },
301 { "received_header_text", opt_stringptr, &received_header_text },
302 { "received_headers_max", opt_int, &received_headers_max },
303 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
304 { "recipients_max", opt_int, &recipients_max },
305 { "recipients_max_reject", opt_bool, &recipients_max_reject },
306 { "remote_max_parallel", opt_int, &remote_max_parallel },
307 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
308 { "retry_data_expire", opt_time, &retry_data_expire },
309 { "retry_interval_max", opt_time, &retry_interval_max },
310 { "return_path_remove", opt_bool, &return_path_remove },
311 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
312 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
313 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
314 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
315 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
316 { "smtp_accept_max", opt_int, &smtp_accept_max },
317 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
318 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
319 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
320 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
321 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
322 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
323 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
324 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
325 { "smtp_banner", opt_stringptr, &smtp_banner },
326 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
327 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
328 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
329 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
330 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
331 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
332 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
333 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
334 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
335 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
336 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
337 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
338 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
339 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
340 #ifdef WITH_CONTENT_SCAN
341 { "spamd_address", opt_stringptr, &spamd_address },
343 { "split_spool_directory", opt_bool, &split_spool_directory },
344 { "spool_directory", opt_stringptr, &spool_directory },
346 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
348 #ifdef EXPERIMENTAL_SRS
349 { "srs_config", opt_stringptr, &srs_config },
350 { "srs_hashlength", opt_int, &srs_hashlength },
351 { "srs_hashmin", opt_int, &srs_hashmin },
352 { "srs_maxage", opt_int, &srs_maxage },
353 { "srs_secrets", opt_stringptr, &srs_secrets },
354 { "srs_usehash", opt_bool, &srs_usehash },
355 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
357 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
358 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
359 { "syslog_duplication", opt_bool, &syslog_duplication },
360 { "syslog_facility", opt_stringptr, &syslog_facility_str },
361 { "syslog_processname", opt_stringptr, &syslog_processname },
362 { "syslog_timestamp", opt_bool, &syslog_timestamp },
363 { "system_filter", opt_stringptr, &system_filter },
364 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
365 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
366 { "system_filter_group", opt_gid, &system_filter_gid },
367 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
368 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
369 { "system_filter_user", opt_uid, &system_filter_uid },
370 { "tcp_nodelay", opt_bool, &tcp_nodelay },
371 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
372 { "timezone", opt_stringptr, &timezone_string },
374 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
375 { "tls_certificate", opt_stringptr, &tls_certificate },
376 { "tls_crl", opt_stringptr, &tls_crl },
377 { "tls_dhparam", opt_stringptr, &tls_dhparam },
378 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
379 { "tls_privatekey", opt_stringptr, &tls_privatekey },
380 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
381 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
382 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
383 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
384 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
386 { "trusted_groups", opt_gidlist, &trusted_groups },
387 { "trusted_users", opt_uidlist, &trusted_users },
388 { "unknown_login", opt_stringptr, &unknown_login },
389 { "unknown_username", opt_stringptr, &unknown_username },
390 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
391 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
392 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
393 { "warn_message_file", opt_stringptr, &warn_message_file },
394 { "write_rejectlog", opt_bool, &write_rejectlog }
397 static int optionlist_config_size =
398 sizeof(optionlist_config)/sizeof(optionlist);
402 /*************************************************
403 * Find the name of an option *
404 *************************************************/
406 /* This function is to aid debugging. Various functions take arguments that are
407 pointer variables in the options table or in option tables for various drivers.
408 For debugging output, it is useful to be able to find the name of the option
409 which is currently being processed. This function finds it, if it exists, by
410 searching the table(s).
412 Arguments: a value that is presumed to be in the table above
413 Returns: the option name, or an empty string
417 readconf_find_option(void *p)
421 transport_instance *t;
423 for (i = 0; i < optionlist_config_size; i++)
424 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
426 for (r = routers; r != NULL; r = r->next)
428 router_info *ri = r->info;
429 for (i = 0; i < ri->options_count[0]; i++)
431 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
432 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
433 return US ri->options[i].name;
437 for (t = transports; t != NULL; t = t->next)
439 transport_info *ti = t->info;
440 for (i = 0; i < ti->options_count[0]; i++)
442 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
443 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
444 return US ti->options[i].name;
454 /*************************************************
455 * Deal with an assignment to a macro *
456 *************************************************/
458 /* This function is called when a line that starts with an upper case letter is
459 encountered. The argument "line" should contain a complete logical line, and
460 start with the first letter of the macro name. The macro name and the
461 replacement text are extracted and stored. Redefinition of existing,
462 non-command line, macros is permitted using '==' instead of '='.
465 s points to the start of the logical line
471 read_macro_assignment(uschar *s)
477 macro_item *mlast = NULL;
479 while (isalnum(*s) || *s == '_')
481 if (namelen >= sizeof(name) - 1)
482 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
483 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
484 name[namelen++] = *s++;
488 while (isspace(*s)) s++;
490 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
497 while (isspace(*s)) s++;
499 /* If an existing macro of the same name was defined on the command line, we
500 just skip this definition. It's an error to attempt to redefine a macro without
501 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
502 It is also an error to define a macro whose name begins with the name of a
503 previously defined macro. Note: it is documented that the other way round
506 for (m = macros; m != NULL; m = m->next)
508 int len = Ustrlen(m->name);
510 if (Ustrcmp(m->name, name) == 0)
512 if (!m->command_line && !redef)
513 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
514 "defined (use \"==\" if you want to redefine it", name);
518 if (len < namelen && Ustrstr(name, m->name) != NULL)
519 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
520 "a macro because previously defined macro \"%s\" is a substring",
523 /* We cannot have this test, because it is documented that a substring
524 macro is permitted (there is even an example).
526 * if (len > namelen && Ustrstr(m->name, name) != NULL)
527 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
528 * "a macro because it is a substring of previously defined macro \"%s\"",
535 /* Check for an overriding command-line definition. */
537 if (m != NULL && m->command_line) return;
539 /* Redefinition must refer to an existing macro. */
544 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
548 /* We have a new definition. The macro_item structure includes a final vector
549 called "name" which is one byte long. Thus, adding "namelen" gives us enough
550 room to store the "name" string. */
554 m = store_get(sizeof(macro_item) + namelen);
555 if (macros == NULL) macros = m; else mlast->next = m;
556 Ustrncpy(m->name, name, namelen);
557 m->name[namelen] = 0;
559 m->command_line = FALSE;
562 /* Set the value of the new or redefined macro */
564 m->replacement = string_copy(s);
571 /*************************************************
572 * Read configuration line *
573 *************************************************/
575 /* A logical line of text is read from the configuration file into the big
576 buffer, taking account of macros, .includes, and continuations. The size of
577 big_buffer is increased if necessary. The count of configuration lines is
578 maintained. Physical input lines starting with # (ignoring leading white space,
579 and after macro replacement) and empty logical lines are always ignored.
580 Leading and trailing spaces are removed.
582 If we hit a line of the form "begin xxxx", the xxxx is placed in the
583 next_section vector, and the function returns NULL, indicating the end of a
584 configuration section. On end-of-file, NULL is returned with next_section
589 Returns: a pointer to the first non-blank in the line,
590 or NULL if eof or end of section is reached
594 get_config_line(void)
596 int startoffset = 0; /* To first non-blank char in logical line */
597 int len = 0; /* Of logical line so far */
603 /* Loop for handling continuation lines, skipping comments, and dealing with
608 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
610 if (config_file_stack != NULL) /* EOF inside .include */
612 (void)fclose(config_file);
613 config_file = config_file_stack->file;
614 config_filename = config_file_stack->filename;
615 config_lineno = config_file_stack->lineno;
616 config_file_stack = config_file_stack->next;
620 /* EOF at top level */
622 if (cstate_stack_ptr >= 0)
623 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
624 "Unexpected end of configuration file: .endif missing");
626 if (len != 0) break; /* EOF after continuation */
627 next_section[0] = 0; /* EOF at start of logical line */
632 newlen = len + Ustrlen(big_buffer + len);
634 /* Handle pathologically long physical lines - yes, it did happen - by
635 extending big_buffer at this point. The code also copes with very long
638 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
641 big_buffer_size += BIG_BUFFER_SIZE;
642 newbuffer = store_malloc(big_buffer_size);
644 /* This use of strcpy is OK because we know that the string in the old
645 buffer is shorter than the new buffer. */
647 Ustrcpy(newbuffer, big_buffer);
648 store_free(big_buffer);
649 big_buffer = newbuffer;
650 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
652 newlen += Ustrlen(big_buffer + newlen);
655 /* Find the true start of the physical line - leading spaces are always
658 ss = big_buffer + len;
659 while (isspace(*ss)) ss++;
661 /* Process the physical line for macros. If this is the start of the logical
662 line, skip over initial text at the start of the line if it starts with an
663 upper case character followed by a sequence of name characters and an equals
664 sign, because that is the definition of a new macro, and we don't do
665 replacement therein. */
668 if (len == 0 && isupper(*s))
670 while (isalnum(*s) || *s == '_') s++;
671 while (isspace(*s)) s++;
672 if (*s != '=') s = ss; /* Not a macro definition */
675 /* For each defined macro, scan the line (from after XXX= if present),
676 replacing all occurrences of the macro. */
679 for (m = macros; m != NULL; m = m->next)
684 while ((p = Ustrstr(t, m->name)) != NULL)
687 int namelen = Ustrlen(m->name);
688 int replen = Ustrlen(m->replacement);
690 /* Expand the buffer if necessary */
692 while (newlen - namelen + replen + 1 > big_buffer_size)
694 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
695 uschar *newbuffer = store_malloc(newsize);
696 memcpy(newbuffer, big_buffer, newlen + 1);
697 p = newbuffer + (p - big_buffer);
698 s = newbuffer + (s - big_buffer);
699 ss = newbuffer + (ss - big_buffer);
700 t = newbuffer + (t - big_buffer);
701 big_buffer_size = newsize;
702 store_free(big_buffer);
703 big_buffer = newbuffer;
706 /* Shuffle the remaining characters up or down in the buffer before
707 copying in the replacement text. Don't rescan the replacement for this
711 moveby = replen - namelen;
714 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
717 Ustrncpy(p, m->replacement, replen);
723 /* An empty macro replacement at the start of a line could mean that ss no
724 longer points to the first non-blank character. */
726 while (isspace(*ss)) ss++;
728 /* Check for comment lines - these are physical lines. */
730 if (*ss == '#') continue;
732 /* Handle conditionals, which are also applied to physical lines. Conditions
733 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
734 expansion occured on the rest of the line. A preliminary test for the leading
735 '.' saves effort on most lines. */
741 /* Search the list of conditional directives */
743 for (i = 0; i < cond_list_size; i++)
746 cond_item *c = cond_list+i;
747 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
749 /* The following character must be white space or end of string */
751 n = ss[1 + c->namelen];
752 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
754 /* .ifdef and .ifndef push the current state onto the stack, then set
755 a new one from the table. Stack overflow is an error */
759 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
760 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
761 ".%s nested too deeply", c->name);
762 cstate_stack[++cstate_stack_ptr] = cstate;
763 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
766 /* For any of the others, stack underflow is an error. The next state
767 comes either from the stack (.endif) or from the table. */
771 if (cstate_stack_ptr < 0)
772 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
773 ".%s without matching .ifdef", c->name);
774 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
775 next_cstate[cstate][macro_found? c->action1 : c->action2];
778 /* Having dealt with a directive, break the loop */
783 /* If we have handled a conditional directive, continue with the next
784 physical line. Otherwise, fall through. */
786 if (i < cond_list_size) continue;
789 /* If the conditional state is not 0 (actively using these lines), ignore
792 if (cstate != 0) continue; /* Conditional skip */
794 /* Handle .include lines - these are also physical lines. */
796 if (Ustrncmp(ss, ".include", 8) == 0 &&
798 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
801 int include_if_exists = isspace(ss[8])? 0 : 10;
802 config_file_item *save;
805 ss += 9 + include_if_exists;
806 while (isspace(*ss)) ss++;
807 t = ss + Ustrlen(ss);
808 while (t > ss && isspace(t[-1])) t--;
809 if (*ss == '\"' && t[-1] == '\"')
817 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
818 "absolute path \"%s\"", ss);
820 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
822 save = store_get(sizeof(config_file_item));
823 save->next = config_file_stack;
824 config_file_stack = save;
825 save->file = config_file;
826 save->filename = config_filename;
827 save->lineno = config_lineno;
829 config_file = Ufopen(ss, "rb");
830 if (config_file == NULL)
831 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
832 "configuration file %s", ss);
833 config_filename = string_copy(ss);
838 /* If this is the start of the logical line, remember where the non-blank
839 data starts. Otherwise shuffle down continuation lines to remove leading
843 startoffset = ss - big_buffer;
846 s = big_buffer + len;
849 memmove(s, ss, (newlen - len) - (ss - s) + 1);
854 /* Accept the new addition to the line. Remove trailing white space. */
857 while (len > 0 && isspace(big_buffer[len-1])) len--;
860 /* We are done if the line does not end in backslash and contains some data.
861 Empty logical lines are ignored. For continuations, remove the backslash and
862 go round the loop to read the continuation line. */
866 if (big_buffer[len-1] != '\\') break; /* End of logical line */
867 big_buffer[--len] = 0; /* Remove backslash */
869 } /* Loop for reading multiple physical lines */
871 /* We now have a logical line. Test for the end of a configuration section (or,
872 more accurately, for the start of the next section). Place the name of the next
873 section in next_section, and return NULL. If the name given is longer than
874 next_section, truncate it. It will be unrecognized later, because all the known
875 section names do fit. Leave space for pluralizing. */
877 s = big_buffer + startoffset; /* First non-space character */
878 if (strncmpic(s, US"begin ", 6) == 0)
881 while (isspace(*s)) s++;
882 if (big_buffer + len - s > sizeof(next_section) - 2)
883 s[sizeof(next_section) - 2] = 0;
884 Ustrcpy(next_section, s);
888 /* Return the first non-blank character. */
895 /*************************************************
897 *************************************************/
899 /* The yield is the pointer to the next uschar. Names longer than the
900 output space are silently truncated. This function is also used from acl.c when
904 name where to put the name
908 Returns: new input pointer
912 readconf_readname(uschar *name, int len, uschar *s)
915 while (isspace(*s)) s++;
918 while (isalnum(*s) || *s == '_')
920 if (p < len-1) name[p++] = *s;
925 while (isspace(*s)) s++;
932 /*************************************************
933 * Read a time value *
934 *************************************************/
936 /* This function is also called from outside, to read argument
937 time values. The format of a time value is:
939 [<n>w][<n>d][<n>h][<n>m][<n>s]
941 as long as at least one is present. If a format error is encountered,
942 return a negative value. The value must be terminated by the given
947 terminator required terminating character
948 return_msec if TRUE, allow fractional seconds and return milliseconds
950 Returns: the time value, or -1 on syntax error
951 value is seconds if return_msec is FALSE
952 value is milliseconds if return_msec is TRUE
956 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
964 if (!isdigit(*s)) return -1;
965 (void)sscanf(CS s, "%d%n", &value, &count);
970 case 'w': value *= 7;
971 case 'd': value *= 24;
972 case 'h': value *= 60;
973 case 'm': value *= 60;
978 if (!return_msec) return -1;
979 (void)sscanf(CS s, "%lf%n", &fraction, &count);
981 if (*s++ != 's') return -1;
982 yield += (int)(fraction * 1000.0);
988 if (return_msec) value *= 1000;
990 if (*s == terminator) return yield;
992 /* Control never reaches here. */
997 /*************************************************
998 * Read a fixed point value *
999 *************************************************/
1001 /* The value is returned *1000
1005 terminator required terminator
1007 Returns: the value, or -1 on error
1011 readconf_readfixed(uschar *s, int terminator)
1015 if (!isdigit(*s)) return -1;
1016 (void)sscanf(CS s, "%d%n", &value, &count);
1018 yield = value * 1000;
1022 while (isdigit((*(++s))))
1024 yield += (*s - '0') * m;
1029 return (*s == terminator)? yield : (-1);
1034 /*************************************************
1035 * Find option in list *
1036 *************************************************/
1038 /* The lists are always in order, so binary chop can be used.
1041 name the option name to search for
1042 ol the first entry in the option list
1043 last one more than the offset of the last entry in the option list
1045 Returns: pointer to an option entry, or NULL if not found
1049 find_option(uschar *name, optionlist *ol, int last)
1052 while (last > first)
1054 int middle = (first + last)/2;
1055 int c = Ustrcmp(name, ol[middle].name);
1056 if (c == 0) return ol + middle;
1057 else if (c > 0) first = middle + 1;
1065 /*************************************************
1066 * Find a set flag in option list *
1067 *************************************************/
1069 /* Because some versions of Unix make no restrictions on the values of uids and
1070 gids (even negative ones), we cannot represent "unset" by a special value.
1071 There is therefore a separate boolean variable for each one indicating whether
1072 a value is set or not. This function returns a pointer to the boolean, given
1073 the original option name. It is a major disaster if the flag cannot be found.
1076 name the name of the uid or gid option
1077 oltop points to the start of the relevant option list
1078 last one more than the offset of the last item in the option list
1079 data_block NULL when reading main options => data values in the option
1080 list are absolute addresses; otherwise they are byte offsets
1081 in data_block (used for driver options)
1083 Returns: a pointer to the boolean flag.
1087 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1091 sprintf(CS name2, "*set_%.50s", name);
1092 ol = find_option(name2, oltop, last);
1093 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1094 "Exim internal error: missing set flag for %s", name);
1095 return (data_block == NULL)? (BOOL *)(ol->value) :
1096 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1102 /*************************************************
1103 * Output extra characters message and die *
1104 *************************************************/
1106 /* Called when an option line has junk on the end. Sometimes this is because
1107 the sysadmin thinks comments are permitted.
1110 s points to the extra characters
1111 t1..t3 strings to insert in the log message
1113 Returns: doesn't return; dies
1117 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1119 uschar *comment = US"";
1120 if (*s == '#') comment = US" (# is comment only at line start)";
1121 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1122 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1127 /*************************************************
1128 * Read rewrite information *
1129 *************************************************/
1131 /* Each line of rewrite information contains:
1133 . A complete address in the form user@domain, possibly with
1134 leading * for each part; or alternatively, a regex.
1136 . A replacement string (which will be expanded).
1138 . An optional sequence of one-letter flags, indicating which
1139 headers etc. to apply this rule to.
1141 All this is decoded and placed into a control block. The OR of the flags is
1142 maintained in a common word.
1145 p points to the string that makes up the rule
1146 existflags points to the overall flag word
1147 isglobal TRUE if reading global rewrite rules
1149 Returns: the control block for the parsed rule.
1152 static rewrite_rule *
1153 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1155 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1158 next->key = string_dequote(&p);
1160 while (isspace(*p)) p++;
1162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1163 "missing rewrite replacement string");
1166 next->replacement = string_dequote(&p);
1168 while (*p != 0) switch (*p++)
1170 case ' ': case '\t': break;
1172 case 'q': next->flags |= rewrite_quit; break;
1173 case 'w': next->flags |= rewrite_whole; break;
1175 case 'h': next->flags |= rewrite_all_headers; break;
1176 case 's': next->flags |= rewrite_sender; break;
1177 case 'f': next->flags |= rewrite_from; break;
1178 case 't': next->flags |= rewrite_to; break;
1179 case 'c': next->flags |= rewrite_cc; break;
1180 case 'b': next->flags |= rewrite_bcc; break;
1181 case 'r': next->flags |= rewrite_replyto; break;
1183 case 'E': next->flags |= rewrite_all_envelope; break;
1184 case 'F': next->flags |= rewrite_envfrom; break;
1185 case 'T': next->flags |= rewrite_envto; break;
1187 case 'Q': next->flags |= rewrite_qualify; break;
1188 case 'R': next->flags |= rewrite_repeat; break;
1191 next->flags |= rewrite_smtp;
1192 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1193 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1194 "rewrite rule has the S flag but is not a regular expression");
1198 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1199 "unknown rewrite flag character '%c' "
1200 "(could be missing quotes round replacement item)", p[-1]);
1204 /* If no action flags are set, set all the "normal" rewrites. */
1206 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1207 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1209 /* Remember which exist, for optimization, and return the rule */
1211 *existflags |= next->flags;
1218 /*************************************************
1219 * Read global rewrite information *
1220 *************************************************/
1222 /* Each line is a single rewrite rule; it is parsed into a control block
1223 by readconf_one_rewrite(), and its flags are ORed into the global flag
1224 word rewrite_existflags. */
1227 readconf_rewrites(void)
1229 rewrite_rule **chain = &global_rewrite_rules;
1232 while ((p = get_config_line()) != NULL)
1234 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1236 chain = &(next->next);
1242 /*************************************************
1244 *************************************************/
1246 /* Strings are read into the normal store pool. As long we aren't too
1247 near the end of the current block, the string will just use what is necessary
1248 on the top of the stacking pool, because string_cat() uses the extension
1252 s the rest of the input line
1253 name the option name (for errors)
1255 Returns: pointer to the string
1259 read_string(uschar *s, uschar *name)
1264 if (*s != '\"') return string_copy(s);
1267 yield = string_dequote(&s);
1269 if (s == ss+1 || s[-1] != '\"')
1270 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1271 "missing quote at end of string value for %s", name);
1273 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1279 /*************************************************
1280 * Handle option line *
1281 *************************************************/
1283 /* This function is called from several places to process a line containing the
1284 setting of an option. The first argument is the line to be decoded; it has been
1285 checked not to be empty and not to start with '#'. Trailing newlines and white
1286 space have been removed. The second argument is a pointer to the list of
1287 variable names that are to be recognized, together with their types and
1288 locations, and the third argument gives the number of entries in the list.
1290 The fourth argument is a pointer to a data block. If it is NULL, then the data
1291 values in the options list are absolute addresses. Otherwise, they are byte
1292 offsets in the data block.
1294 String option data may continue onto several lines; this function reads further
1295 data from config_file if necessary.
1297 The yield of this function is normally zero. If a string continues onto
1298 multiple lines, then the data value is permitted to be followed by a comma
1299 or a semicolon (for use in drivers) and the yield is that character.
1302 buffer contains the configuration line to be handled
1303 oltop points to the start of the relevant option list
1304 last one more than the offset of the last item in the option list
1305 data_block NULL when reading main options => data values in the option
1306 list are absolute addresses; otherwise they are byte offsets
1307 in data_block when they have opt_public set; otherwise
1308 they are byte offsets in data_block->options_block.
1309 unknown_txt format string to use in panic message for unknown option;
1310 must contain %s for option name
1311 if given as NULL, don't panic on unknown option
1313 Returns: TRUE if an option was read successfully,
1314 FALSE false for an unknown option if unknown_txt == NULL,
1315 otherwise panic and die on an unknown option
1319 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1320 void *data_block, uschar *unknown_txt)
1324 int n, count, type, value;
1328 BOOL boolvalue = TRUE;
1329 BOOL freesptr = TRUE;
1330 optionlist *ol, *ol2;
1334 uschar *inttype = US"";
1340 /* There may be leading spaces; thereafter, we expect an option name starting
1343 while (isspace(*s)) s++;
1345 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1347 /* Read the name of the option, and skip any subsequent white space. If
1348 it turns out that what we read was "hide", set the flag indicating that
1349 this is a secure option, and loop to read the next word. */
1351 for (n = 0; n < 2; n++)
1353 while (isalnum(*s) || *s == '_')
1355 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1359 while (isspace(*s)) s++;
1360 if (Ustrcmp(name, "hide") != 0) break;
1361 issecure = opt_secure;
1365 /* Deal with "no_" or "not_" here for booleans */
1367 if (Ustrncmp(name, "no_", 3) == 0)
1373 if (Ustrncmp(name, "not_", 4) == 0)
1379 /* Search the list for the given name. A non-existent name, or an option that
1380 is set twice, is a disaster. */
1382 ol = find_option(name + offset, oltop, last);
1386 if (unknown_txt == NULL) return FALSE;
1387 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1390 if ((ol->type & opt_set) != 0)
1392 uschar *mname = name;
1393 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1394 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1395 "\"%s\" option set for the second time", mname);
1398 ol->type |= opt_set | issecure;
1399 type = ol->type & opt_mask;
1401 /* Types with data values must be followed by '='; the "no[t]_" prefix
1402 applies only to boolean values. */
1404 if (type < opt_bool || type > opt_bool_last)
1407 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1408 "negation prefix applied to a non-boolean option");
1410 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1411 "unexpected end of line (data missing) after %s", name);
1413 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1416 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1417 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1418 ultimately expands to one of those values. */
1420 else if (*s != 0 && (offset != 0 || *s != '='))
1421 extra_chars_error(s, US"boolean option ", name, US"");
1423 /* Skip white space after = */
1425 if (*s == '=') while (isspace((*(++s))));
1427 /* If there is a data block and the opt_public flag is not set, change
1428 the data block pointer to the private options block. */
1430 if (data_block != NULL && (ol->type & opt_public) == 0)
1431 data_block = (void *)(((driver_instance *)data_block)->options_block);
1433 /* Now get the data according to the type. */
1437 /* If a string value is not enclosed in quotes, it consists of
1438 the rest of the current line, verbatim. Otherwise, string escapes
1441 A transport is specified as a string, which is then looked up in the
1442 list of transports. A search type is specified as one of a number of
1445 A set or rewrite rules for a driver is specified as a string, which is
1446 then parsed into a suitable chain of control blocks.
1448 Uids and gids are specified as strings which are then looked up in the
1449 passwd file. Lists of uids and gids are similarly specified as colon-
1450 separated strings. */
1455 case opt_expand_uid:
1456 case opt_expand_gid:
1461 reset_point = sptr = read_string(s, name);
1463 /* Having read a string, we now have several different ways of using it,
1464 depending on the data type, so do another switch. If keeping the actual
1465 string is not required (because it is interpreted), freesptr is set TRUE,
1466 and at the end we reset the pool. */
1470 /* If this was a string, set the variable to point to the new string,
1471 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1472 rules, we still keep the string (for printing), and parse the rules into a
1473 control block and flags word. */
1477 if (data_block == NULL)
1478 *((uschar **)(ol->value)) = sptr;
1480 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1482 if (type == opt_rewrite)
1487 rewrite_rule **chain;
1490 sprintf(CS name2, "*%.50s_rules", name);
1491 ol2 = find_option(name2, oltop, last);
1492 sprintf(CS name2, "*%.50s_flags", name);
1493 ol3 = find_option(name2, oltop, last);
1495 if (ol2 == NULL || ol3 == NULL)
1496 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1497 "rewrite rules not available for driver");
1499 if (data_block == NULL)
1501 chain = (rewrite_rule **)(ol2->value);
1502 flagptr = (int *)(ol3->value);
1506 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1507 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1510 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1513 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1515 chain = &(next->next);
1518 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1519 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1520 "non-header rewrite - not allowed at transport time -");
1524 /* If it was an expanded uid, see if there is any expansion to be
1525 done by checking for the presence of a $ character. If there is, save it
1526 in the corresponding *expand_user option field. Otherwise, fall through
1527 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1530 case opt_expand_uid:
1531 sprintf(CS name2, "*expand_%.50s", name);
1532 ol2 = find_option(name2, oltop, last);
1535 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1537 if (data_block == NULL)
1538 *((uschar **)(ol2->value)) = ss;
1540 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1544 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1550 /* Look up a fixed uid, and also make use of the corresponding gid
1551 if a passwd entry is returned and the gid has not been set. */
1554 if (!route_finduser(sptr, &pw, &uid))
1555 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1556 if (data_block == NULL)
1557 *((uid_t *)(ol->value)) = uid;
1559 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1561 /* Set the flag indicating a fixed value is set */
1563 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1565 /* Handle matching gid if we have a passwd entry: done by finding the
1566 same name with terminating "user" changed to "group"; if not found,
1567 ignore. Also ignore if the value is already set. */
1569 if (pw == NULL) break;
1570 Ustrcpy(name+Ustrlen(name)-4, "group");
1571 ol2 = find_option(name, oltop, last);
1572 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1573 (ol2->type & opt_mask) == opt_expand_gid))
1575 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1578 if (data_block == NULL)
1579 *((gid_t *)(ol2->value)) = pw->pw_gid;
1581 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1587 /* If it was an expanded gid, see if there is any expansion to be
1588 done by checking for the presence of a $ character. If there is, save it
1589 in the corresponding *expand_user option field. Otherwise, fall through
1590 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1593 case opt_expand_gid:
1594 sprintf(CS name2, "*expand_%.50s", name);
1595 ol2 = find_option(name2, oltop, last);
1598 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1600 if (data_block == NULL)
1601 *((uschar **)(ol2->value)) = ss;
1603 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1607 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1613 /* Handle freestanding gid */
1616 if (!route_findgroup(sptr, &gid))
1617 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1618 if (data_block == NULL)
1619 *((gid_t *)(ol->value)) = gid;
1621 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1622 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1625 /* If it was a uid list, look up each individual entry, and build
1626 a vector of uids, with a count in the first element. Put the vector
1627 in malloc store so we can free the string. (We are reading into
1628 permanent store already.) */
1636 uschar *op = expand_string (sptr);
1639 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1640 name, expand_string_message);
1643 if (*p != 0) count++;
1644 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1645 list = store_malloc(count*sizeof(uid_t));
1646 list[ptr++] = (uid_t)(count - 1);
1648 if (data_block == NULL)
1649 *((uid_t **)(ol->value)) = list;
1651 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1657 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1658 if (!route_finduser(big_buffer, NULL, &uid))
1659 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1666 /* If it was a gid list, look up each individual entry, and build
1667 a vector of gids, with a count in the first element. Put the vector
1668 in malloc store so we can free the string. (We are reading into permanent
1677 uschar *op = expand_string (sptr);
1680 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1681 name, expand_string_message);
1684 if (*p != 0) count++;
1685 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1686 list = store_malloc(count*sizeof(gid_t));
1687 list[ptr++] = (gid_t)(count - 1);
1689 if (data_block == NULL)
1690 *((gid_t **)(ol->value)) = list;
1692 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1698 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1699 if (!route_findgroup(big_buffer, &gid))
1700 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1708 /* Release store if the value of the string doesn't need to be kept. */
1710 if (freesptr) store_reset(reset_point);
1713 /* Expanded boolean: if no characters follow, or if there are no dollar
1714 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1715 save the string for later expansion in the alternate place. */
1717 case opt_expand_bool:
1718 if (*s != 0 && Ustrchr(s, '$') != 0)
1720 sprintf(CS name2, "*expand_%.50s", name);
1721 ol2 = find_option(name2, oltop, last);
1724 reset_point = sptr = read_string(s, name);
1725 if (data_block == NULL)
1726 *((uschar **)(ol2->value)) = sptr;
1728 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1735 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1736 look for yes/not/true/false. Some booleans are stored in a single bit in
1737 a single int. There's a special fudge for verify settings; without a suffix
1738 they set both xx_sender and xx_recipient. The table points to the sender
1739 value; search subsequently for the recipient. There's another special case:
1740 opt_bool_set also notes when a boolean has been set. */
1744 case opt_bool_verify:
1748 s = readconf_readname(name2, 64, s);
1749 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1751 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1753 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1754 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1755 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1756 US"for boolean option ", name);
1759 /* Handle single-bit type. */
1761 if (type == opt_bit)
1763 int bit = 1 << ((ol->type >> 16) & 31);
1764 int *ptr = (data_block == NULL)?
1765 (int *)(ol->value) :
1766 (int *)((uschar *)data_block + (long int)ol->value);
1767 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1771 /* Handle full BOOL types */
1773 if (data_block == NULL)
1774 *((BOOL *)(ol->value)) = boolvalue;
1776 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1780 if (type == opt_bool_verify)
1782 sprintf(CS name2, "%.50s_recipient", name + offset);
1783 ol2 = find_option(name2, oltop, last);
1786 if (data_block == NULL)
1787 *((BOOL *)(ol2->value)) = boolvalue;
1789 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1793 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1795 else if (type == opt_bool_set)
1797 sprintf(CS name2, "*set_%.50s", name + offset);
1798 ol2 = find_option(name2, oltop, last);
1801 if (data_block == NULL)
1802 *((BOOL *)(ol2->value)) = TRUE;
1804 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1813 inttype = US"octal ";
1815 /* Integer: a simple(ish) case; allow octal and hex formats, and
1816 suffixes K and M. The different types affect output, not input. */
1823 value = strtol(CS s, CSS &endptr, intbase);
1826 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1829 if (errno != ERANGE)
1831 if (tolower(*endptr) == 'k')
1833 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1837 else if (tolower(*endptr) == 'm')
1839 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1841 else value *= 1024*1024;
1846 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1847 "absolute value of integer \"%s\" is too large (overflow)", s);
1849 while (isspace(*endptr)) endptr++;
1851 extra_chars_error(endptr, inttype, US"integer value for ", name);
1854 if (data_block == NULL)
1855 *((int *)(ol->value)) = value;
1857 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1860 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1867 value = strtol(CS s, CSS &endptr, intbase);
1870 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1873 if (errno != ERANGE)
1875 if (tolower(*endptr) == 'm')
1877 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1881 else if (tolower(*endptr) == 'k')
1887 value = (value + 512)/1024;
1891 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1892 "absolute value of integer \"%s\" is too large (overflow)", s);
1894 while (isspace(*endptr)) endptr++;
1896 extra_chars_error(endptr, inttype, US"integer value for ", name);
1899 if (data_block == NULL)
1900 *((int *)(ol->value)) = value;
1902 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1905 /* Fixed-point number: held to 3 decimal places. */
1908 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1909 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1910 "fixed-point number expected for %s", name);
1912 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1913 "integer \"%s\" is too large (overflow)", s);
1917 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1918 "integer \"%s\" is too large (overflow)", s);
1920 if (s[count] == '.')
1923 while (isdigit(s[++count]))
1925 value += (s[count] - '0') * d;
1930 while (isspace(s[count])) count++;
1933 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1935 if (data_block == NULL)
1936 *((int *)(ol->value)) = value;
1938 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1941 /* There's a special routine to read time values. */
1944 value = readconf_readtime(s, 0, FALSE);
1946 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1948 if (data_block == NULL)
1949 *((int *)(ol->value)) = value;
1951 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1954 /* A time list is a list of colon-separated times, with the first
1955 element holding the size of the list and the second the number of
1961 int *list = (data_block == NULL)?
1962 (int *)(ol->value) :
1963 (int *)((uschar *)data_block + (long int)(ol->value));
1965 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1968 uschar *snext = Ustrchr(s, ':');
1972 while (ss > s && isspace(ss[-1])) ss--;
1975 value = readconf_readtime(s, terminator, FALSE);
1977 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1979 if (count > 1 && value <= list[count])
1980 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1981 "time value out of order for %s", name);
1982 list[count+1] = value;
1983 if (snext == NULL) break;
1985 while (isspace(*s)) s++;
1988 if (count > list[0] - 2)
1989 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1991 if (count > 0 && list[2] == 0) count = 0;
2003 /*************************************************
2004 * Print a time value *
2005 *************************************************/
2008 Argument: a time value in seconds
2009 Returns: pointer to a fixed buffer containing the time as a string,
2010 in readconf_readtime() format
2014 readconf_printtime(int t)
2017 uschar *p = time_buffer;
2034 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2035 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2036 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2037 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2038 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2045 /*************************************************
2046 * Print an individual option value *
2047 *************************************************/
2049 /* This is used by the -bP option, so prints to the standard output.
2050 The entire options list is passed in as an argument, because some options come
2051 in pairs - typically uid/gid settings, which can either be explicit numerical
2052 values, or strings to be expanded later. If the numerical value is unset,
2053 search for "*expand_<name>" to see if there is a string equivalent.
2056 ol option entry, or NULL for an unknown option
2058 options_block NULL for main configuration options; otherwise points to
2059 a driver block; if the option doesn't have opt_public
2060 set, then options_block->options_block is where the item
2062 oltop points to the option list in which ol exists
2063 last one more than the offset of the last entry in optop
2069 print_ol(optionlist *ol, uschar *name, void *options_block,
2070 optionlist *oltop, int last)
2083 printf("%s is not a known option\n", name);
2087 /* Non-admin callers cannot see options that have been flagged secure by the
2090 if (!admin_user && (ol->type & opt_secure) != 0)
2092 printf("%s = <value not displayable>\n", name);
2096 /* Else show the value of the option */
2099 if (options_block != NULL)
2101 if ((ol->type & opt_public) == 0)
2102 options_block = (void *)(((driver_instance *)options_block)->options_block);
2103 value = (void *)((uschar *)options_block + (long int)value);
2106 switch(ol->type & opt_mask)
2109 case opt_rewrite: /* Show the text value */
2110 s = *((uschar **)value);
2111 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2115 printf("%s = %d\n", name, *((int *)value));
2120 int x = *((int *)value);
2121 if (x != 0 && (x & 1023) == 0)
2125 if ((x & 1023) == 0)
2130 printf("%s = %d%c\n", name, x, c);
2132 else printf("%s = %d\n", name, x);
2138 int x = *((int *)value);
2139 if (x == 0) printf("%s = 0\n", name);
2140 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2141 else printf("%s = %dK\n", name, x);
2146 printf("%s = %#o\n", name, *((int *)value));
2149 /* Can be negative only when "unset", in which case integer */
2153 int x = *((int *)value);
2156 if (x < 0) printf("%s =\n", name); else
2158 printf("%s = %d.", name, x/1000);
2171 /* If the numerical value is unset, try for the string value */
2173 case opt_expand_uid:
2174 if (! *get_set_flag(name, oltop, last, options_block))
2176 sprintf(CS name2, "*expand_%.50s", name);
2177 ol2 = find_option(name2, oltop, last);
2180 void *value2 = ol2->value;
2181 if (options_block != NULL)
2182 value2 = (void *)((uschar *)options_block + (long int)value2);
2183 s = *((uschar **)value2);
2184 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2189 /* Else fall through */
2192 if (! *get_set_flag(name, oltop, last, options_block))
2193 printf("%s =\n", name);
2196 pw = getpwuid(*((uid_t *)value));
2198 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2199 else printf("%s = %s\n", name, pw->pw_name);
2203 /* If the numerical value is unset, try for the string value */
2205 case opt_expand_gid:
2206 if (! *get_set_flag(name, oltop, last, options_block))
2208 sprintf(CS name2, "*expand_%.50s", name);
2209 ol2 = find_option(name2, oltop, last);
2210 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2212 void *value2 = ol2->value;
2213 if (options_block != NULL)
2214 value2 = (void *)((uschar *)options_block + (long int)value2);
2215 s = *((uschar **)value2);
2216 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2221 /* Else fall through */
2224 if (! *get_set_flag(name, oltop, last, options_block))
2225 printf("%s =\n", name);
2228 gr = getgrgid(*((int *)value));
2230 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2231 else printf("%s = %s\n", name, gr->gr_name);
2236 uidlist = *((uid_t **)value);
2237 printf("%s =", name);
2238 if (uidlist != NULL)
2242 for (i = 1; i <= (int)(uidlist[0]); i++)
2244 uschar *name = NULL;
2245 pw = getpwuid(uidlist[i]);
2246 if (pw != NULL) name = US pw->pw_name;
2247 if (name != NULL) printf("%c%s", sep, name);
2248 else printf("%c%ld", sep, (long int)(uidlist[i]));
2256 gidlist = *((gid_t **)value);
2257 printf("%s =", name);
2258 if (gidlist != NULL)
2262 for (i = 1; i <= (int)(gidlist[0]); i++)
2264 uschar *name = NULL;
2265 gr = getgrgid(gidlist[i]);
2266 if (gr != NULL) name = US gr->gr_name;
2267 if (name != NULL) printf("%c%s", sep, name);
2268 else printf("%c%ld", sep, (long int)(gidlist[i]));
2276 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2282 int *list = (int *)value;
2283 printf("%s = ", name);
2284 for (i = 0; i < list[1]; i++)
2285 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2291 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2295 case opt_expand_bool:
2296 sprintf(CS name2, "*expand_%.50s", name);
2297 ol2 = find_option(name2, oltop, last);
2298 if (ol2 != NULL && ol2->value != NULL)
2300 void *value2 = ol2->value;
2301 if (options_block != NULL)
2302 value2 = (void *)((uschar *)options_block + (long int)value2);
2303 s = *((uschar **)value2);
2306 printf("%s = %s\n", name, string_printing(s));
2309 /* s == NULL => string not set; fall through */
2315 case opt_bool_verify:
2317 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2324 /*************************************************
2325 * Print value from main configuration *
2326 *************************************************/
2328 /* This function, called as a result of encountering the -bP option,
2329 causes the value of any main configuration variable to be output if the
2330 second argument is NULL. There are some special values:
2332 all print all main configuration options
2333 configure_file print the name of the configuration file
2334 routers print the routers' configurations
2335 transports print the transports' configuration
2336 authenticators print the authenticators' configuration
2337 router_list print a list of router names
2338 transport_list print a list of transport names
2339 authenticator_list print a list of authentication mechanism names
2340 +name print a named list item
2341 local_scan print the local_scan options
2343 If the second argument is not NULL, it must be one of "router", "transport", or
2344 "authenticator" in which case the first argument identifies the driver whose
2345 options are to be printed.
2348 name option name if type == NULL; else driver name
2349 type NULL or driver type name, as described above
2355 readconf_print(uschar *name, uschar *type)
2357 BOOL names_only = FALSE;
2359 optionlist *ol2 = NULL;
2360 driver_instance *d = NULL;
2370 static uschar *types[] = { US"address", US"domain", US"host",
2372 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2373 &hostlist_anchor, &localpartlist_anchor };
2375 for (i = 0; i < 4; i++)
2377 t = tree_search(*(anchors[i]), name+1);
2381 printf("%slist %s = %s\n", types[i], name+1,
2382 ((namedlist_block *)(t->data.ptr))->string);
2387 printf("no address, domain, host, or local part list called \"%s\" "
2388 "exists\n", name+1);
2393 if (Ustrcmp(name, "configure_file") == 0)
2395 printf("%s\n", CS config_main_filename);
2399 if (Ustrcmp(name, "all") == 0)
2401 for (ol = optionlist_config;
2402 ol < optionlist_config + optionlist_config_size; ol++)
2404 if ((ol->type & opt_hidden) == 0)
2405 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2410 if (Ustrcmp(name, "local_scan") == 0)
2412 #ifndef LOCAL_SCAN_HAS_OPTIONS
2413 printf("local_scan() options are not supported\n");
2415 for (ol = local_scan_options;
2416 ol < local_scan_options + local_scan_options_count; ol++)
2418 print_ol(ol, US ol->name, NULL, local_scan_options,
2419 local_scan_options_count);
2425 if (Ustrcmp(name, "routers") == 0)
2430 else if (Ustrcmp(name, "transports") == 0)
2432 type = US"transport";
2436 else if (Ustrcmp(name, "authenticators") == 0)
2438 type = US"authenticator";
2442 else if (Ustrcmp(name, "authenticator_list") == 0)
2444 type = US"authenticator";
2449 else if (Ustrcmp(name, "router_list") == 0)
2455 else if (Ustrcmp(name, "transport_list") == 0)
2457 type = US"transport";
2463 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2464 name, NULL, optionlist_config, optionlist_config_size);
2469 /* Handle the options for a router or transport. Skip options that are flagged
2470 as hidden. Some of these are options with names starting with '*', used for
2471 internal alternative representations of other options (which the printing
2472 function will sort out). Others are synonyms kept for backward compatibility.
2475 if (Ustrcmp(type, "router") == 0)
2477 d = (driver_instance *)routers;
2478 ol2 = optionlist_routers;
2479 size = optionlist_routers_size;
2481 else if (Ustrcmp(type, "transport") == 0)
2483 d = (driver_instance *)transports;
2484 ol2 = optionlist_transports;
2485 size = optionlist_transports_size;
2487 else if (Ustrcmp(type, "authenticator") == 0)
2489 d = (driver_instance *)auths;
2490 ol2 = optionlist_auths;
2491 size = optionlist_auths_size;
2496 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2500 /* Either search for a given driver, or print all of them */
2502 for (; d != NULL; d = d->next)
2505 printf("\n%s %s:\n", d->name, type);
2506 else if (Ustrcmp(d->name, name) != 0) continue;
2508 for (ol = ol2; ol < ol2 + size; ol++)
2510 if ((ol->type & opt_hidden) == 0)
2511 print_ol(ol, US ol->name, d, ol2, size);
2514 for (ol = d->info->options;
2515 ol < d->info->options + *(d->info->options_count); ol++)
2517 if ((ol->type & opt_hidden) == 0)
2518 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2520 if (name != NULL) return;
2522 if (name != NULL) printf("%s %s not found\n", type, name);
2527 /*************************************************
2528 * Read a named list item *
2529 *************************************************/
2531 /* This function reads a name and a list (i.e. string). The name is used to
2532 save the list in a tree, sorted by its name. Each entry also has a number,
2533 which can be used for caching tests, but if the string contains any expansion
2534 items other than $key, the number is set negative to inhibit caching. This
2535 mechanism is used for domain, host, and address lists that are referenced by
2539 anchorp points to the tree anchor
2540 numberp points to the current number for this tree
2541 max the maximum number permitted
2542 s the text of the option line, starting immediately after the name
2544 tname the name of the list type, for messages
2550 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2553 BOOL forcecache = FALSE;
2556 namedlist_block *nb = store_get(sizeof(namedlist_block));
2558 if (Ustrncmp(s, "_cache", 6) == 0)
2565 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2567 if (*numberp >= max)
2568 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2571 while (isspace(*s)) s++;
2573 while (isalnum(*s) || *s == '_') s++;
2574 t = store_get(sizeof(tree_node) + s-ss);
2575 Ustrncpy(t->name, ss, s-ss);
2577 while (isspace(*s)) s++;
2579 if (!tree_insertnode(anchorp, t))
2580 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2581 "duplicate name \"%s\" for a named %s", t->name, tname);
2584 nb->number = *numberp;
2587 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2588 "missing '=' after \"%s\"", t->name);
2589 while (isspace(*s)) s++;
2590 nb->string = read_string(s, t->name);
2591 nb->cache_data = NULL;
2593 /* Check the string for any expansions; if any are found, mark this list
2594 uncacheable unless the user has explicited forced caching. */
2596 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2602 /*************************************************
2603 * Unpick data for a rate limit *
2604 *************************************************/
2606 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2610 s string, in the form t,b,f,l
2611 where t is the threshold (integer)
2612 b is the initial delay (time)
2613 f is the multiplicative factor (fixed point)
2614 k is the maximum time (time)
2615 threshold where to store threshold
2616 base where to store base in milliseconds
2617 factor where to store factor in milliseconds
2618 limit where to store limit
2620 Returns: nothing (panics on error)
2624 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2627 uschar bstring[16], lstring[16];
2629 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2630 factor, lstring) == 4)
2632 *base = readconf_readtime(bstring, 0, TRUE);
2633 *limit = readconf_readtime(lstring, 0, TRUE);
2634 if (*base >= 0 && *limit >= 0) return;
2636 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2642 /*************************************************
2643 * Read main configuration options *
2644 *************************************************/
2646 /* This function is the first to be called for configuration reading. It
2647 opens the configuration file and reads general configuration settings until
2648 it reaches the end of the configuration section. The file is then left open so
2649 that the remaining configuration data can subsequently be read if needed for
2652 The configuration file must be owned either by root or exim, and be writeable
2653 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2654 in the config file, so the test is done on the compiled in values. A slight
2655 anomaly, to be carefully documented.
2657 The name of the configuration file is taken from a list that is included in the
2658 binary of Exim. It can be altered from the command line, but if that is done,
2659 root privilege is immediately withdrawn unless the caller is root or exim.
2660 The first file on the list that exists is used.
2662 For use on multiple systems that share file systems, first look for a
2663 configuration file whose name has the current node name on the end. If that is
2664 not found, try the generic name. For really contorted configurations, that run
2665 multiple Exims with different uid settings, first try adding the effective uid
2666 before the node name. These complications are going to waste resources on most
2667 systems. Therefore they are available only when requested by compile-time
2674 struct stat statbuf;
2675 uschar *s, *filename;
2676 uschar *list = config_main_filelist;
2678 /* Loop through the possible file names */
2680 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2683 /* Cut out all the fancy processing unless specifically wanted */
2685 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2686 uschar *suffix = filename + Ustrlen(filename);
2688 /* Try for the node-specific file if a node name exists */
2690 #ifdef CONFIGURE_FILE_USE_NODE
2692 if (uname(&uts) >= 0)
2694 #ifdef CONFIGURE_FILE_USE_EUID
2695 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2696 config_file = Ufopen(filename, "rb");
2697 if (config_file == NULL)
2698 #endif /* CONFIGURE_FILE_USE_EUID */
2700 sprintf(CS suffix, ".%.256s", uts.nodename);
2701 config_file = Ufopen(filename, "rb");
2704 #endif /* CONFIGURE_FILE_USE_NODE */
2706 /* Otherwise, try the generic name, possibly with the euid added */
2708 #ifdef CONFIGURE_FILE_USE_EUID
2709 if (config_file == NULL)
2711 sprintf(CS suffix, ".%ld", (long int)original_euid);
2712 config_file = Ufopen(filename, "rb");
2714 #endif /* CONFIGURE_FILE_USE_EUID */
2716 /* Finally, try the unadorned name */
2718 if (config_file == NULL)
2721 config_file = Ufopen(filename, "rb");
2723 #else /* if neither defined */
2725 /* This is the common case when the fancy processing is not included. */
2727 config_file = Ufopen(filename, "rb");
2730 /* If the file does not exist, continue to try any others. For any other
2731 error, break out (and die). */
2733 if (config_file != NULL || errno != ENOENT) break;
2736 /* On success, save the name for verification; config_filename is used when
2737 logging configuration errors (it changes for .included files) whereas
2738 config_main_filename is the name shown by -bP. Failure to open a configuration
2739 file is a serious disaster. */
2741 if (config_file != NULL)
2743 config_filename = config_main_filename = string_copy(filename);
2747 if (filename == NULL)
2748 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2749 "%s", config_main_filelist);
2751 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2752 "configuration file %s", filename));
2755 /* Check the status of the file we have opened, unless it was specified on
2756 the command line, in which case privilege was given away at the start. */
2758 if (!config_changed)
2760 if (fstat(fileno(config_file), &statbuf) != 0)
2761 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2764 if ((statbuf.st_uid != root_uid && /* owner not root */
2765 statbuf.st_uid != exim_uid /* owner not exim */
2766 #ifdef CONFIGURE_OWNER
2767 && statbuf.st_uid != config_uid /* owner not the special one */
2770 (statbuf.st_gid != exim_gid /* group not exim & */
2771 #ifdef CONFIGURE_GROUP
2772 && statbuf.st_gid != config_gid /* group not the special one */
2774 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2776 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2778 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2779 "wrong owner, group, or mode", big_buffer);
2782 /* Process the main configuration settings. They all begin with a lower case
2783 letter. If we see something starting with an upper case letter, it is taken as
2784 a macro definition. */
2786 while ((s = get_config_line()) != NULL)
2788 if (isupper(s[0])) read_macro_assignment(s);
2790 else if (Ustrncmp(s, "domainlist", 10) == 0)
2791 read_named_list(&domainlist_anchor, &domainlist_count,
2792 MAX_NAMED_LIST, s+10, US"domain list");
2794 else if (Ustrncmp(s, "hostlist", 8) == 0)
2795 read_named_list(&hostlist_anchor, &hostlist_count,
2796 MAX_NAMED_LIST, s+8, US"host list");
2798 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2799 read_named_list(&addresslist_anchor, &addresslist_count,
2800 MAX_NAMED_LIST, s+11, US"address list");
2802 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2803 read_named_list(&localpartlist_anchor, &localpartlist_count,
2804 MAX_NAMED_LIST, s+13, US"local part list");
2807 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2808 NULL, US"main option \"%s\" unknown");
2812 /* If local_sender_retain is set, local_from_check must be unset. */
2814 if (local_sender_retain && local_from_check)
2815 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2816 "local_sender_retain are set; this combination is not allowed");
2818 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2821 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2823 /* The max retry interval must not be greater than 24 hours. */
2825 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2827 /* remote_max_parallel must be > 0 */
2829 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2831 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2832 start of a new SMTP message. */
2834 freeze_tell_config = freeze_tell;
2836 /* The primary host name may be required for expansion of spool_directory
2837 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2838 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2839 canonize it. Some people like upper case letters in their host names, so we
2840 don't force the case. */
2842 if (primary_hostname == NULL)
2846 if (uname(&uts) < 0)
2847 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2848 hostname = US uts.nodename;
2850 if (Ustrchr(hostname, '.') == NULL)
2853 struct hostent *hostdata;
2856 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2857 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2867 #if HAVE_GETIPNODEBYNAME
2869 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2871 hostdata = gethostbyname2(CS hostname, af);
2874 hostdata = gethostbyname(CS hostname);
2877 if (hostdata != NULL)
2879 hostname = US hostdata->h_name;
2883 if (af == AF_INET) break;
2888 primary_hostname = string_copy(hostname);
2891 /* Set up default value for smtp_active_hostname */
2893 smtp_active_hostname = primary_hostname;
2895 /* If spool_directory wasn't set in the build-time configuration, it must have
2896 got set above. Of course, writing to the log may not work if log_file_path is
2897 not set, but it will at least get to syslog or somewhere, with any luck. */
2899 if (*spool_directory == 0)
2900 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2903 /* Expand the spool directory name; it may, for example, contain the primary
2904 host name. Same comment about failure. */
2906 s = expand_string(spool_directory);
2908 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2909 "\"%s\": %s", spool_directory, expand_string_message);
2910 spool_directory = s;
2912 /* Expand log_file_path, which must contain "%s" in any component that isn't
2913 the null string or "syslog". It is also allowed to contain one instance of %D.
2914 However, it must NOT contain % followed by anything else. */
2916 if (*log_file_path != 0)
2919 int sep = ':'; /* Fixed for log file path */
2920 s = expand_string(log_file_path);
2922 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2923 "\"%s\": %s", log_file_path, expand_string_message);
2926 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2929 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2930 t = Ustrstr(sss, "%s");
2932 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2933 "contain \"%%s\"", sss);
2935 t = Ustrchr(sss, '%');
2938 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2939 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2940 "unexpected \"%%\" character", s);
2947 /* Interpret syslog_facility into an integer argument for 'ident' param to
2948 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2951 if (syslog_facility_str != NULL)
2954 uschar *s = syslog_facility_str;
2956 if ((Ustrlen(syslog_facility_str) >= 4) &&
2957 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2960 for (i = 0; i < syslog_list_size; i++)
2962 if (strcmpic(s, syslog_list[i].name) == 0)
2964 syslog_facility = syslog_list[i].value;
2969 if (i >= syslog_list_size)
2971 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2972 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2976 /* Expand pid_file_path */
2978 if (*pid_file_path != 0)
2980 s = expand_string(pid_file_path);
2982 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2983 "\"%s\": %s", pid_file_path, expand_string_message);
2987 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2990 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2992 /* Unpick the SMTP rate limiting options, if set */
2994 if (smtp_ratelimit_mail != NULL)
2996 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2997 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3000 if (smtp_ratelimit_rcpt != NULL)
3002 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3003 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3006 /* The qualify domains default to the primary host name */
3008 if (qualify_domain_sender == NULL)
3009 qualify_domain_sender = primary_hostname;
3010 if (qualify_domain_recipient == NULL)
3011 qualify_domain_recipient = qualify_domain_sender;
3013 /* Setting system_filter_user in the configuration sets the gid as well if a
3014 name is given, but a numerical value does not. */
3016 if (system_filter_uid_set && !system_filter_gid_set)
3018 struct passwd *pw = getpwuid(system_filter_uid);
3020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3021 (long int)system_filter_uid);
3022 system_filter_gid = pw->pw_gid;
3023 system_filter_gid_set = TRUE;
3026 /* If the errors_reply_to field is set, check that it is syntactically valid
3027 and ensure it contains a domain. */
3029 if (errors_reply_to != NULL)
3032 int start, end, domain;
3033 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3034 &start, &end, &domain, FALSE);
3036 if (recipient == NULL)
3037 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3038 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3041 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3042 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3045 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3046 smtp_accept_max must also be set. */
3048 if (smtp_accept_max == 0 &&
3049 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3050 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3051 "smtp_accept_max must be set if smtp_accept_queue or "
3052 "smtp_accept_max_per_host is set");
3054 /* Set up the host number if anything is specified. It is an expanded string
3055 so that it can be computed from the host name, for example. We do this last
3056 so as to ensure that everything else is set up before the expansion. */
3058 if (host_number_string != NULL)
3061 uschar *s = expand_string(host_number_string);
3062 long int n = Ustrtol(s, &end, 0);
3063 while (isspace(*end)) end++;
3065 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3066 "localhost_number value is not a number: %s", s);
3067 if (n > LOCALHOST_MAX)
3068 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3069 "localhost_number is greater than the maximum allowed value (%d)",
3075 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3077 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3078 tls_verify_certificates == NULL)
3079 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3080 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3081 (tls_verify_hosts != NULL)? "" : "try_");
3087 /*************************************************
3088 * Initialize one driver *
3089 *************************************************/
3091 /* This is called once the driver's generic options, if any, have been read.
3092 We can now find the driver, set up defaults for the private options, and
3093 unset any "set" bits in the private options table (which might have been
3094 set by another incarnation of the same driver).
3097 d pointer to driver instance block, with generic
3099 drivers_available vector of available drivers
3100 size_of_info size of each block in drivers_available
3101 class class of driver, for error message
3103 Returns: pointer to the driver info block
3106 static driver_info *
3107 init_driver(driver_instance *d, driver_info *drivers_available,
3108 int size_of_info, uschar *class)
3112 for (dd = drivers_available; dd->driver_name[0] != 0;
3113 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3115 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3118 int len = dd->options_len;
3120 d->options_block = store_get(len);
3121 memcpy(d->options_block, dd->options_block, len);
3122 for (i = 0; i < *(dd->options_count); i++)
3123 dd->options[i].type &= ~opt_set;
3128 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3129 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3131 return NULL; /* never obeyed */
3137 /*************************************************
3138 * Initialize driver list *
3139 *************************************************/
3141 /* This function is called for routers, transports, and authentication
3142 mechanisms. It reads the data from the current point in the configuration file
3143 up to the end of the section, and sets up a chain of instance blocks according
3144 to the file's contents. The file will already have been opened by a call to
3145 readconf_main, and must be left open for subsequent reading of further data.
3147 Any errors cause a panic crash. Note that the blocks with names driver_info and
3148 driver_instance must map the first portions of all the _info and _instance
3149 blocks for this shared code to work.
3152 class "router", "transport", or "authenticator"
3153 anchor &routers, &transports, &auths
3154 drivers_available available drivers
3155 size_of_info size of each info block
3156 instance_default points to default data for an instance
3157 instance_size size of instance block
3158 driver_optionlist generic option list
3159 driver_optionlist_count count of generic option list
3165 readconf_driver_init(
3167 driver_instance **anchor,
3168 driver_info *drivers_available,
3170 void *instance_default,
3172 optionlist *driver_optionlist,
3173 int driver_optionlist_count)
3175 driver_instance **p = anchor;
3176 driver_instance *d = NULL;
3179 while ((buffer = get_config_line()) != NULL)
3184 /* Read the first name on the line and test for the start of a new driver. A
3185 macro definition indicates the end of the previous driver. If this isn't the
3186 start of a new driver, the line will be re-read. */
3188 s = readconf_readname(name, sizeof(name), buffer);
3190 /* Handle macro definition, first finishing off the initialization of the
3191 previous driver, if any. */
3193 if (isupper(*name) && *s == '=')
3197 if (d->driver_name == NULL)
3198 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3199 "no driver defined for %s \"%s\"", class, d->name);
3203 read_macro_assignment(buffer);
3207 /* If the line starts with a name terminated by a colon, we are at the
3208 start of the definition of a new driver. The rest of the line must be
3215 /* Finish off initializing the previous driver. */
3219 if (d->driver_name == NULL)
3220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3221 "no driver defined for %s \"%s\"", class, d->name);
3225 /* Check that we haven't already got a driver of this name */
3227 for (d = *anchor; d != NULL; d = d->next)
3228 if (Ustrcmp(name, d->name) == 0)
3229 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3230 "there are two %ss called \"%s\"", class, name);
3232 /* Set up a new driver instance data block on the chain, with
3233 its default values installed. */
3235 d = store_get(instance_size);
3236 memcpy(d, instance_default, instance_size);
3239 d->name = string_copy(name);
3241 /* Clear out the "set" bits in the generic options */
3243 for (i = 0; i < driver_optionlist_count; i++)
3244 driver_optionlist[i].type &= ~opt_set;
3246 /* Check nothing more on this line, then do the next loop iteration. */
3248 while (isspace(*s)) s++;
3249 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3253 /* Not the start of a new driver. Give an error if we have not set up a
3254 current driver yet. */
3256 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3257 "%s name missing", class);
3259 /* First look to see if this is a generic option; if it is "driver",
3260 initialize the driver. If is it not a generic option, we can look for a
3261 private option provided that the driver has been previously set up. */
3263 if (readconf_handle_option(buffer, driver_optionlist,
3264 driver_optionlist_count, d, NULL))
3266 if (d->info == NULL && d->driver_name != NULL)
3267 init_driver(d, drivers_available, size_of_info, class);
3270 /* Handle private options - pass the generic block because some may
3271 live therein. A flag with each option indicates if it is in the public
3274 else if (d->info != NULL)
3276 readconf_handle_option(buffer, d->info->options,
3277 *(d->info->options_count), d, US"option \"%s\" unknown");
3280 /* The option is not generic and the driver name has not yet been given. */
3282 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3283 "(\"driver\" must be specified before any private options)", name);
3286 /* Run the initialization function for the final driver. */
3290 if (d->driver_name == NULL)
3291 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3292 "no driver defined for %s \"%s\"", class, d->name);
3299 /*************************************************
3300 * Check driver dependency *
3301 *************************************************/
3303 /* This function is passed a driver instance and a string. It checks whether
3304 any of the string options for the driver contains the given string as an
3308 d points to a driver instance block
3309 s the string to search for
3311 Returns: TRUE if a dependency is found
3315 readconf_depends(driver_instance *d, uschar *s)
3317 int count = *(d->info->options_count);
3321 for (ol = d->info->options; ol < d->info->options + count; ol++)
3323 void *options_block;
3325 int type = ol->type & opt_mask;
3326 if (type != opt_stringptr) continue;
3327 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3328 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3329 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3331 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3332 isalnum(ss[Ustrlen(s)])) continue;
3333 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3334 d->name, ol->name, s);
3339 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3346 /*************************************************
3347 * Decode an error type for retries *
3348 *************************************************/
3350 /* This function is global because it is also called from the main
3351 program when testing retry information. It decodes strings such as "quota_7d"
3352 into numerical error codes.
3355 pp points to start of text
3356 p points past end of text
3357 basic_errno points to an int to receive the main error number
3358 more_errno points to an int to receive the secondary error data
3360 Returns: NULL if decoded correctly; else points to error text
3364 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3368 while (q < p && *q != '_') q++;
3371 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3373 *basic_errno = ERRNO_EXIMQUOTA;
3374 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3375 return US"bad time value";
3378 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3380 *basic_errno = ECONNREFUSED;
3383 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3384 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3385 else return US"A or MX expected after \"refused\"";
3389 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3391 *basic_errno = ETIMEDOUT;
3395 int xlen = p - q - 1;
3398 static uschar *extras[] =
3399 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3400 static int values[] =
3401 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3403 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3405 if (strncmpic(x, extras[i], xlen) == 0)
3407 *more_errno = values[i];
3412 if (i >= sizeof(extras)/sizeof(uschar *))
3414 if (strncmpic(x, US"DNS", xlen) == 0)
3416 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3417 "available in retry rules (it has never worked) - treated as "
3420 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3425 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3426 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3427 strncmpic(pp, US"data_4", 6) == 0)
3430 int x = 255; /* means "any 4xx code" */
3431 if (p != pp + 8) bad = TRUE; else
3433 int a = pp[6], b = pp[7];
3437 if (isdigit(b)) x += b - '0';
3438 else if (b == 'x') x += 100;
3441 else if (a != 'x' || b != 'x') bad = TRUE;
3445 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3446 "x is literal and d is any digit", pp);
3448 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3449 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3450 *more_errno = x << 8;
3453 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3454 strncmpic(q+1, US"failed", p-q-1) == 0)
3455 *basic_errno = ERRNO_AUTHFAIL;
3457 else if (strcmpic(pp, US"lost_connection") == 0)
3458 *basic_errno = ERRNO_SMTPCLOSED;
3460 else if (strcmpic(pp, US"tls_required") == 0)
3461 *basic_errno = ERRNO_TLSREQUIRED;
3463 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3464 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3472 /*************************************************
3473 * Read retry information *
3474 *************************************************/
3476 /* Each line of retry information contains:
3478 . A domain name pattern or an address pattern;
3480 . An error name, possibly with additional data, or *;
3482 . An optional sequence of retry items, each consisting of an identifying
3483 letter, a cutoff time, and optional parameters.
3485 All this is decoded and placed into a control block. */
3488 /* Subroutine to read an argument, preceded by a comma and terminated
3489 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3490 1 = fixed point number (returned *1000).
3493 paddr pointer to pointer to current character; updated
3494 type 0 => read a time; 1 => read a fixed point number
3496 Returns: time in seconds or fixed point number * 1000
3500 retry_arg(uschar **paddr, int type)
3505 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3507 while (isspace(*p)) p++;
3509 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3511 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3512 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3518 return readconf_readtime(pp, *p, FALSE);
3520 return readconf_readfixed(pp, *p);
3522 return 0; /* Keep picky compilers happy */
3525 /* The function proper */
3528 readconf_retries(void)
3530 retry_config **chain = &retries;
3534 while ((p = get_config_line()) != NULL)
3536 retry_rule **rchain;
3539 next = store_get(sizeof(retry_config));
3542 chain = &(next->next);
3543 next->basic_errno = next->more_errno = 0;
3544 next->senders = NULL;
3546 rchain = &(next->rules);
3548 next->pattern = string_dequote(&p);
3549 while (isspace(*p)) p++;
3551 while (mac_isgraph(*p)) p++;
3552 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3553 "missing error type");
3555 /* Test error names for things we understand. */
3557 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3558 &(next->more_errno))) != NULL)
3559 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3561 /* There may be an optional address list of senders to be used as another
3562 constraint on the rule. This was added later, so the syntax is a bit of a
3563 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3566 while (isspace(*p)) p++;
3567 if (Ustrncmp(p, "senders", 7) == 0)
3570 while (isspace(*p)) p++;
3571 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3572 "\"=\" expected after \"senders\" in retry rule");
3573 while (isspace(*p)) p++;
3574 next->senders = string_dequote(&p);
3577 /* Now the retry rules. Keep the maximum timeout encountered. */
3579 while (isspace(*p)) p++;
3583 retry_rule *rule = store_get(sizeof(retry_rule));
3585 rchain = &(rule->next);
3587 rule->rule = toupper(*p++);
3588 rule->timeout = retry_arg(&p, 0);
3589 if (rule->timeout > retry_maximum_timeout)
3590 retry_maximum_timeout = rule->timeout;
3594 case 'F': /* Fixed interval */
3595 rule->p1 = retry_arg(&p, 0);
3598 case 'G': /* Geometrically increasing intervals */
3599 case 'H': /* Ditto, but with randomness */
3600 rule->p1 = retry_arg(&p, 0);
3601 rule->p2 = retry_arg(&p, 1);
3605 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3609 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3610 (rule->rule != 'F' && rule->p2 < 1000))
3611 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3612 "bad parameters for retry rule");
3614 while (isspace(*p)) p++;
3618 while (isspace(*p)) p++;
3621 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3628 /*************************************************
3629 * Initialize authenticators *
3630 *************************************************/
3632 /* Read the authenticators section of the configuration file.
3641 auth_instance *au, *bu;
3642 readconf_driver_init(US"authenticator",
3643 (driver_instance **)(&auths), /* chain anchor */
3644 (driver_info *)auths_available, /* available drivers */
3645 sizeof(auth_info), /* size of info block */
3646 &auth_defaults, /* default values for generic options */
3647 sizeof(auth_instance), /* size of instance block */
3648 optionlist_auths, /* generic options */
3649 optionlist_auths_size);
3651 for (au = auths; au != NULL; au = au->next)
3653 if (au->public_name == NULL)
3654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3655 "the %s authenticator", au->name);
3656 for (bu = au->next; bu != NULL; bu = bu->next)
3658 if (strcmpic(au->public_name, bu->public_name) == 0)
3660 if ((au->client && bu->client) || (au->server && bu->server))
3661 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3662 "(%s and %s) have the same public name (%s)",
3663 (au->client)? US"client" : US"server", au->name, bu->name,
3673 /*************************************************
3674 * Read ACL information *
3675 *************************************************/
3677 /* If this run of Exim is not doing something that involves receiving a
3678 message, we can just skip over the ACL information. No need to parse it.
3680 First, we have a function for acl_read() to call back to get the next line. We
3681 need to remember the line we passed, because at the end it will contain the
3682 name of the next ACL. */
3684 static uschar *acl_line;
3689 acl_line = get_config_line();
3694 /* Now the main function:
3697 skip TRUE when this Exim process is doing something that will
3698 not need the ACL data
3704 readconf_acl(BOOL skip)
3708 /* Not receiving messages, don't need to parse the ACL data */
3712 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3713 while ((p = get_config_line()) != NULL);
3717 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3720 acl_line = get_config_line();
3722 while(acl_line != NULL)
3728 p = readconf_readname(name, sizeof(name), acl_line);
3729 if (isupper(*name) && *p == '=')
3731 read_macro_assignment(acl_line);
3732 acl_line = get_config_line();
3736 if (*p != ':' || name[0] == 0)
3737 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3739 node = store_get(sizeof(tree_node) + Ustrlen(name));
3740 Ustrcpy(node->name, name);
3741 if (!tree_insertnode(&acl_anchor, node))
3742 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3743 "there are two ACLs called \"%s\"", name);
3745 node->data.ptr = acl_read(acl_callback, &error);
3747 if (node->data.ptr == NULL && error != NULL)
3748 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3754 /*************************************************
3755 * Read configuration for local_scan() *
3756 *************************************************/
3758 /* This function is called after "begin local_scan" is encountered in the
3759 configuration file. If the local_scan() function allows for configuration
3760 options, we can process them. Otherwise, we expire in a panic.
3767 local_scan_init(void)
3769 #ifndef LOCAL_SCAN_HAS_OPTIONS
3770 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3771 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3775 while ((p = get_config_line()) != NULL)
3777 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3778 NULL, US"local_scan option \"%s\" unknown");
3785 /*************************************************
3786 * Read rest of configuration (after main) *
3787 *************************************************/
3789 /* This function reads the rest of the runtime configuration, after the main
3790 configuration. It is called only when actually needed. Each subsequent section
3791 of the configuration starts with a line of the form
3795 where the name is "routers", "transports", etc. A section is terminated by
3796 hitting the next "begin" line, and the next name is left in next_section.
3797 Because it may confuse people as to whether the names are singular or plural,
3798 we add "s" if it's missing. There is always enough room in next_section for
3799 this. This function is basically just a switch.
3802 skip_acl TRUE if ACL information is not needed
3807 static uschar *section_list[] = {
3817 readconf_rest(BOOL skip_acl)
3821 while(next_section[0] != 0)
3825 int last = sizeof(section_list) / sizeof(uschar *);
3827 int n = Ustrlen(next_section);
3829 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3833 int c = strcmpic(next_section, section_list[mid]);
3835 if (c > 0) first = mid + 1; else last = mid;
3837 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3838 "\"%.*s\" is not a known configuration section name", n, next_section);
3839 mid = (last + first)/2;
3843 if (((had ^= bit) & bit) == 0)
3844 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3845 "\"%.*s\" section is repeated in the configuration file", n,
3850 case 0: readconf_acl(skip_acl); break;
3851 case 1: auths_init(); break;
3852 case 2: local_scan_init(); break;
3853 case 3: readconf_retries(); break;
3854 case 4: readconf_rewrites(); break;
3855 case 5: route_init(); break;
3856 case 6: transport_init(); break;
3860 (void)fclose(config_file);
3863 /* End of readconf.c */