1 /* $Cambridge: exim/src/src/readconf.c,v 1.25 2006/10/18 08:55:38 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 { "strict_acl_vars", opt_bool, &strict_acl_vars },
358 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
359 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
360 { "syslog_duplication", opt_bool, &syslog_duplication },
361 { "syslog_facility", opt_stringptr, &syslog_facility_str },
362 { "syslog_processname", opt_stringptr, &syslog_processname },
363 { "syslog_timestamp", opt_bool, &syslog_timestamp },
364 { "system_filter", opt_stringptr, &system_filter },
365 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
366 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
367 { "system_filter_group", opt_gid, &system_filter_gid },
368 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
369 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
370 { "system_filter_user", opt_uid, &system_filter_uid },
371 { "tcp_nodelay", opt_bool, &tcp_nodelay },
372 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
373 { "timezone", opt_stringptr, &timezone_string },
375 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
376 { "tls_certificate", opt_stringptr, &tls_certificate },
377 { "tls_crl", opt_stringptr, &tls_crl },
378 { "tls_dhparam", opt_stringptr, &tls_dhparam },
379 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
380 { "tls_privatekey", opt_stringptr, &tls_privatekey },
381 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
382 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
383 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
384 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
385 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
387 { "trusted_groups", opt_gidlist, &trusted_groups },
388 { "trusted_users", opt_uidlist, &trusted_users },
389 { "unknown_login", opt_stringptr, &unknown_login },
390 { "unknown_username", opt_stringptr, &unknown_username },
391 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
392 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
393 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
394 { "warn_message_file", opt_stringptr, &warn_message_file },
395 { "write_rejectlog", opt_bool, &write_rejectlog }
398 static int optionlist_config_size =
399 sizeof(optionlist_config)/sizeof(optionlist);
403 /*************************************************
404 * Find the name of an option *
405 *************************************************/
407 /* This function is to aid debugging. Various functions take arguments that are
408 pointer variables in the options table or in option tables for various drivers.
409 For debugging output, it is useful to be able to find the name of the option
410 which is currently being processed. This function finds it, if it exists, by
411 searching the table(s).
413 Arguments: a value that is presumed to be in the table above
414 Returns: the option name, or an empty string
418 readconf_find_option(void *p)
422 transport_instance *t;
424 for (i = 0; i < optionlist_config_size; i++)
425 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
427 for (r = routers; r != NULL; r = r->next)
429 router_info *ri = r->info;
430 for (i = 0; i < ri->options_count[0]; i++)
432 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
433 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
434 return US ri->options[i].name;
438 for (t = transports; t != NULL; t = t->next)
440 transport_info *ti = t->info;
441 for (i = 0; i < ti->options_count[0]; i++)
443 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
444 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
445 return US ti->options[i].name;
455 /*************************************************
456 * Deal with an assignment to a macro *
457 *************************************************/
459 /* This function is called when a line that starts with an upper case letter is
460 encountered. The argument "line" should contain a complete logical line, and
461 start with the first letter of the macro name. The macro name and the
462 replacement text are extracted and stored. Redefinition of existing,
463 non-command line, macros is permitted using '==' instead of '='.
466 s points to the start of the logical line
472 read_macro_assignment(uschar *s)
478 macro_item *mlast = NULL;
480 while (isalnum(*s) || *s == '_')
482 if (namelen >= sizeof(name) - 1)
483 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
484 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
485 name[namelen++] = *s++;
489 while (isspace(*s)) s++;
491 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
498 while (isspace(*s)) s++;
500 /* If an existing macro of the same name was defined on the command line, we
501 just skip this definition. It's an error to attempt to redefine a macro without
502 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
503 It is also an error to define a macro whose name begins with the name of a
504 previously defined macro. Note: it is documented that the other way round
507 for (m = macros; m != NULL; m = m->next)
509 int len = Ustrlen(m->name);
511 if (Ustrcmp(m->name, name) == 0)
513 if (!m->command_line && !redef)
514 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
515 "defined (use \"==\" if you want to redefine it", name);
519 if (len < namelen && Ustrstr(name, m->name) != NULL)
520 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
521 "a macro because previously defined macro \"%s\" is a substring",
524 /* We cannot have this test, because it is documented that a substring
525 macro is permitted (there is even an example).
527 * if (len > namelen && Ustrstr(m->name, name) != NULL)
528 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
529 * "a macro because it is a substring of previously defined macro \"%s\"",
536 /* Check for an overriding command-line definition. */
538 if (m != NULL && m->command_line) return;
540 /* Redefinition must refer to an existing macro. */
545 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
549 /* We have a new definition. The macro_item structure includes a final vector
550 called "name" which is one byte long. Thus, adding "namelen" gives us enough
551 room to store the "name" string. */
555 m = store_get(sizeof(macro_item) + namelen);
556 if (macros == NULL) macros = m; else mlast->next = m;
557 Ustrncpy(m->name, name, namelen);
558 m->name[namelen] = 0;
560 m->command_line = FALSE;
563 /* Set the value of the new or redefined macro */
565 m->replacement = string_copy(s);
572 /*************************************************
573 * Read configuration line *
574 *************************************************/
576 /* A logical line of text is read from the configuration file into the big
577 buffer, taking account of macros, .includes, and continuations. The size of
578 big_buffer is increased if necessary. The count of configuration lines is
579 maintained. Physical input lines starting with # (ignoring leading white space,
580 and after macro replacement) and empty logical lines are always ignored.
581 Leading and trailing spaces are removed.
583 If we hit a line of the form "begin xxxx", the xxxx is placed in the
584 next_section vector, and the function returns NULL, indicating the end of a
585 configuration section. On end-of-file, NULL is returned with next_section
590 Returns: a pointer to the first non-blank in the line,
591 or NULL if eof or end of section is reached
595 get_config_line(void)
597 int startoffset = 0; /* To first non-blank char in logical line */
598 int len = 0; /* Of logical line so far */
604 /* Loop for handling continuation lines, skipping comments, and dealing with
609 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
611 if (config_file_stack != NULL) /* EOF inside .include */
613 (void)fclose(config_file);
614 config_file = config_file_stack->file;
615 config_filename = config_file_stack->filename;
616 config_lineno = config_file_stack->lineno;
617 config_file_stack = config_file_stack->next;
621 /* EOF at top level */
623 if (cstate_stack_ptr >= 0)
624 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
625 "Unexpected end of configuration file: .endif missing");
627 if (len != 0) break; /* EOF after continuation */
628 next_section[0] = 0; /* EOF at start of logical line */
633 newlen = len + Ustrlen(big_buffer + len);
635 /* Handle pathologically long physical lines - yes, it did happen - by
636 extending big_buffer at this point. The code also copes with very long
639 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
642 big_buffer_size += BIG_BUFFER_SIZE;
643 newbuffer = store_malloc(big_buffer_size);
645 /* This use of strcpy is OK because we know that the string in the old
646 buffer is shorter than the new buffer. */
648 Ustrcpy(newbuffer, big_buffer);
649 store_free(big_buffer);
650 big_buffer = newbuffer;
651 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
653 newlen += Ustrlen(big_buffer + newlen);
656 /* Find the true start of the physical line - leading spaces are always
659 ss = big_buffer + len;
660 while (isspace(*ss)) ss++;
662 /* Process the physical line for macros. If this is the start of the logical
663 line, skip over initial text at the start of the line if it starts with an
664 upper case character followed by a sequence of name characters and an equals
665 sign, because that is the definition of a new macro, and we don't do
666 replacement therein. */
669 if (len == 0 && isupper(*s))
671 while (isalnum(*s) || *s == '_') s++;
672 while (isspace(*s)) s++;
673 if (*s != '=') s = ss; /* Not a macro definition */
676 /* For each defined macro, scan the line (from after XXX= if present),
677 replacing all occurrences of the macro. */
680 for (m = macros; m != NULL; m = m->next)
685 while ((p = Ustrstr(t, m->name)) != NULL)
688 int namelen = Ustrlen(m->name);
689 int replen = Ustrlen(m->replacement);
691 /* Expand the buffer if necessary */
693 while (newlen - namelen + replen + 1 > big_buffer_size)
695 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
696 uschar *newbuffer = store_malloc(newsize);
697 memcpy(newbuffer, big_buffer, newlen + 1);
698 p = newbuffer + (p - big_buffer);
699 s = newbuffer + (s - big_buffer);
700 ss = newbuffer + (ss - big_buffer);
701 t = newbuffer + (t - big_buffer);
702 big_buffer_size = newsize;
703 store_free(big_buffer);
704 big_buffer = newbuffer;
707 /* Shuffle the remaining characters up or down in the buffer before
708 copying in the replacement text. Don't rescan the replacement for this
712 moveby = replen - namelen;
715 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
718 Ustrncpy(p, m->replacement, replen);
724 /* An empty macro replacement at the start of a line could mean that ss no
725 longer points to the first non-blank character. */
727 while (isspace(*ss)) ss++;
729 /* Check for comment lines - these are physical lines. */
731 if (*ss == '#') continue;
733 /* Handle conditionals, which are also applied to physical lines. Conditions
734 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
735 expansion occured on the rest of the line. A preliminary test for the leading
736 '.' saves effort on most lines. */
742 /* Search the list of conditional directives */
744 for (i = 0; i < cond_list_size; i++)
747 cond_item *c = cond_list+i;
748 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
750 /* The following character must be white space or end of string */
752 n = ss[1 + c->namelen];
753 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
755 /* .ifdef and .ifndef push the current state onto the stack, then set
756 a new one from the table. Stack overflow is an error */
760 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
762 ".%s nested too deeply", c->name);
763 cstate_stack[++cstate_stack_ptr] = cstate;
764 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
767 /* For any of the others, stack underflow is an error. The next state
768 comes either from the stack (.endif) or from the table. */
772 if (cstate_stack_ptr < 0)
773 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
774 ".%s without matching .ifdef", c->name);
775 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
776 next_cstate[cstate][macro_found? c->action1 : c->action2];
779 /* Having dealt with a directive, break the loop */
784 /* If we have handled a conditional directive, continue with the next
785 physical line. Otherwise, fall through. */
787 if (i < cond_list_size) continue;
790 /* If the conditional state is not 0 (actively using these lines), ignore
793 if (cstate != 0) continue; /* Conditional skip */
795 /* Handle .include lines - these are also physical lines. */
797 if (Ustrncmp(ss, ".include", 8) == 0 &&
799 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
802 int include_if_exists = isspace(ss[8])? 0 : 10;
803 config_file_item *save;
806 ss += 9 + include_if_exists;
807 while (isspace(*ss)) ss++;
808 t = ss + Ustrlen(ss);
809 while (t > ss && isspace(t[-1])) t--;
810 if (*ss == '\"' && t[-1] == '\"')
818 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
819 "absolute path \"%s\"", ss);
821 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
823 save = store_get(sizeof(config_file_item));
824 save->next = config_file_stack;
825 config_file_stack = save;
826 save->file = config_file;
827 save->filename = config_filename;
828 save->lineno = config_lineno;
830 config_file = Ufopen(ss, "rb");
831 if (config_file == NULL)
832 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
833 "configuration file %s", ss);
834 config_filename = string_copy(ss);
839 /* If this is the start of the logical line, remember where the non-blank
840 data starts. Otherwise shuffle down continuation lines to remove leading
844 startoffset = ss - big_buffer;
847 s = big_buffer + len;
850 memmove(s, ss, (newlen - len) - (ss - s) + 1);
855 /* Accept the new addition to the line. Remove trailing white space. */
858 while (len > 0 && isspace(big_buffer[len-1])) len--;
861 /* We are done if the line does not end in backslash and contains some data.
862 Empty logical lines are ignored. For continuations, remove the backslash and
863 go round the loop to read the continuation line. */
867 if (big_buffer[len-1] != '\\') break; /* End of logical line */
868 big_buffer[--len] = 0; /* Remove backslash */
870 } /* Loop for reading multiple physical lines */
872 /* We now have a logical line. Test for the end of a configuration section (or,
873 more accurately, for the start of the next section). Place the name of the next
874 section in next_section, and return NULL. If the name given is longer than
875 next_section, truncate it. It will be unrecognized later, because all the known
876 section names do fit. Leave space for pluralizing. */
878 s = big_buffer + startoffset; /* First non-space character */
879 if (strncmpic(s, US"begin ", 6) == 0)
882 while (isspace(*s)) s++;
883 if (big_buffer + len - s > sizeof(next_section) - 2)
884 s[sizeof(next_section) - 2] = 0;
885 Ustrcpy(next_section, s);
889 /* Return the first non-blank character. */
896 /*************************************************
898 *************************************************/
900 /* The yield is the pointer to the next uschar. Names longer than the
901 output space are silently truncated. This function is also used from acl.c when
905 name where to put the name
909 Returns: new input pointer
913 readconf_readname(uschar *name, int len, uschar *s)
916 while (isspace(*s)) s++;
919 while (isalnum(*s) || *s == '_')
921 if (p < len-1) name[p++] = *s;
926 while (isspace(*s)) s++;
933 /*************************************************
934 * Read a time value *
935 *************************************************/
937 /* This function is also called from outside, to read argument
938 time values. The format of a time value is:
940 [<n>w][<n>d][<n>h][<n>m][<n>s]
942 as long as at least one is present. If a format error is encountered,
943 return a negative value. The value must be terminated by the given
948 terminator required terminating character
949 return_msec if TRUE, allow fractional seconds and return milliseconds
951 Returns: the time value, or -1 on syntax error
952 value is seconds if return_msec is FALSE
953 value is milliseconds if return_msec is TRUE
957 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
965 if (!isdigit(*s)) return -1;
966 (void)sscanf(CS s, "%d%n", &value, &count);
971 case 'w': value *= 7;
972 case 'd': value *= 24;
973 case 'h': value *= 60;
974 case 'm': value *= 60;
979 if (!return_msec) return -1;
980 (void)sscanf(CS s, "%lf%n", &fraction, &count);
982 if (*s++ != 's') return -1;
983 yield += (int)(fraction * 1000.0);
989 if (return_msec) value *= 1000;
991 if (*s == terminator) return yield;
993 /* Control never reaches here. */
998 /*************************************************
999 * Read a fixed point value *
1000 *************************************************/
1002 /* The value is returned *1000
1006 terminator required terminator
1008 Returns: the value, or -1 on error
1012 readconf_readfixed(uschar *s, int terminator)
1016 if (!isdigit(*s)) return -1;
1017 (void)sscanf(CS s, "%d%n", &value, &count);
1019 yield = value * 1000;
1023 while (isdigit((*(++s))))
1025 yield += (*s - '0') * m;
1030 return (*s == terminator)? yield : (-1);
1035 /*************************************************
1036 * Find option in list *
1037 *************************************************/
1039 /* The lists are always in order, so binary chop can be used.
1042 name the option name to search for
1043 ol the first entry in the option list
1044 last one more than the offset of the last entry in the option list
1046 Returns: pointer to an option entry, or NULL if not found
1050 find_option(uschar *name, optionlist *ol, int last)
1053 while (last > first)
1055 int middle = (first + last)/2;
1056 int c = Ustrcmp(name, ol[middle].name);
1057 if (c == 0) return ol + middle;
1058 else if (c > 0) first = middle + 1;
1066 /*************************************************
1067 * Find a set flag in option list *
1068 *************************************************/
1070 /* Because some versions of Unix make no restrictions on the values of uids and
1071 gids (even negative ones), we cannot represent "unset" by a special value.
1072 There is therefore a separate boolean variable for each one indicating whether
1073 a value is set or not. This function returns a pointer to the boolean, given
1074 the original option name. It is a major disaster if the flag cannot be found.
1077 name the name of the uid or gid option
1078 oltop points to the start of the relevant option list
1079 last one more than the offset of the last item in the option list
1080 data_block NULL when reading main options => data values in the option
1081 list are absolute addresses; otherwise they are byte offsets
1082 in data_block (used for driver options)
1084 Returns: a pointer to the boolean flag.
1088 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1092 sprintf(CS name2, "*set_%.50s", name);
1093 ol = find_option(name2, oltop, last);
1094 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1095 "Exim internal error: missing set flag for %s", name);
1096 return (data_block == NULL)? (BOOL *)(ol->value) :
1097 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1103 /*************************************************
1104 * Output extra characters message and die *
1105 *************************************************/
1107 /* Called when an option line has junk on the end. Sometimes this is because
1108 the sysadmin thinks comments are permitted.
1111 s points to the extra characters
1112 t1..t3 strings to insert in the log message
1114 Returns: doesn't return; dies
1118 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1120 uschar *comment = US"";
1121 if (*s == '#') comment = US" (# is comment only at line start)";
1122 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1123 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1128 /*************************************************
1129 * Read rewrite information *
1130 *************************************************/
1132 /* Each line of rewrite information contains:
1134 . A complete address in the form user@domain, possibly with
1135 leading * for each part; or alternatively, a regex.
1137 . A replacement string (which will be expanded).
1139 . An optional sequence of one-letter flags, indicating which
1140 headers etc. to apply this rule to.
1142 All this is decoded and placed into a control block. The OR of the flags is
1143 maintained in a common word.
1146 p points to the string that makes up the rule
1147 existflags points to the overall flag word
1148 isglobal TRUE if reading global rewrite rules
1150 Returns: the control block for the parsed rule.
1153 static rewrite_rule *
1154 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1156 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1159 next->key = string_dequote(&p);
1161 while (isspace(*p)) p++;
1163 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1164 "missing rewrite replacement string");
1167 next->replacement = string_dequote(&p);
1169 while (*p != 0) switch (*p++)
1171 case ' ': case '\t': break;
1173 case 'q': next->flags |= rewrite_quit; break;
1174 case 'w': next->flags |= rewrite_whole; break;
1176 case 'h': next->flags |= rewrite_all_headers; break;
1177 case 's': next->flags |= rewrite_sender; break;
1178 case 'f': next->flags |= rewrite_from; break;
1179 case 't': next->flags |= rewrite_to; break;
1180 case 'c': next->flags |= rewrite_cc; break;
1181 case 'b': next->flags |= rewrite_bcc; break;
1182 case 'r': next->flags |= rewrite_replyto; break;
1184 case 'E': next->flags |= rewrite_all_envelope; break;
1185 case 'F': next->flags |= rewrite_envfrom; break;
1186 case 'T': next->flags |= rewrite_envto; break;
1188 case 'Q': next->flags |= rewrite_qualify; break;
1189 case 'R': next->flags |= rewrite_repeat; break;
1192 next->flags |= rewrite_smtp;
1193 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1194 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1195 "rewrite rule has the S flag but is not a regular expression");
1199 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1200 "unknown rewrite flag character '%c' "
1201 "(could be missing quotes round replacement item)", p[-1]);
1205 /* If no action flags are set, set all the "normal" rewrites. */
1207 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1208 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1210 /* Remember which exist, for optimization, and return the rule */
1212 *existflags |= next->flags;
1219 /*************************************************
1220 * Read global rewrite information *
1221 *************************************************/
1223 /* Each line is a single rewrite rule; it is parsed into a control block
1224 by readconf_one_rewrite(), and its flags are ORed into the global flag
1225 word rewrite_existflags. */
1228 readconf_rewrites(void)
1230 rewrite_rule **chain = &global_rewrite_rules;
1233 while ((p = get_config_line()) != NULL)
1235 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1237 chain = &(next->next);
1243 /*************************************************
1245 *************************************************/
1247 /* Strings are read into the normal store pool. As long we aren't too
1248 near the end of the current block, the string will just use what is necessary
1249 on the top of the stacking pool, because string_cat() uses the extension
1253 s the rest of the input line
1254 name the option name (for errors)
1256 Returns: pointer to the string
1260 read_string(uschar *s, uschar *name)
1265 if (*s != '\"') return string_copy(s);
1268 yield = string_dequote(&s);
1270 if (s == ss+1 || s[-1] != '\"')
1271 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1272 "missing quote at end of string value for %s", name);
1274 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1280 /*************************************************
1281 * Handle option line *
1282 *************************************************/
1284 /* This function is called from several places to process a line containing the
1285 setting of an option. The first argument is the line to be decoded; it has been
1286 checked not to be empty and not to start with '#'. Trailing newlines and white
1287 space have been removed. The second argument is a pointer to the list of
1288 variable names that are to be recognized, together with their types and
1289 locations, and the third argument gives the number of entries in the list.
1291 The fourth argument is a pointer to a data block. If it is NULL, then the data
1292 values in the options list are absolute addresses. Otherwise, they are byte
1293 offsets in the data block.
1295 String option data may continue onto several lines; this function reads further
1296 data from config_file if necessary.
1298 The yield of this function is normally zero. If a string continues onto
1299 multiple lines, then the data value is permitted to be followed by a comma
1300 or a semicolon (for use in drivers) and the yield is that character.
1303 buffer contains the configuration line to be handled
1304 oltop points to the start of the relevant option list
1305 last one more than the offset of the last item in the option list
1306 data_block NULL when reading main options => data values in the option
1307 list are absolute addresses; otherwise they are byte offsets
1308 in data_block when they have opt_public set; otherwise
1309 they are byte offsets in data_block->options_block.
1310 unknown_txt format string to use in panic message for unknown option;
1311 must contain %s for option name
1312 if given as NULL, don't panic on unknown option
1314 Returns: TRUE if an option was read successfully,
1315 FALSE false for an unknown option if unknown_txt == NULL,
1316 otherwise panic and die on an unknown option
1320 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1321 void *data_block, uschar *unknown_txt)
1325 int n, count, type, value;
1329 BOOL boolvalue = TRUE;
1330 BOOL freesptr = TRUE;
1331 optionlist *ol, *ol2;
1335 uschar *inttype = US"";
1341 /* There may be leading spaces; thereafter, we expect an option name starting
1344 while (isspace(*s)) s++;
1346 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1348 /* Read the name of the option, and skip any subsequent white space. If
1349 it turns out that what we read was "hide", set the flag indicating that
1350 this is a secure option, and loop to read the next word. */
1352 for (n = 0; n < 2; n++)
1354 while (isalnum(*s) || *s == '_')
1356 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1360 while (isspace(*s)) s++;
1361 if (Ustrcmp(name, "hide") != 0) break;
1362 issecure = opt_secure;
1366 /* Deal with "no_" or "not_" here for booleans */
1368 if (Ustrncmp(name, "no_", 3) == 0)
1374 if (Ustrncmp(name, "not_", 4) == 0)
1380 /* Search the list for the given name. A non-existent name, or an option that
1381 is set twice, is a disaster. */
1383 ol = find_option(name + offset, oltop, last);
1387 if (unknown_txt == NULL) return FALSE;
1388 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1391 if ((ol->type & opt_set) != 0)
1393 uschar *mname = name;
1394 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1395 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1396 "\"%s\" option set for the second time", mname);
1399 ol->type |= opt_set | issecure;
1400 type = ol->type & opt_mask;
1402 /* Types with data values must be followed by '='; the "no[t]_" prefix
1403 applies only to boolean values. */
1405 if (type < opt_bool || type > opt_bool_last)
1408 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1409 "negation prefix applied to a non-boolean option");
1411 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1412 "unexpected end of line (data missing) after %s", name);
1414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1417 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1418 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1419 ultimately expands to one of those values. */
1421 else if (*s != 0 && (offset != 0 || *s != '='))
1422 extra_chars_error(s, US"boolean option ", name, US"");
1424 /* Skip white space after = */
1426 if (*s == '=') while (isspace((*(++s))));
1428 /* If there is a data block and the opt_public flag is not set, change
1429 the data block pointer to the private options block. */
1431 if (data_block != NULL && (ol->type & opt_public) == 0)
1432 data_block = (void *)(((driver_instance *)data_block)->options_block);
1434 /* Now get the data according to the type. */
1438 /* If a string value is not enclosed in quotes, it consists of
1439 the rest of the current line, verbatim. Otherwise, string escapes
1442 A transport is specified as a string, which is then looked up in the
1443 list of transports. A search type is specified as one of a number of
1446 A set or rewrite rules for a driver is specified as a string, which is
1447 then parsed into a suitable chain of control blocks.
1449 Uids and gids are specified as strings which are then looked up in the
1450 passwd file. Lists of uids and gids are similarly specified as colon-
1451 separated strings. */
1456 case opt_expand_uid:
1457 case opt_expand_gid:
1462 reset_point = sptr = read_string(s, name);
1464 /* Having read a string, we now have several different ways of using it,
1465 depending on the data type, so do another switch. If keeping the actual
1466 string is not required (because it is interpreted), freesptr is set TRUE,
1467 and at the end we reset the pool. */
1471 /* If this was a string, set the variable to point to the new string,
1472 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1473 rules, we still keep the string (for printing), and parse the rules into a
1474 control block and flags word. */
1478 if (data_block == NULL)
1479 *((uschar **)(ol->value)) = sptr;
1481 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1483 if (type == opt_rewrite)
1488 rewrite_rule **chain;
1491 sprintf(CS name2, "*%.50s_rules", name);
1492 ol2 = find_option(name2, oltop, last);
1493 sprintf(CS name2, "*%.50s_flags", name);
1494 ol3 = find_option(name2, oltop, last);
1496 if (ol2 == NULL || ol3 == NULL)
1497 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1498 "rewrite rules not available for driver");
1500 if (data_block == NULL)
1502 chain = (rewrite_rule **)(ol2->value);
1503 flagptr = (int *)(ol3->value);
1507 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1508 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1511 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1514 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1516 chain = &(next->next);
1519 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1520 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1521 "non-header rewrite - not allowed at transport time -");
1525 /* If it was an expanded uid, see if there is any expansion to be
1526 done by checking for the presence of a $ character. If there is, save it
1527 in the corresponding *expand_user option field. Otherwise, fall through
1528 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1531 case opt_expand_uid:
1532 sprintf(CS name2, "*expand_%.50s", name);
1533 ol2 = find_option(name2, oltop, last);
1536 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1538 if (data_block == NULL)
1539 *((uschar **)(ol2->value)) = ss;
1541 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1545 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1551 /* Look up a fixed uid, and also make use of the corresponding gid
1552 if a passwd entry is returned and the gid has not been set. */
1555 if (!route_finduser(sptr, &pw, &uid))
1556 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1557 if (data_block == NULL)
1558 *((uid_t *)(ol->value)) = uid;
1560 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1562 /* Set the flag indicating a fixed value is set */
1564 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1566 /* Handle matching gid if we have a passwd entry: done by finding the
1567 same name with terminating "user" changed to "group"; if not found,
1568 ignore. Also ignore if the value is already set. */
1570 if (pw == NULL) break;
1571 Ustrcpy(name+Ustrlen(name)-4, "group");
1572 ol2 = find_option(name, oltop, last);
1573 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1574 (ol2->type & opt_mask) == opt_expand_gid))
1576 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1579 if (data_block == NULL)
1580 *((gid_t *)(ol2->value)) = pw->pw_gid;
1582 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1588 /* If it was an expanded gid, see if there is any expansion to be
1589 done by checking for the presence of a $ character. If there is, save it
1590 in the corresponding *expand_user option field. Otherwise, fall through
1591 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1594 case opt_expand_gid:
1595 sprintf(CS name2, "*expand_%.50s", name);
1596 ol2 = find_option(name2, oltop, last);
1599 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1601 if (data_block == NULL)
1602 *((uschar **)(ol2->value)) = ss;
1604 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1608 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1614 /* Handle freestanding gid */
1617 if (!route_findgroup(sptr, &gid))
1618 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1619 if (data_block == NULL)
1620 *((gid_t *)(ol->value)) = gid;
1622 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1623 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1626 /* If it was a uid list, look up each individual entry, and build
1627 a vector of uids, with a count in the first element. Put the vector
1628 in malloc store so we can free the string. (We are reading into
1629 permanent store already.) */
1637 uschar *op = expand_string (sptr);
1640 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1641 name, expand_string_message);
1644 if (*p != 0) count++;
1645 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1646 list = store_malloc(count*sizeof(uid_t));
1647 list[ptr++] = (uid_t)(count - 1);
1649 if (data_block == NULL)
1650 *((uid_t **)(ol->value)) = list;
1652 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1658 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1659 if (!route_finduser(big_buffer, NULL, &uid))
1660 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1667 /* If it was a gid list, look up each individual entry, and build
1668 a vector of gids, with a count in the first element. Put the vector
1669 in malloc store so we can free the string. (We are reading into permanent
1678 uschar *op = expand_string (sptr);
1681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1682 name, expand_string_message);
1685 if (*p != 0) count++;
1686 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1687 list = store_malloc(count*sizeof(gid_t));
1688 list[ptr++] = (gid_t)(count - 1);
1690 if (data_block == NULL)
1691 *((gid_t **)(ol->value)) = list;
1693 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1699 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1700 if (!route_findgroup(big_buffer, &gid))
1701 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1709 /* Release store if the value of the string doesn't need to be kept. */
1711 if (freesptr) store_reset(reset_point);
1714 /* Expanded boolean: if no characters follow, or if there are no dollar
1715 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1716 save the string for later expansion in the alternate place. */
1718 case opt_expand_bool:
1719 if (*s != 0 && Ustrchr(s, '$') != 0)
1721 sprintf(CS name2, "*expand_%.50s", name);
1722 ol2 = find_option(name2, oltop, last);
1725 reset_point = sptr = read_string(s, name);
1726 if (data_block == NULL)
1727 *((uschar **)(ol2->value)) = sptr;
1729 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1736 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1737 look for yes/not/true/false. Some booleans are stored in a single bit in
1738 a single int. There's a special fudge for verify settings; without a suffix
1739 they set both xx_sender and xx_recipient. The table points to the sender
1740 value; search subsequently for the recipient. There's another special case:
1741 opt_bool_set also notes when a boolean has been set. */
1745 case opt_bool_verify:
1749 s = readconf_readname(name2, 64, s);
1750 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1752 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1754 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1755 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1756 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1757 US"for boolean option ", name);
1760 /* Handle single-bit type. */
1762 if (type == opt_bit)
1764 int bit = 1 << ((ol->type >> 16) & 31);
1765 int *ptr = (data_block == NULL)?
1766 (int *)(ol->value) :
1767 (int *)((uschar *)data_block + (long int)ol->value);
1768 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1772 /* Handle full BOOL types */
1774 if (data_block == NULL)
1775 *((BOOL *)(ol->value)) = boolvalue;
1777 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1781 if (type == opt_bool_verify)
1783 sprintf(CS name2, "%.50s_recipient", name + offset);
1784 ol2 = find_option(name2, oltop, last);
1787 if (data_block == NULL)
1788 *((BOOL *)(ol2->value)) = boolvalue;
1790 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1794 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1796 else if (type == opt_bool_set)
1798 sprintf(CS name2, "*set_%.50s", name + offset);
1799 ol2 = find_option(name2, oltop, last);
1802 if (data_block == NULL)
1803 *((BOOL *)(ol2->value)) = TRUE;
1805 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1814 inttype = US"octal ";
1816 /* Integer: a simple(ish) case; allow octal and hex formats, and
1817 suffixes K and M. The different types affect output, not input. */
1824 value = strtol(CS s, CSS &endptr, intbase);
1827 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1830 if (errno != ERANGE)
1832 if (tolower(*endptr) == 'k')
1834 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1838 else if (tolower(*endptr) == 'm')
1840 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1842 else value *= 1024*1024;
1847 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1848 "absolute value of integer \"%s\" is too large (overflow)", s);
1850 while (isspace(*endptr)) endptr++;
1852 extra_chars_error(endptr, inttype, US"integer value for ", name);
1855 if (data_block == NULL)
1856 *((int *)(ol->value)) = value;
1858 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1861 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1868 value = strtol(CS s, CSS &endptr, intbase);
1871 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1874 if (errno != ERANGE)
1876 if (tolower(*endptr) == 'm')
1878 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1882 else if (tolower(*endptr) == 'k')
1888 value = (value + 512)/1024;
1892 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1893 "absolute value of integer \"%s\" is too large (overflow)", s);
1895 while (isspace(*endptr)) endptr++;
1897 extra_chars_error(endptr, inttype, US"integer value for ", name);
1900 if (data_block == NULL)
1901 *((int *)(ol->value)) = value;
1903 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1906 /* Fixed-point number: held to 3 decimal places. */
1909 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1910 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1911 "fixed-point number expected for %s", name);
1913 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1914 "integer \"%s\" is too large (overflow)", s);
1918 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1919 "integer \"%s\" is too large (overflow)", s);
1921 if (s[count] == '.')
1924 while (isdigit(s[++count]))
1926 value += (s[count] - '0') * d;
1931 while (isspace(s[count])) count++;
1934 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1936 if (data_block == NULL)
1937 *((int *)(ol->value)) = value;
1939 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1942 /* There's a special routine to read time values. */
1945 value = readconf_readtime(s, 0, FALSE);
1947 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1949 if (data_block == NULL)
1950 *((int *)(ol->value)) = value;
1952 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1955 /* A time list is a list of colon-separated times, with the first
1956 element holding the size of the list and the second the number of
1962 int *list = (data_block == NULL)?
1963 (int *)(ol->value) :
1964 (int *)((uschar *)data_block + (long int)(ol->value));
1966 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1969 uschar *snext = Ustrchr(s, ':');
1973 while (ss > s && isspace(ss[-1])) ss--;
1976 value = readconf_readtime(s, terminator, FALSE);
1978 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1980 if (count > 1 && value <= list[count])
1981 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1982 "time value out of order for %s", name);
1983 list[count+1] = value;
1984 if (snext == NULL) break;
1986 while (isspace(*s)) s++;
1989 if (count > list[0] - 2)
1990 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1992 if (count > 0 && list[2] == 0) count = 0;
2004 /*************************************************
2005 * Print a time value *
2006 *************************************************/
2009 Argument: a time value in seconds
2010 Returns: pointer to a fixed buffer containing the time as a string,
2011 in readconf_readtime() format
2015 readconf_printtime(int t)
2018 uschar *p = time_buffer;
2035 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2036 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2037 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2038 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2039 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2046 /*************************************************
2047 * Print an individual option value *
2048 *************************************************/
2050 /* This is used by the -bP option, so prints to the standard output.
2051 The entire options list is passed in as an argument, because some options come
2052 in pairs - typically uid/gid settings, which can either be explicit numerical
2053 values, or strings to be expanded later. If the numerical value is unset,
2054 search for "*expand_<name>" to see if there is a string equivalent.
2057 ol option entry, or NULL for an unknown option
2059 options_block NULL for main configuration options; otherwise points to
2060 a driver block; if the option doesn't have opt_public
2061 set, then options_block->options_block is where the item
2063 oltop points to the option list in which ol exists
2064 last one more than the offset of the last entry in optop
2070 print_ol(optionlist *ol, uschar *name, void *options_block,
2071 optionlist *oltop, int last)
2084 printf("%s is not a known option\n", name);
2088 /* Non-admin callers cannot see options that have been flagged secure by the
2091 if (!admin_user && (ol->type & opt_secure) != 0)
2093 printf("%s = <value not displayable>\n", name);
2097 /* Else show the value of the option */
2100 if (options_block != NULL)
2102 if ((ol->type & opt_public) == 0)
2103 options_block = (void *)(((driver_instance *)options_block)->options_block);
2104 value = (void *)((uschar *)options_block + (long int)value);
2107 switch(ol->type & opt_mask)
2110 case opt_rewrite: /* Show the text value */
2111 s = *((uschar **)value);
2112 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2116 printf("%s = %d\n", name, *((int *)value));
2121 int x = *((int *)value);
2122 if (x != 0 && (x & 1023) == 0)
2126 if ((x & 1023) == 0)
2131 printf("%s = %d%c\n", name, x, c);
2133 else printf("%s = %d\n", name, x);
2139 int x = *((int *)value);
2140 if (x == 0) printf("%s = 0\n", name);
2141 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2142 else printf("%s = %dK\n", name, x);
2147 printf("%s = %#o\n", name, *((int *)value));
2150 /* Can be negative only when "unset", in which case integer */
2154 int x = *((int *)value);
2157 if (x < 0) printf("%s =\n", name); else
2159 printf("%s = %d.", name, x/1000);
2172 /* If the numerical value is unset, try for the string value */
2174 case opt_expand_uid:
2175 if (! *get_set_flag(name, oltop, last, options_block))
2177 sprintf(CS name2, "*expand_%.50s", name);
2178 ol2 = find_option(name2, oltop, last);
2181 void *value2 = ol2->value;
2182 if (options_block != NULL)
2183 value2 = (void *)((uschar *)options_block + (long int)value2);
2184 s = *((uschar **)value2);
2185 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2190 /* Else fall through */
2193 if (! *get_set_flag(name, oltop, last, options_block))
2194 printf("%s =\n", name);
2197 pw = getpwuid(*((uid_t *)value));
2199 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2200 else printf("%s = %s\n", name, pw->pw_name);
2204 /* If the numerical value is unset, try for the string value */
2206 case opt_expand_gid:
2207 if (! *get_set_flag(name, oltop, last, options_block))
2209 sprintf(CS name2, "*expand_%.50s", name);
2210 ol2 = find_option(name2, oltop, last);
2211 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2213 void *value2 = ol2->value;
2214 if (options_block != NULL)
2215 value2 = (void *)((uschar *)options_block + (long int)value2);
2216 s = *((uschar **)value2);
2217 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2222 /* Else fall through */
2225 if (! *get_set_flag(name, oltop, last, options_block))
2226 printf("%s =\n", name);
2229 gr = getgrgid(*((int *)value));
2231 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2232 else printf("%s = %s\n", name, gr->gr_name);
2237 uidlist = *((uid_t **)value);
2238 printf("%s =", name);
2239 if (uidlist != NULL)
2243 for (i = 1; i <= (int)(uidlist[0]); i++)
2245 uschar *name = NULL;
2246 pw = getpwuid(uidlist[i]);
2247 if (pw != NULL) name = US pw->pw_name;
2248 if (name != NULL) printf("%c%s", sep, name);
2249 else printf("%c%ld", sep, (long int)(uidlist[i]));
2257 gidlist = *((gid_t **)value);
2258 printf("%s =", name);
2259 if (gidlist != NULL)
2263 for (i = 1; i <= (int)(gidlist[0]); i++)
2265 uschar *name = NULL;
2266 gr = getgrgid(gidlist[i]);
2267 if (gr != NULL) name = US gr->gr_name;
2268 if (name != NULL) printf("%c%s", sep, name);
2269 else printf("%c%ld", sep, (long int)(gidlist[i]));
2277 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2283 int *list = (int *)value;
2284 printf("%s = ", name);
2285 for (i = 0; i < list[1]; i++)
2286 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2292 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2296 case opt_expand_bool:
2297 sprintf(CS name2, "*expand_%.50s", name);
2298 ol2 = find_option(name2, oltop, last);
2299 if (ol2 != NULL && ol2->value != NULL)
2301 void *value2 = ol2->value;
2302 if (options_block != NULL)
2303 value2 = (void *)((uschar *)options_block + (long int)value2);
2304 s = *((uschar **)value2);
2307 printf("%s = %s\n", name, string_printing(s));
2310 /* s == NULL => string not set; fall through */
2316 case opt_bool_verify:
2318 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2325 /*************************************************
2326 * Print value from main configuration *
2327 *************************************************/
2329 /* This function, called as a result of encountering the -bP option,
2330 causes the value of any main configuration variable to be output if the
2331 second argument is NULL. There are some special values:
2333 all print all main configuration options
2334 configure_file print the name of the configuration file
2335 routers print the routers' configurations
2336 transports print the transports' configuration
2337 authenticators print the authenticators' configuration
2338 router_list print a list of router names
2339 transport_list print a list of transport names
2340 authenticator_list print a list of authentication mechanism names
2341 +name print a named list item
2342 local_scan print the local_scan options
2344 If the second argument is not NULL, it must be one of "router", "transport", or
2345 "authenticator" in which case the first argument identifies the driver whose
2346 options are to be printed.
2349 name option name if type == NULL; else driver name
2350 type NULL or driver type name, as described above
2356 readconf_print(uschar *name, uschar *type)
2358 BOOL names_only = FALSE;
2360 optionlist *ol2 = NULL;
2361 driver_instance *d = NULL;
2371 static uschar *types[] = { US"address", US"domain", US"host",
2373 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2374 &hostlist_anchor, &localpartlist_anchor };
2376 for (i = 0; i < 4; i++)
2378 t = tree_search(*(anchors[i]), name+1);
2382 printf("%slist %s = %s\n", types[i], name+1,
2383 ((namedlist_block *)(t->data.ptr))->string);
2388 printf("no address, domain, host, or local part list called \"%s\" "
2389 "exists\n", name+1);
2394 if (Ustrcmp(name, "configure_file") == 0)
2396 printf("%s\n", CS config_main_filename);
2400 if (Ustrcmp(name, "all") == 0)
2402 for (ol = optionlist_config;
2403 ol < optionlist_config + optionlist_config_size; ol++)
2405 if ((ol->type & opt_hidden) == 0)
2406 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2411 if (Ustrcmp(name, "local_scan") == 0)
2413 #ifndef LOCAL_SCAN_HAS_OPTIONS
2414 printf("local_scan() options are not supported\n");
2416 for (ol = local_scan_options;
2417 ol < local_scan_options + local_scan_options_count; ol++)
2419 print_ol(ol, US ol->name, NULL, local_scan_options,
2420 local_scan_options_count);
2426 if (Ustrcmp(name, "routers") == 0)
2431 else if (Ustrcmp(name, "transports") == 0)
2433 type = US"transport";
2437 else if (Ustrcmp(name, "authenticators") == 0)
2439 type = US"authenticator";
2443 else if (Ustrcmp(name, "authenticator_list") == 0)
2445 type = US"authenticator";
2450 else if (Ustrcmp(name, "router_list") == 0)
2456 else if (Ustrcmp(name, "transport_list") == 0)
2458 type = US"transport";
2464 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2465 name, NULL, optionlist_config, optionlist_config_size);
2470 /* Handle the options for a router or transport. Skip options that are flagged
2471 as hidden. Some of these are options with names starting with '*', used for
2472 internal alternative representations of other options (which the printing
2473 function will sort out). Others are synonyms kept for backward compatibility.
2476 if (Ustrcmp(type, "router") == 0)
2478 d = (driver_instance *)routers;
2479 ol2 = optionlist_routers;
2480 size = optionlist_routers_size;
2482 else if (Ustrcmp(type, "transport") == 0)
2484 d = (driver_instance *)transports;
2485 ol2 = optionlist_transports;
2486 size = optionlist_transports_size;
2488 else if (Ustrcmp(type, "authenticator") == 0)
2490 d = (driver_instance *)auths;
2491 ol2 = optionlist_auths;
2492 size = optionlist_auths_size;
2497 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2501 /* Either search for a given driver, or print all of them */
2503 for (; d != NULL; d = d->next)
2506 printf("\n%s %s:\n", d->name, type);
2507 else if (Ustrcmp(d->name, name) != 0) continue;
2509 for (ol = ol2; ol < ol2 + size; ol++)
2511 if ((ol->type & opt_hidden) == 0)
2512 print_ol(ol, US ol->name, d, ol2, size);
2515 for (ol = d->info->options;
2516 ol < d->info->options + *(d->info->options_count); ol++)
2518 if ((ol->type & opt_hidden) == 0)
2519 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2521 if (name != NULL) return;
2523 if (name != NULL) printf("%s %s not found\n", type, name);
2528 /*************************************************
2529 * Read a named list item *
2530 *************************************************/
2532 /* This function reads a name and a list (i.e. string). The name is used to
2533 save the list in a tree, sorted by its name. Each entry also has a number,
2534 which can be used for caching tests, but if the string contains any expansion
2535 items other than $key, the number is set negative to inhibit caching. This
2536 mechanism is used for domain, host, and address lists that are referenced by
2540 anchorp points to the tree anchor
2541 numberp points to the current number for this tree
2542 max the maximum number permitted
2543 s the text of the option line, starting immediately after the name
2545 tname the name of the list type, for messages
2551 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2554 BOOL forcecache = FALSE;
2557 namedlist_block *nb = store_get(sizeof(namedlist_block));
2559 if (Ustrncmp(s, "_cache", 6) == 0)
2566 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2568 if (*numberp >= max)
2569 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2572 while (isspace(*s)) s++;
2574 while (isalnum(*s) || *s == '_') s++;
2575 t = store_get(sizeof(tree_node) + s-ss);
2576 Ustrncpy(t->name, ss, s-ss);
2578 while (isspace(*s)) s++;
2580 if (!tree_insertnode(anchorp, t))
2581 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2582 "duplicate name \"%s\" for a named %s", t->name, tname);
2585 nb->number = *numberp;
2588 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2589 "missing '=' after \"%s\"", t->name);
2590 while (isspace(*s)) s++;
2591 nb->string = read_string(s, t->name);
2592 nb->cache_data = NULL;
2594 /* Check the string for any expansions; if any are found, mark this list
2595 uncacheable unless the user has explicited forced caching. */
2597 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2603 /*************************************************
2604 * Unpick data for a rate limit *
2605 *************************************************/
2607 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2611 s string, in the form t,b,f,l
2612 where t is the threshold (integer)
2613 b is the initial delay (time)
2614 f is the multiplicative factor (fixed point)
2615 k is the maximum time (time)
2616 threshold where to store threshold
2617 base where to store base in milliseconds
2618 factor where to store factor in milliseconds
2619 limit where to store limit
2621 Returns: nothing (panics on error)
2625 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2628 uschar bstring[16], lstring[16];
2630 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2631 factor, lstring) == 4)
2633 *base = readconf_readtime(bstring, 0, TRUE);
2634 *limit = readconf_readtime(lstring, 0, TRUE);
2635 if (*base >= 0 && *limit >= 0) return;
2637 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2643 /*************************************************
2644 * Read main configuration options *
2645 *************************************************/
2647 /* This function is the first to be called for configuration reading. It
2648 opens the configuration file and reads general configuration settings until
2649 it reaches the end of the configuration section. The file is then left open so
2650 that the remaining configuration data can subsequently be read if needed for
2653 The configuration file must be owned either by root or exim, and be writeable
2654 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2655 in the config file, so the test is done on the compiled in values. A slight
2656 anomaly, to be carefully documented.
2658 The name of the configuration file is taken from a list that is included in the
2659 binary of Exim. It can be altered from the command line, but if that is done,
2660 root privilege is immediately withdrawn unless the caller is root or exim.
2661 The first file on the list that exists is used.
2663 For use on multiple systems that share file systems, first look for a
2664 configuration file whose name has the current node name on the end. If that is
2665 not found, try the generic name. For really contorted configurations, that run
2666 multiple Exims with different uid settings, first try adding the effective uid
2667 before the node name. These complications are going to waste resources on most
2668 systems. Therefore they are available only when requested by compile-time
2675 struct stat statbuf;
2676 uschar *s, *filename;
2677 uschar *list = config_main_filelist;
2679 /* Loop through the possible file names */
2681 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2684 /* Cut out all the fancy processing unless specifically wanted */
2686 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2687 uschar *suffix = filename + Ustrlen(filename);
2689 /* Try for the node-specific file if a node name exists */
2691 #ifdef CONFIGURE_FILE_USE_NODE
2693 if (uname(&uts) >= 0)
2695 #ifdef CONFIGURE_FILE_USE_EUID
2696 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2697 config_file = Ufopen(filename, "rb");
2698 if (config_file == NULL)
2699 #endif /* CONFIGURE_FILE_USE_EUID */
2701 sprintf(CS suffix, ".%.256s", uts.nodename);
2702 config_file = Ufopen(filename, "rb");
2705 #endif /* CONFIGURE_FILE_USE_NODE */
2707 /* Otherwise, try the generic name, possibly with the euid added */
2709 #ifdef CONFIGURE_FILE_USE_EUID
2710 if (config_file == NULL)
2712 sprintf(CS suffix, ".%ld", (long int)original_euid);
2713 config_file = Ufopen(filename, "rb");
2715 #endif /* CONFIGURE_FILE_USE_EUID */
2717 /* Finally, try the unadorned name */
2719 if (config_file == NULL)
2722 config_file = Ufopen(filename, "rb");
2724 #else /* if neither defined */
2726 /* This is the common case when the fancy processing is not included. */
2728 config_file = Ufopen(filename, "rb");
2731 /* If the file does not exist, continue to try any others. For any other
2732 error, break out (and die). */
2734 if (config_file != NULL || errno != ENOENT) break;
2737 /* On success, save the name for verification; config_filename is used when
2738 logging configuration errors (it changes for .included files) whereas
2739 config_main_filename is the name shown by -bP. Failure to open a configuration
2740 file is a serious disaster. */
2742 if (config_file != NULL)
2744 config_filename = config_main_filename = string_copy(filename);
2748 if (filename == NULL)
2749 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2750 "%s", config_main_filelist);
2752 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2753 "configuration file %s", filename));
2756 /* Check the status of the file we have opened, unless it was specified on
2757 the command line, in which case privilege was given away at the start. */
2759 if (!config_changed)
2761 if (fstat(fileno(config_file), &statbuf) != 0)
2762 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2765 if ((statbuf.st_uid != root_uid && /* owner not root */
2766 statbuf.st_uid != exim_uid /* owner not exim */
2767 #ifdef CONFIGURE_OWNER
2768 && statbuf.st_uid != config_uid /* owner not the special one */
2771 (statbuf.st_gid != exim_gid /* group not exim & */
2772 #ifdef CONFIGURE_GROUP
2773 && statbuf.st_gid != config_gid /* group not the special one */
2775 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2777 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2779 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2780 "wrong owner, group, or mode", big_buffer);
2783 /* Process the main configuration settings. They all begin with a lower case
2784 letter. If we see something starting with an upper case letter, it is taken as
2785 a macro definition. */
2787 while ((s = get_config_line()) != NULL)
2789 if (isupper(s[0])) read_macro_assignment(s);
2791 else if (Ustrncmp(s, "domainlist", 10) == 0)
2792 read_named_list(&domainlist_anchor, &domainlist_count,
2793 MAX_NAMED_LIST, s+10, US"domain list");
2795 else if (Ustrncmp(s, "hostlist", 8) == 0)
2796 read_named_list(&hostlist_anchor, &hostlist_count,
2797 MAX_NAMED_LIST, s+8, US"host list");
2799 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2800 read_named_list(&addresslist_anchor, &addresslist_count,
2801 MAX_NAMED_LIST, s+11, US"address list");
2803 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2804 read_named_list(&localpartlist_anchor, &localpartlist_count,
2805 MAX_NAMED_LIST, s+13, US"local part list");
2808 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2809 NULL, US"main option \"%s\" unknown");
2813 /* If local_sender_retain is set, local_from_check must be unset. */
2815 if (local_sender_retain && local_from_check)
2816 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2817 "local_sender_retain are set; this combination is not allowed");
2819 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2822 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2824 /* The max retry interval must not be greater than 24 hours. */
2826 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2828 /* remote_max_parallel must be > 0 */
2830 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2832 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2833 start of a new SMTP message. */
2835 freeze_tell_config = freeze_tell;
2837 /* The primary host name may be required for expansion of spool_directory
2838 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2839 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2840 canonize it. Some people like upper case letters in their host names, so we
2841 don't force the case. */
2843 if (primary_hostname == NULL)
2847 if (uname(&uts) < 0)
2848 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2849 hostname = US uts.nodename;
2851 if (Ustrchr(hostname, '.') == NULL)
2854 struct hostent *hostdata;
2857 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2858 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2868 #if HAVE_GETIPNODEBYNAME
2870 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2872 hostdata = gethostbyname2(CS hostname, af);
2875 hostdata = gethostbyname(CS hostname);
2878 if (hostdata != NULL)
2880 hostname = US hostdata->h_name;
2884 if (af == AF_INET) break;
2889 primary_hostname = string_copy(hostname);
2892 /* Set up default value for smtp_active_hostname */
2894 smtp_active_hostname = primary_hostname;
2896 /* If spool_directory wasn't set in the build-time configuration, it must have
2897 got set above. Of course, writing to the log may not work if log_file_path is
2898 not set, but it will at least get to syslog or somewhere, with any luck. */
2900 if (*spool_directory == 0)
2901 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2904 /* Expand the spool directory name; it may, for example, contain the primary
2905 host name. Same comment about failure. */
2907 s = expand_string(spool_directory);
2909 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2910 "\"%s\": %s", spool_directory, expand_string_message);
2911 spool_directory = s;
2913 /* Expand log_file_path, which must contain "%s" in any component that isn't
2914 the null string or "syslog". It is also allowed to contain one instance of %D.
2915 However, it must NOT contain % followed by anything else. */
2917 if (*log_file_path != 0)
2920 int sep = ':'; /* Fixed for log file path */
2921 s = expand_string(log_file_path);
2923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2924 "\"%s\": %s", log_file_path, expand_string_message);
2927 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2930 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2931 t = Ustrstr(sss, "%s");
2933 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2934 "contain \"%%s\"", sss);
2936 t = Ustrchr(sss, '%');
2939 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2940 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2941 "unexpected \"%%\" character", s);
2948 /* Interpret syslog_facility into an integer argument for 'ident' param to
2949 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2952 if (syslog_facility_str != NULL)
2955 uschar *s = syslog_facility_str;
2957 if ((Ustrlen(syslog_facility_str) >= 4) &&
2958 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2961 for (i = 0; i < syslog_list_size; i++)
2963 if (strcmpic(s, syslog_list[i].name) == 0)
2965 syslog_facility = syslog_list[i].value;
2970 if (i >= syslog_list_size)
2972 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2973 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2977 /* Expand pid_file_path */
2979 if (*pid_file_path != 0)
2981 s = expand_string(pid_file_path);
2983 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2984 "\"%s\": %s", pid_file_path, expand_string_message);
2988 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2991 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2993 /* Unpick the SMTP rate limiting options, if set */
2995 if (smtp_ratelimit_mail != NULL)
2997 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2998 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3001 if (smtp_ratelimit_rcpt != NULL)
3003 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3004 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3007 /* The qualify domains default to the primary host name */
3009 if (qualify_domain_sender == NULL)
3010 qualify_domain_sender = primary_hostname;
3011 if (qualify_domain_recipient == NULL)
3012 qualify_domain_recipient = qualify_domain_sender;
3014 /* Setting system_filter_user in the configuration sets the gid as well if a
3015 name is given, but a numerical value does not. */
3017 if (system_filter_uid_set && !system_filter_gid_set)
3019 struct passwd *pw = getpwuid(system_filter_uid);
3021 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3022 (long int)system_filter_uid);
3023 system_filter_gid = pw->pw_gid;
3024 system_filter_gid_set = TRUE;
3027 /* If the errors_reply_to field is set, check that it is syntactically valid
3028 and ensure it contains a domain. */
3030 if (errors_reply_to != NULL)
3033 int start, end, domain;
3034 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3035 &start, &end, &domain, FALSE);
3037 if (recipient == NULL)
3038 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3039 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3042 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3043 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3046 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3047 smtp_accept_max must also be set. */
3049 if (smtp_accept_max == 0 &&
3050 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3051 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3052 "smtp_accept_max must be set if smtp_accept_queue or "
3053 "smtp_accept_max_per_host is set");
3055 /* Set up the host number if anything is specified. It is an expanded string
3056 so that it can be computed from the host name, for example. We do this last
3057 so as to ensure that everything else is set up before the expansion. */
3059 if (host_number_string != NULL)
3062 uschar *s = expand_string(host_number_string);
3063 long int n = Ustrtol(s, &end, 0);
3064 while (isspace(*end)) end++;
3066 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3067 "localhost_number value is not a number: %s", s);
3068 if (n > LOCALHOST_MAX)
3069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3070 "localhost_number is greater than the maximum allowed value (%d)",
3076 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3078 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3079 tls_verify_certificates == NULL)
3080 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3081 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3082 (tls_verify_hosts != NULL)? "" : "try_");
3088 /*************************************************
3089 * Initialize one driver *
3090 *************************************************/
3092 /* This is called once the driver's generic options, if any, have been read.
3093 We can now find the driver, set up defaults for the private options, and
3094 unset any "set" bits in the private options table (which might have been
3095 set by another incarnation of the same driver).
3098 d pointer to driver instance block, with generic
3100 drivers_available vector of available drivers
3101 size_of_info size of each block in drivers_available
3102 class class of driver, for error message
3104 Returns: pointer to the driver info block
3107 static driver_info *
3108 init_driver(driver_instance *d, driver_info *drivers_available,
3109 int size_of_info, uschar *class)
3113 for (dd = drivers_available; dd->driver_name[0] != 0;
3114 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3116 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3119 int len = dd->options_len;
3121 d->options_block = store_get(len);
3122 memcpy(d->options_block, dd->options_block, len);
3123 for (i = 0; i < *(dd->options_count); i++)
3124 dd->options[i].type &= ~opt_set;
3129 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3130 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3132 return NULL; /* never obeyed */
3138 /*************************************************
3139 * Initialize driver list *
3140 *************************************************/
3142 /* This function is called for routers, transports, and authentication
3143 mechanisms. It reads the data from the current point in the configuration file
3144 up to the end of the section, and sets up a chain of instance blocks according
3145 to the file's contents. The file will already have been opened by a call to
3146 readconf_main, and must be left open for subsequent reading of further data.
3148 Any errors cause a panic crash. Note that the blocks with names driver_info and
3149 driver_instance must map the first portions of all the _info and _instance
3150 blocks for this shared code to work.
3153 class "router", "transport", or "authenticator"
3154 anchor &routers, &transports, &auths
3155 drivers_available available drivers
3156 size_of_info size of each info block
3157 instance_default points to default data for an instance
3158 instance_size size of instance block
3159 driver_optionlist generic option list
3160 driver_optionlist_count count of generic option list
3166 readconf_driver_init(
3168 driver_instance **anchor,
3169 driver_info *drivers_available,
3171 void *instance_default,
3173 optionlist *driver_optionlist,
3174 int driver_optionlist_count)
3176 driver_instance **p = anchor;
3177 driver_instance *d = NULL;
3180 while ((buffer = get_config_line()) != NULL)
3185 /* Read the first name on the line and test for the start of a new driver. A
3186 macro definition indicates the end of the previous driver. If this isn't the
3187 start of a new driver, the line will be re-read. */
3189 s = readconf_readname(name, sizeof(name), buffer);
3191 /* Handle macro definition, first finishing off the initialization of the
3192 previous driver, if any. */
3194 if (isupper(*name) && *s == '=')
3198 if (d->driver_name == NULL)
3199 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3200 "no driver defined for %s \"%s\"", class, d->name);
3204 read_macro_assignment(buffer);
3208 /* If the line starts with a name terminated by a colon, we are at the
3209 start of the definition of a new driver. The rest of the line must be
3216 /* Finish off initializing the previous driver. */
3220 if (d->driver_name == NULL)
3221 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3222 "no driver defined for %s \"%s\"", class, d->name);
3226 /* Check that we haven't already got a driver of this name */
3228 for (d = *anchor; d != NULL; d = d->next)
3229 if (Ustrcmp(name, d->name) == 0)
3230 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3231 "there are two %ss called \"%s\"", class, name);
3233 /* Set up a new driver instance data block on the chain, with
3234 its default values installed. */
3236 d = store_get(instance_size);
3237 memcpy(d, instance_default, instance_size);
3240 d->name = string_copy(name);
3242 /* Clear out the "set" bits in the generic options */
3244 for (i = 0; i < driver_optionlist_count; i++)
3245 driver_optionlist[i].type &= ~opt_set;
3247 /* Check nothing more on this line, then do the next loop iteration. */
3249 while (isspace(*s)) s++;
3250 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3254 /* Not the start of a new driver. Give an error if we have not set up a
3255 current driver yet. */
3257 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3258 "%s name missing", class);
3260 /* First look to see if this is a generic option; if it is "driver",
3261 initialize the driver. If is it not a generic option, we can look for a
3262 private option provided that the driver has been previously set up. */
3264 if (readconf_handle_option(buffer, driver_optionlist,
3265 driver_optionlist_count, d, NULL))
3267 if (d->info == NULL && d->driver_name != NULL)
3268 init_driver(d, drivers_available, size_of_info, class);
3271 /* Handle private options - pass the generic block because some may
3272 live therein. A flag with each option indicates if it is in the public
3275 else if (d->info != NULL)
3277 readconf_handle_option(buffer, d->info->options,
3278 *(d->info->options_count), d, US"option \"%s\" unknown");
3281 /* The option is not generic and the driver name has not yet been given. */
3283 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3284 "(\"driver\" must be specified before any private options)", name);
3287 /* Run the initialization function for the final driver. */
3291 if (d->driver_name == NULL)
3292 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3293 "no driver defined for %s \"%s\"", class, d->name);
3300 /*************************************************
3301 * Check driver dependency *
3302 *************************************************/
3304 /* This function is passed a driver instance and a string. It checks whether
3305 any of the string options for the driver contains the given string as an
3309 d points to a driver instance block
3310 s the string to search for
3312 Returns: TRUE if a dependency is found
3316 readconf_depends(driver_instance *d, uschar *s)
3318 int count = *(d->info->options_count);
3322 for (ol = d->info->options; ol < d->info->options + count; ol++)
3324 void *options_block;
3326 int type = ol->type & opt_mask;
3327 if (type != opt_stringptr) continue;
3328 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3329 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3330 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3332 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3333 isalnum(ss[Ustrlen(s)])) continue;
3334 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3335 d->name, ol->name, s);
3340 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3347 /*************************************************
3348 * Decode an error type for retries *
3349 *************************************************/
3351 /* This function is global because it is also called from the main
3352 program when testing retry information. It decodes strings such as "quota_7d"
3353 into numerical error codes.
3356 pp points to start of text
3357 p points past end of text
3358 basic_errno points to an int to receive the main error number
3359 more_errno points to an int to receive the secondary error data
3361 Returns: NULL if decoded correctly; else points to error text
3365 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3369 while (q < p && *q != '_') q++;
3372 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3374 *basic_errno = ERRNO_EXIMQUOTA;
3375 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3376 return US"bad time value";
3379 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3381 *basic_errno = ECONNREFUSED;
3384 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3385 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3386 else return US"A or MX expected after \"refused\"";
3390 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3392 *basic_errno = ETIMEDOUT;
3396 int xlen = p - q - 1;
3399 static uschar *extras[] =
3400 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3401 static int values[] =
3402 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3404 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3406 if (strncmpic(x, extras[i], xlen) == 0)
3408 *more_errno = values[i];
3413 if (i >= sizeof(extras)/sizeof(uschar *))
3415 if (strncmpic(x, US"DNS", xlen) == 0)
3417 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3418 "available in retry rules (it has never worked) - treated as "
3421 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3426 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3427 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3428 strncmpic(pp, US"data_4", 6) == 0)
3431 int x = 255; /* means "any 4xx code" */
3432 if (p != pp + 8) bad = TRUE; else
3434 int a = pp[6], b = pp[7];
3438 if (isdigit(b)) x += b - '0';
3439 else if (b == 'x') x += 100;
3442 else if (a != 'x' || b != 'x') bad = TRUE;
3446 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3447 "x is literal and d is any digit", pp);
3449 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3450 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3451 *more_errno = x << 8;
3454 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3455 strncmpic(q+1, US"failed", p-q-1) == 0)
3456 *basic_errno = ERRNO_AUTHFAIL;
3458 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3459 *basic_errno = ERRNO_SMTPCLOSED;
3461 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3462 *basic_errno = ERRNO_TLSREQUIRED;
3464 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3465 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3473 /*************************************************
3474 * Read retry information *
3475 *************************************************/
3477 /* Each line of retry information contains:
3479 . A domain name pattern or an address pattern;
3481 . An error name, possibly with additional data, or *;
3483 . An optional sequence of retry items, each consisting of an identifying
3484 letter, a cutoff time, and optional parameters.
3486 All this is decoded and placed into a control block. */
3489 /* Subroutine to read an argument, preceded by a comma and terminated
3490 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3491 1 = fixed point number (returned *1000).
3494 paddr pointer to pointer to current character; updated
3495 type 0 => read a time; 1 => read a fixed point number
3497 Returns: time in seconds or fixed point number * 1000
3501 retry_arg(uschar **paddr, int type)
3506 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3508 while (isspace(*p)) p++;
3510 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3512 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3513 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3519 return readconf_readtime(pp, *p, FALSE);
3521 return readconf_readfixed(pp, *p);
3523 return 0; /* Keep picky compilers happy */
3526 /* The function proper */
3529 readconf_retries(void)
3531 retry_config **chain = &retries;
3535 while ((p = get_config_line()) != NULL)
3537 retry_rule **rchain;
3540 next = store_get(sizeof(retry_config));
3543 chain = &(next->next);
3544 next->basic_errno = next->more_errno = 0;
3545 next->senders = NULL;
3547 rchain = &(next->rules);
3549 next->pattern = string_dequote(&p);
3550 while (isspace(*p)) p++;
3552 while (mac_isgraph(*p)) p++;
3553 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3554 "missing error type");
3556 /* Test error names for things we understand. */
3558 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3559 &(next->more_errno))) != NULL)
3560 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3562 /* There may be an optional address list of senders to be used as another
3563 constraint on the rule. This was added later, so the syntax is a bit of a
3564 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3567 while (isspace(*p)) p++;
3568 if (Ustrncmp(p, "senders", 7) == 0)
3571 while (isspace(*p)) p++;
3572 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3573 "\"=\" expected after \"senders\" in retry rule");
3574 while (isspace(*p)) p++;
3575 next->senders = string_dequote(&p);
3578 /* Now the retry rules. Keep the maximum timeout encountered. */
3580 while (isspace(*p)) p++;
3584 retry_rule *rule = store_get(sizeof(retry_rule));
3586 rchain = &(rule->next);
3588 rule->rule = toupper(*p++);
3589 rule->timeout = retry_arg(&p, 0);
3590 if (rule->timeout > retry_maximum_timeout)
3591 retry_maximum_timeout = rule->timeout;
3595 case 'F': /* Fixed interval */
3596 rule->p1 = retry_arg(&p, 0);
3599 case 'G': /* Geometrically increasing intervals */
3600 case 'H': /* Ditto, but with randomness */
3601 rule->p1 = retry_arg(&p, 0);
3602 rule->p2 = retry_arg(&p, 1);
3606 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3610 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3611 (rule->rule != 'F' && rule->p2 < 1000))
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3613 "bad parameters for retry rule");
3615 while (isspace(*p)) p++;
3619 while (isspace(*p)) p++;
3622 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3629 /*************************************************
3630 * Initialize authenticators *
3631 *************************************************/
3633 /* Read the authenticators section of the configuration file.
3642 auth_instance *au, *bu;
3643 readconf_driver_init(US"authenticator",
3644 (driver_instance **)(&auths), /* chain anchor */
3645 (driver_info *)auths_available, /* available drivers */
3646 sizeof(auth_info), /* size of info block */
3647 &auth_defaults, /* default values for generic options */
3648 sizeof(auth_instance), /* size of instance block */
3649 optionlist_auths, /* generic options */
3650 optionlist_auths_size);
3652 for (au = auths; au != NULL; au = au->next)
3654 if (au->public_name == NULL)
3655 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3656 "the %s authenticator", au->name);
3657 for (bu = au->next; bu != NULL; bu = bu->next)
3659 if (strcmpic(au->public_name, bu->public_name) == 0)
3661 if ((au->client && bu->client) || (au->server && bu->server))
3662 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3663 "(%s and %s) have the same public name (%s)",
3664 (au->client)? US"client" : US"server", au->name, bu->name,
3674 /*************************************************
3675 * Read ACL information *
3676 *************************************************/
3678 /* If this run of Exim is not doing something that involves receiving a
3679 message, we can just skip over the ACL information. No need to parse it.
3681 First, we have a function for acl_read() to call back to get the next line. We
3682 need to remember the line we passed, because at the end it will contain the
3683 name of the next ACL. */
3685 static uschar *acl_line;
3690 acl_line = get_config_line();
3695 /* Now the main function:
3698 skip TRUE when this Exim process is doing something that will
3699 not need the ACL data
3705 readconf_acl(BOOL skip)
3709 /* Not receiving messages, don't need to parse the ACL data */
3713 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3714 while ((p = get_config_line()) != NULL);
3718 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3721 acl_line = get_config_line();
3723 while(acl_line != NULL)
3729 p = readconf_readname(name, sizeof(name), acl_line);
3730 if (isupper(*name) && *p == '=')
3732 read_macro_assignment(acl_line);
3733 acl_line = get_config_line();
3737 if (*p != ':' || name[0] == 0)
3738 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3740 node = store_get(sizeof(tree_node) + Ustrlen(name));
3741 Ustrcpy(node->name, name);
3742 if (!tree_insertnode(&acl_anchor, node))
3743 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3744 "there are two ACLs called \"%s\"", name);
3746 node->data.ptr = acl_read(acl_callback, &error);
3748 if (node->data.ptr == NULL && error != NULL)
3749 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3755 /*************************************************
3756 * Read configuration for local_scan() *
3757 *************************************************/
3759 /* This function is called after "begin local_scan" is encountered in the
3760 configuration file. If the local_scan() function allows for configuration
3761 options, we can process them. Otherwise, we expire in a panic.
3768 local_scan_init(void)
3770 #ifndef LOCAL_SCAN_HAS_OPTIONS
3771 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3772 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3776 while ((p = get_config_line()) != NULL)
3778 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3779 NULL, US"local_scan option \"%s\" unknown");
3786 /*************************************************
3787 * Read rest of configuration (after main) *
3788 *************************************************/
3790 /* This function reads the rest of the runtime configuration, after the main
3791 configuration. It is called only when actually needed. Each subsequent section
3792 of the configuration starts with a line of the form
3796 where the name is "routers", "transports", etc. A section is terminated by
3797 hitting the next "begin" line, and the next name is left in next_section.
3798 Because it may confuse people as to whether the names are singular or plural,
3799 we add "s" if it's missing. There is always enough room in next_section for
3800 this. This function is basically just a switch.
3803 skip_acl TRUE if ACL information is not needed
3808 static uschar *section_list[] = {
3818 readconf_rest(BOOL skip_acl)
3822 while(next_section[0] != 0)
3826 int last = sizeof(section_list) / sizeof(uschar *);
3828 int n = Ustrlen(next_section);
3830 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3834 int c = strcmpic(next_section, section_list[mid]);
3836 if (c > 0) first = mid + 1; else last = mid;
3838 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3839 "\"%.*s\" is not a known configuration section name", n, next_section);
3840 mid = (last + first)/2;
3844 if (((had ^= bit) & bit) == 0)
3845 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3846 "\"%.*s\" section is repeated in the configuration file", n,
3851 case 0: readconf_acl(skip_acl); break;
3852 case 1: auths_init(); break;
3853 case 2: local_scan_init(); break;
3854 case 3: readconf_retries(); break;
3855 case 4: readconf_rewrites(); break;
3856 case 5: route_init(); break;
3857 case 6: transport_init(); break;
3861 (void)fclose(config_file);
3864 /* End of readconf.c */