1 /* $Cambridge: exim/src/src/readconf.c,v 1.32 2007/08/22 10:10:23 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions for reading the configuration file, and for displaying
11 overall configuration values. Thanks to Brian Candler for the original
12 implementation of the conditional .ifdef etc. */
16 #define CSTATE_STACK_SIZE 10
19 /* Structure for chain (stack) of .included files */
21 typedef struct config_file_item {
22 struct config_file_item *next;
28 /* Structure of table of conditional words and their state transitions */
30 typedef struct cond_item {
38 /* Structure of table of syslog facility names and values */
40 typedef struct syslog_fac_item {
46 /* Static variables */
48 static config_file_item *config_file_stack = NULL; /* For includes */
50 static uschar *syslog_facility_str = NULL;
51 static uschar next_section[24];
52 static uschar time_buffer[24];
54 /* State variables for conditional loading (.ifdef / .else / .endif) */
56 static int cstate = 0;
57 static int cstate_stack_ptr = -1;
58 static int cstate_stack[CSTATE_STACK_SIZE];
60 /* Table of state transitions for handling conditional inclusions. There are
61 four possible state transitions:
65 .elifdef true (or .else)
68 .endif just causes the previous cstate to be popped off the stack */
70 static int next_cstate[3][4] =
72 /* State 0: reading from file, or reading until next .else or .endif */
74 /* State 1: condition failed, skipping until next .else or .endif */
76 /* State 2: skipping until .endif */
80 /* Table of conditionals and the states to set. For each name, there are four
81 values: the length of the name (to save computing it each time), the state to
82 set if a macro was found in the line, the state to set if a macro was not found
83 in the line, and a stack manipulation setting which is:
85 -1 pull state value off the stack
86 0 don't alter the stack
87 +1 push value onto stack, before setting new state
90 static cond_item cond_list[] = {
91 { US"ifdef", 5, 0, 1, 1 },
92 { US"ifndef", 6, 1, 0, 1 },
93 { US"elifdef", 7, 2, 3, 0 },
94 { US"elifndef", 8, 3, 2, 0 },
95 { US"else", 4, 2, 2, 0 },
96 { US"endif", 5, 0, 0, -1 }
99 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
101 /* Table of syslog facility names and their values */
103 static syslog_fac_item syslog_list[] = {
104 { US"mail", LOG_MAIL },
105 { US"user", LOG_USER },
106 { US"news", LOG_NEWS },
107 { US"uucp", LOG_UUCP },
108 { US"local0", LOG_LOCAL0 },
109 { US"local1", LOG_LOCAL1 },
110 { US"local2", LOG_LOCAL2 },
111 { US"local3", LOG_LOCAL3 },
112 { US"local4", LOG_LOCAL4 },
113 { US"local5", LOG_LOCAL5 },
114 { US"local6", LOG_LOCAL6 },
115 { US"local7", LOG_LOCAL7 },
116 { US"daemon", LOG_DAEMON }
119 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
124 /*************************************************
125 * Main configuration options *
126 *************************************************/
128 /* The list of options that can be set in the main configuration file. This
129 must be in alphabetic order because it is searched by binary chop. */
131 static optionlist optionlist_config[] = {
132 { "*set_exim_group", opt_bool|opt_hidden, &exim_gid_set },
133 { "*set_exim_user", opt_bool|opt_hidden, &exim_uid_set },
134 { "*set_system_filter_group", opt_bool|opt_hidden, &system_filter_gid_set },
135 { "*set_system_filter_user", opt_bool|opt_hidden, &system_filter_uid_set },
136 { "accept_8bitmime", opt_bool, &accept_8bitmime },
137 { "acl_not_smtp", opt_stringptr, &acl_not_smtp },
138 #ifdef WITH_CONTENT_SCAN
139 { "acl_not_smtp_mime", opt_stringptr, &acl_not_smtp_mime },
141 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
142 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
143 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
144 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
145 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
146 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
147 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
148 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
149 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
150 #ifdef WITH_CONTENT_SCAN
151 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
153 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
154 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
155 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
156 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
158 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
160 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
161 { "admin_groups", opt_gidlist, &admin_groups },
162 { "allow_domain_literals", opt_bool, &allow_domain_literals },
163 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
164 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
165 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
166 { "auto_thaw", opt_time, &auto_thaw },
167 #ifdef WITH_CONTENT_SCAN
168 { "av_scanner", opt_stringptr, &av_scanner },
170 { "bi_command", opt_stringptr, &bi_command },
171 #ifdef EXPERIMENTAL_BRIGHTMAIL
172 { "bmi_config_file", opt_stringptr, &bmi_config_file },
174 { "bounce_message_file", opt_stringptr, &bounce_message_file },
175 { "bounce_message_text", opt_stringptr, &bounce_message_text },
176 { "bounce_return_body", opt_bool, &bounce_return_body },
177 { "bounce_return_message", opt_bool, &bounce_return_message },
178 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
179 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
180 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
181 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
182 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
183 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
184 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
185 { "check_log_inodes", opt_int, &check_log_inodes },
186 { "check_log_space", opt_Kint, &check_log_space },
187 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
188 { "check_spool_inodes", opt_int, &check_spool_inodes },
189 { "check_spool_space", opt_Kint, &check_spool_space },
190 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
191 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
192 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
193 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
194 { "delay_warning", opt_timelist, &delay_warning },
195 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
196 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
197 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
198 { "delivery_date_remove", opt_bool, &delivery_date_remove },
199 #ifdef ENABLE_DISABLE_FSYNC
200 { "disable_fsync", opt_bool, &disable_fsync },
202 { "disable_ipv6", opt_bool, &disable_ipv6 },
203 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
204 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
205 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
206 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
207 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
208 { "dns_retrans", opt_time, &dns_retrans },
209 { "dns_retry", opt_int, &dns_retry },
210 /* This option is now a no-op, retained for compability */
211 { "drop_cr", opt_bool, &drop_cr },
212 /*********************************************************/
213 { "dsn_from", opt_stringptr, &dsn_from },
214 { "envelope_to_remove", opt_bool, &envelope_to_remove },
215 { "errors_copy", opt_stringptr, &errors_copy },
216 { "errors_reply_to", opt_stringptr, &errors_reply_to },
217 { "exim_group", opt_gid, &exim_gid },
218 { "exim_path", opt_stringptr, &exim_path },
219 { "exim_user", opt_uid, &exim_uid },
220 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
221 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
222 { "finduser_retries", opt_int, &finduser_retries },
223 { "freeze_tell", opt_stringptr, &freeze_tell },
224 { "gecos_name", opt_stringptr, &gecos_name },
225 { "gecos_pattern", opt_stringptr, &gecos_pattern },
227 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
228 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
229 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
231 { "header_line_maxsize", opt_int, &header_line_maxsize },
232 { "header_maxsize", opt_int, &header_maxsize },
233 { "headers_charset", opt_stringptr, &headers_charset },
234 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
235 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
236 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
237 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
238 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
239 { "hold_domains", opt_stringptr, &hold_domains },
240 { "host_lookup", opt_stringptr, &host_lookup },
241 { "host_lookup_order", opt_stringptr, &host_lookup_order },
242 { "host_reject_connection", opt_stringptr, &host_reject_connection },
243 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
244 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
246 { "ibase_servers", opt_stringptr, &ibase_servers },
248 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
249 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
250 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
251 { "keep_malformed", opt_time, &keep_malformed },
253 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
254 { "ldap_version", opt_int, &eldap_version },
256 { "local_from_check", opt_bool, &local_from_check },
257 { "local_from_prefix", opt_stringptr, &local_from_prefix },
258 { "local_from_suffix", opt_stringptr, &local_from_suffix },
259 { "local_interfaces", opt_stringptr, &local_interfaces },
260 { "local_scan_timeout", opt_time, &local_scan_timeout },
261 { "local_sender_retain", opt_bool, &local_sender_retain },
262 { "localhost_number", opt_stringptr, &host_number_string },
263 { "log_file_path", opt_stringptr, &log_file_path },
264 { "log_selector", opt_stringptr, &log_selector_string },
265 { "log_timezone", opt_bool, &log_timezone },
266 { "lookup_open_max", opt_int, &lookup_open_max },
267 { "max_username_length", opt_int, &max_username_length },
268 { "message_body_visible", opt_mkint, &message_body_visible },
269 { "message_id_header_domain", opt_stringptr, &message_id_domain },
270 { "message_id_header_text", opt_stringptr, &message_id_text },
271 { "message_logs", opt_bool, &message_logs },
272 { "message_size_limit", opt_stringptr, &message_size_limit },
273 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
274 { "move_frozen_messages", opt_bool, &move_frozen_messages },
276 { "mua_wrapper", opt_bool, &mua_wrapper },
278 { "mysql_servers", opt_stringptr, &mysql_servers },
280 { "never_users", opt_uidlist, &never_users },
282 { "oracle_servers", opt_stringptr, &oracle_servers },
284 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
286 { "perl_at_start", opt_bool, &opt_perl_at_start },
287 { "perl_startup", opt_stringptr, &opt_perl_startup },
290 { "pgsql_servers", opt_stringptr, &pgsql_servers },
292 { "pid_file_path", opt_stringptr, &pid_file_path },
293 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
294 { "preserve_message_logs", opt_bool, &preserve_message_logs },
295 { "primary_hostname", opt_stringptr, &primary_hostname },
296 { "print_topbitchars", opt_bool, &print_topbitchars },
297 { "process_log_path", opt_stringptr, &process_log_path },
298 { "prod_requires_admin", opt_bool, &prod_requires_admin },
299 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
300 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
301 { "queue_domains", opt_stringptr, &queue_domains },
302 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
303 { "queue_only", opt_bool, &queue_only },
304 { "queue_only_file", opt_stringptr, &queue_only_file },
305 { "queue_only_load", opt_fixed, &queue_only_load },
306 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
307 { "queue_only_override", opt_bool, &queue_only_override },
308 { "queue_run_in_order", opt_bool, &queue_run_in_order },
309 { "queue_run_max", opt_int, &queue_run_max },
310 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
311 { "receive_timeout", opt_time, &receive_timeout },
312 { "received_header_text", opt_stringptr, &received_header_text },
313 { "received_headers_max", opt_int, &received_headers_max },
314 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
315 { "recipients_max", opt_int, &recipients_max },
316 { "recipients_max_reject", opt_bool, &recipients_max_reject },
317 { "remote_max_parallel", opt_int, &remote_max_parallel },
318 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
319 { "retry_data_expire", opt_time, &retry_data_expire },
320 { "retry_interval_max", opt_time, &retry_interval_max },
321 { "return_path_remove", opt_bool, &return_path_remove },
322 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
323 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
324 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
325 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
326 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
327 { "smtp_accept_max", opt_int, &smtp_accept_max },
328 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
329 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
330 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
331 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
332 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
333 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
334 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
335 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
336 { "smtp_banner", opt_stringptr, &smtp_banner },
337 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
338 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
339 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
340 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
341 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
342 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
343 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
344 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
345 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
346 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
347 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
348 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
349 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
350 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
351 #ifdef WITH_CONTENT_SCAN
352 { "spamd_address", opt_stringptr, &spamd_address },
354 { "split_spool_directory", opt_bool, &split_spool_directory },
355 { "spool_directory", opt_stringptr, &spool_directory },
357 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
359 #ifdef EXPERIMENTAL_SRS
360 { "srs_config", opt_stringptr, &srs_config },
361 { "srs_hashlength", opt_int, &srs_hashlength },
362 { "srs_hashmin", opt_int, &srs_hashmin },
363 { "srs_maxage", opt_int, &srs_maxage },
364 { "srs_secrets", opt_stringptr, &srs_secrets },
365 { "srs_usehash", opt_bool, &srs_usehash },
366 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
368 { "strict_acl_vars", opt_bool, &strict_acl_vars },
369 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
370 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
371 { "syslog_duplication", opt_bool, &syslog_duplication },
372 { "syslog_facility", opt_stringptr, &syslog_facility_str },
373 { "syslog_processname", opt_stringptr, &syslog_processname },
374 { "syslog_timestamp", opt_bool, &syslog_timestamp },
375 { "system_filter", opt_stringptr, &system_filter },
376 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
377 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
378 { "system_filter_group", opt_gid, &system_filter_gid },
379 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
380 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
381 { "system_filter_user", opt_uid, &system_filter_uid },
382 { "tcp_nodelay", opt_bool, &tcp_nodelay },
383 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
384 { "timezone", opt_stringptr, &timezone_string },
386 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
387 { "tls_certificate", opt_stringptr, &tls_certificate },
388 { "tls_crl", opt_stringptr, &tls_crl },
389 { "tls_dhparam", opt_stringptr, &tls_dhparam },
390 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
391 { "tls_privatekey", opt_stringptr, &tls_privatekey },
392 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
393 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
394 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
395 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
396 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
398 { "trusted_groups", opt_gidlist, &trusted_groups },
399 { "trusted_users", opt_uidlist, &trusted_users },
400 { "unknown_login", opt_stringptr, &unknown_login },
401 { "unknown_username", opt_stringptr, &unknown_username },
402 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
403 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
404 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
405 { "warn_message_file", opt_stringptr, &warn_message_file },
406 { "write_rejectlog", opt_bool, &write_rejectlog }
409 static int optionlist_config_size =
410 sizeof(optionlist_config)/sizeof(optionlist);
414 /*************************************************
415 * Find the name of an option *
416 *************************************************/
418 /* This function is to aid debugging. Various functions take arguments that are
419 pointer variables in the options table or in option tables for various drivers.
420 For debugging output, it is useful to be able to find the name of the option
421 which is currently being processed. This function finds it, if it exists, by
422 searching the table(s).
424 Arguments: a value that is presumed to be in the table above
425 Returns: the option name, or an empty string
429 readconf_find_option(void *p)
433 transport_instance *t;
435 for (i = 0; i < optionlist_config_size; i++)
436 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
438 for (r = routers; r != NULL; r = r->next)
440 router_info *ri = r->info;
441 for (i = 0; i < ri->options_count[0]; i++)
443 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
444 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
445 return US ri->options[i].name;
449 for (t = transports; t != NULL; t = t->next)
451 transport_info *ti = t->info;
452 for (i = 0; i < ti->options_count[0]; i++)
454 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
455 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
456 return US ti->options[i].name;
466 /*************************************************
467 * Deal with an assignment to a macro *
468 *************************************************/
470 /* This function is called when a line that starts with an upper case letter is
471 encountered. The argument "line" should contain a complete logical line, and
472 start with the first letter of the macro name. The macro name and the
473 replacement text are extracted and stored. Redefinition of existing,
474 non-command line, macros is permitted using '==' instead of '='.
477 s points to the start of the logical line
483 read_macro_assignment(uschar *s)
489 macro_item *mlast = NULL;
491 while (isalnum(*s) || *s == '_')
493 if (namelen >= sizeof(name) - 1)
494 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
495 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
496 name[namelen++] = *s++;
500 while (isspace(*s)) s++;
502 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
509 while (isspace(*s)) s++;
511 /* If an existing macro of the same name was defined on the command line, we
512 just skip this definition. It's an error to attempt to redefine a macro without
513 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
514 It is also an error to define a macro whose name begins with the name of a
515 previously defined macro. Note: it is documented that the other way round
518 for (m = macros; m != NULL; m = m->next)
520 int len = Ustrlen(m->name);
522 if (Ustrcmp(m->name, name) == 0)
524 if (!m->command_line && !redef)
525 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
526 "defined (use \"==\" if you want to redefine it", name);
530 if (len < namelen && Ustrstr(name, m->name) != NULL)
531 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
532 "a macro because previously defined macro \"%s\" is a substring",
535 /* We cannot have this test, because it is documented that a substring
536 macro is permitted (there is even an example).
538 * if (len > namelen && Ustrstr(m->name, name) != NULL)
539 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
540 * "a macro because it is a substring of previously defined macro \"%s\"",
547 /* Check for an overriding command-line definition. */
549 if (m != NULL && m->command_line) return;
551 /* Redefinition must refer to an existing macro. */
556 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
560 /* We have a new definition. The macro_item structure includes a final vector
561 called "name" which is one byte long. Thus, adding "namelen" gives us enough
562 room to store the "name" string. */
566 m = store_get(sizeof(macro_item) + namelen);
567 if (macros == NULL) macros = m; else mlast->next = m;
568 Ustrncpy(m->name, name, namelen);
569 m->name[namelen] = 0;
571 m->command_line = FALSE;
574 /* Set the value of the new or redefined macro */
576 m->replacement = string_copy(s);
583 /*************************************************
584 * Read configuration line *
585 *************************************************/
587 /* A logical line of text is read from the configuration file into the big
588 buffer, taking account of macros, .includes, and continuations. The size of
589 big_buffer is increased if necessary. The count of configuration lines is
590 maintained. Physical input lines starting with # (ignoring leading white space,
591 and after macro replacement) and empty logical lines are always ignored.
592 Leading and trailing spaces are removed.
594 If we hit a line of the form "begin xxxx", the xxxx is placed in the
595 next_section vector, and the function returns NULL, indicating the end of a
596 configuration section. On end-of-file, NULL is returned with next_section
601 Returns: a pointer to the first non-blank in the line,
602 or NULL if eof or end of section is reached
606 get_config_line(void)
608 int startoffset = 0; /* To first non-blank char in logical line */
609 int len = 0; /* Of logical line so far */
615 /* Loop for handling continuation lines, skipping comments, and dealing with
620 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
622 if (config_file_stack != NULL) /* EOF inside .include */
624 (void)fclose(config_file);
625 config_file = config_file_stack->file;
626 config_filename = config_file_stack->filename;
627 config_lineno = config_file_stack->lineno;
628 config_file_stack = config_file_stack->next;
632 /* EOF at top level */
634 if (cstate_stack_ptr >= 0)
635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
636 "Unexpected end of configuration file: .endif missing");
638 if (len != 0) break; /* EOF after continuation */
639 next_section[0] = 0; /* EOF at start of logical line */
644 newlen = len + Ustrlen(big_buffer + len);
646 /* Handle pathologically long physical lines - yes, it did happen - by
647 extending big_buffer at this point. The code also copes with very long
650 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
653 big_buffer_size += BIG_BUFFER_SIZE;
654 newbuffer = store_malloc(big_buffer_size);
656 /* This use of strcpy is OK because we know that the string in the old
657 buffer is shorter than the new buffer. */
659 Ustrcpy(newbuffer, big_buffer);
660 store_free(big_buffer);
661 big_buffer = newbuffer;
662 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
664 newlen += Ustrlen(big_buffer + newlen);
667 /* Find the true start of the physical line - leading spaces are always
670 ss = big_buffer + len;
671 while (isspace(*ss)) ss++;
673 /* Process the physical line for macros. If this is the start of the logical
674 line, skip over initial text at the start of the line if it starts with an
675 upper case character followed by a sequence of name characters and an equals
676 sign, because that is the definition of a new macro, and we don't do
677 replacement therein. */
680 if (len == 0 && isupper(*s))
682 while (isalnum(*s) || *s == '_') s++;
683 while (isspace(*s)) s++;
684 if (*s != '=') s = ss; /* Not a macro definition */
687 /* For each defined macro, scan the line (from after XXX= if present),
688 replacing all occurrences of the macro. */
691 for (m = macros; m != NULL; m = m->next)
696 while ((p = Ustrstr(t, m->name)) != NULL)
699 int namelen = Ustrlen(m->name);
700 int replen = Ustrlen(m->replacement);
702 /* Expand the buffer if necessary */
704 while (newlen - namelen + replen + 1 > big_buffer_size)
706 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
707 uschar *newbuffer = store_malloc(newsize);
708 memcpy(newbuffer, big_buffer, newlen + 1);
709 p = newbuffer + (p - big_buffer);
710 s = newbuffer + (s - big_buffer);
711 ss = newbuffer + (ss - big_buffer);
712 t = newbuffer + (t - big_buffer);
713 big_buffer_size = newsize;
714 store_free(big_buffer);
715 big_buffer = newbuffer;
718 /* Shuffle the remaining characters up or down in the buffer before
719 copying in the replacement text. Don't rescan the replacement for this
723 moveby = replen - namelen;
726 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
729 Ustrncpy(p, m->replacement, replen);
735 /* An empty macro replacement at the start of a line could mean that ss no
736 longer points to the first non-blank character. */
738 while (isspace(*ss)) ss++;
740 /* Check for comment lines - these are physical lines. */
742 if (*ss == '#') continue;
744 /* Handle conditionals, which are also applied to physical lines. Conditions
745 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
746 expansion occured on the rest of the line. A preliminary test for the leading
747 '.' saves effort on most lines. */
753 /* Search the list of conditional directives */
755 for (i = 0; i < cond_list_size; i++)
758 cond_item *c = cond_list+i;
759 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
761 /* The following character must be white space or end of string */
763 n = ss[1 + c->namelen];
764 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
766 /* .ifdef and .ifndef push the current state onto the stack, then set
767 a new one from the table. Stack overflow is an error */
771 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
772 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
773 ".%s nested too deeply", c->name);
774 cstate_stack[++cstate_stack_ptr] = cstate;
775 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
778 /* For any of the others, stack underflow is an error. The next state
779 comes either from the stack (.endif) or from the table. */
783 if (cstate_stack_ptr < 0)
784 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
785 ".%s without matching .ifdef", c->name);
786 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
787 next_cstate[cstate][macro_found? c->action1 : c->action2];
790 /* Having dealt with a directive, break the loop */
795 /* If we have handled a conditional directive, continue with the next
796 physical line. Otherwise, fall through. */
798 if (i < cond_list_size) continue;
801 /* If the conditional state is not 0 (actively using these lines), ignore
804 if (cstate != 0) continue; /* Conditional skip */
806 /* Handle .include lines - these are also physical lines. */
808 if (Ustrncmp(ss, ".include", 8) == 0 &&
810 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
813 int include_if_exists = isspace(ss[8])? 0 : 10;
814 config_file_item *save;
817 ss += 9 + include_if_exists;
818 while (isspace(*ss)) ss++;
819 t = ss + Ustrlen(ss);
820 while (t > ss && isspace(t[-1])) t--;
821 if (*ss == '\"' && t[-1] == '\"')
829 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
830 "absolute path \"%s\"", ss);
832 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
834 save = store_get(sizeof(config_file_item));
835 save->next = config_file_stack;
836 config_file_stack = save;
837 save->file = config_file;
838 save->filename = config_filename;
839 save->lineno = config_lineno;
841 config_file = Ufopen(ss, "rb");
842 if (config_file == NULL)
843 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
844 "configuration file %s", ss);
845 config_filename = string_copy(ss);
850 /* If this is the start of the logical line, remember where the non-blank
851 data starts. Otherwise shuffle down continuation lines to remove leading
855 startoffset = ss - big_buffer;
858 s = big_buffer + len;
861 memmove(s, ss, (newlen - len) - (ss - s) + 1);
866 /* Accept the new addition to the line. Remove trailing white space. */
869 while (len > 0 && isspace(big_buffer[len-1])) len--;
872 /* We are done if the line does not end in backslash and contains some data.
873 Empty logical lines are ignored. For continuations, remove the backslash and
874 go round the loop to read the continuation line. */
878 if (big_buffer[len-1] != '\\') break; /* End of logical line */
879 big_buffer[--len] = 0; /* Remove backslash */
881 } /* Loop for reading multiple physical lines */
883 /* We now have a logical line. Test for the end of a configuration section (or,
884 more accurately, for the start of the next section). Place the name of the next
885 section in next_section, and return NULL. If the name given is longer than
886 next_section, truncate it. It will be unrecognized later, because all the known
887 section names do fit. Leave space for pluralizing. */
889 s = big_buffer + startoffset; /* First non-space character */
890 if (strncmpic(s, US"begin ", 6) == 0)
893 while (isspace(*s)) s++;
894 if (big_buffer + len - s > sizeof(next_section) - 2)
895 s[sizeof(next_section) - 2] = 0;
896 Ustrcpy(next_section, s);
900 /* Return the first non-blank character. */
907 /*************************************************
909 *************************************************/
911 /* The yield is the pointer to the next uschar. Names longer than the
912 output space are silently truncated. This function is also used from acl.c when
916 name where to put the name
920 Returns: new input pointer
924 readconf_readname(uschar *name, int len, uschar *s)
927 while (isspace(*s)) s++;
930 while (isalnum(*s) || *s == '_')
932 if (p < len-1) name[p++] = *s;
937 while (isspace(*s)) s++;
944 /*************************************************
945 * Read a time value *
946 *************************************************/
948 /* This function is also called from outside, to read argument
949 time values. The format of a time value is:
951 [<n>w][<n>d][<n>h][<n>m][<n>s]
953 as long as at least one is present. If a format error is encountered,
954 return a negative value. The value must be terminated by the given
959 terminator required terminating character
960 return_msec if TRUE, allow fractional seconds and return milliseconds
962 Returns: the time value, or -1 on syntax error
963 value is seconds if return_msec is FALSE
964 value is milliseconds if return_msec is TRUE
968 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
976 if (!isdigit(*s)) return -1;
977 (void)sscanf(CS s, "%d%n", &value, &count);
982 case 'w': value *= 7;
983 case 'd': value *= 24;
984 case 'h': value *= 60;
985 case 'm': value *= 60;
990 if (!return_msec) return -1;
991 (void)sscanf(CS s, "%lf%n", &fraction, &count);
993 if (*s++ != 's') return -1;
994 yield += (int)(fraction * 1000.0);
1000 if (return_msec) value *= 1000;
1002 if (*s == terminator) return yield;
1004 /* Control never reaches here. */
1009 /*************************************************
1010 * Read a fixed point value *
1011 *************************************************/
1013 /* The value is returned *1000
1017 terminator required terminator
1019 Returns: the value, or -1 on error
1023 readconf_readfixed(uschar *s, int terminator)
1027 if (!isdigit(*s)) return -1;
1028 (void)sscanf(CS s, "%d%n", &value, &count);
1030 yield = value * 1000;
1034 while (isdigit((*(++s))))
1036 yield += (*s - '0') * m;
1041 return (*s == terminator)? yield : (-1);
1046 /*************************************************
1047 * Find option in list *
1048 *************************************************/
1050 /* The lists are always in order, so binary chop can be used.
1053 name the option name to search for
1054 ol the first entry in the option list
1055 last one more than the offset of the last entry in the option list
1057 Returns: pointer to an option entry, or NULL if not found
1061 find_option(uschar *name, optionlist *ol, int last)
1064 while (last > first)
1066 int middle = (first + last)/2;
1067 int c = Ustrcmp(name, ol[middle].name);
1068 if (c == 0) return ol + middle;
1069 else if (c > 0) first = middle + 1;
1077 /*************************************************
1078 * Find a set flag in option list *
1079 *************************************************/
1081 /* Because some versions of Unix make no restrictions on the values of uids and
1082 gids (even negative ones), we cannot represent "unset" by a special value.
1083 There is therefore a separate boolean variable for each one indicating whether
1084 a value is set or not. This function returns a pointer to the boolean, given
1085 the original option name. It is a major disaster if the flag cannot be found.
1088 name the name of the uid or gid option
1089 oltop points to the start of the relevant option list
1090 last one more than the offset of the last item in the option list
1091 data_block NULL when reading main options => data values in the option
1092 list are absolute addresses; otherwise they are byte offsets
1093 in data_block (used for driver options)
1095 Returns: a pointer to the boolean flag.
1099 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1103 sprintf(CS name2, "*set_%.50s", name);
1104 ol = find_option(name2, oltop, last);
1105 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1106 "Exim internal error: missing set flag for %s", name);
1107 return (data_block == NULL)? (BOOL *)(ol->value) :
1108 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1114 /*************************************************
1115 * Output extra characters message and die *
1116 *************************************************/
1118 /* Called when an option line has junk on the end. Sometimes this is because
1119 the sysadmin thinks comments are permitted.
1122 s points to the extra characters
1123 t1..t3 strings to insert in the log message
1125 Returns: doesn't return; dies
1129 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1131 uschar *comment = US"";
1132 if (*s == '#') comment = US" (# is comment only at line start)";
1133 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1134 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1139 /*************************************************
1140 * Read rewrite information *
1141 *************************************************/
1143 /* Each line of rewrite information contains:
1145 . A complete address in the form user@domain, possibly with
1146 leading * for each part; or alternatively, a regex.
1148 . A replacement string (which will be expanded).
1150 . An optional sequence of one-letter flags, indicating which
1151 headers etc. to apply this rule to.
1153 All this is decoded and placed into a control block. The OR of the flags is
1154 maintained in a common word.
1157 p points to the string that makes up the rule
1158 existflags points to the overall flag word
1159 isglobal TRUE if reading global rewrite rules
1161 Returns: the control block for the parsed rule.
1164 static rewrite_rule *
1165 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1167 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1170 next->key = string_dequote(&p);
1172 while (isspace(*p)) p++;
1174 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1175 "missing rewrite replacement string");
1178 next->replacement = string_dequote(&p);
1180 while (*p != 0) switch (*p++)
1182 case ' ': case '\t': break;
1184 case 'q': next->flags |= rewrite_quit; break;
1185 case 'w': next->flags |= rewrite_whole; break;
1187 case 'h': next->flags |= rewrite_all_headers; break;
1188 case 's': next->flags |= rewrite_sender; break;
1189 case 'f': next->flags |= rewrite_from; break;
1190 case 't': next->flags |= rewrite_to; break;
1191 case 'c': next->flags |= rewrite_cc; break;
1192 case 'b': next->flags |= rewrite_bcc; break;
1193 case 'r': next->flags |= rewrite_replyto; break;
1195 case 'E': next->flags |= rewrite_all_envelope; break;
1196 case 'F': next->flags |= rewrite_envfrom; break;
1197 case 'T': next->flags |= rewrite_envto; break;
1199 case 'Q': next->flags |= rewrite_qualify; break;
1200 case 'R': next->flags |= rewrite_repeat; break;
1203 next->flags |= rewrite_smtp;
1204 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1205 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1206 "rewrite rule has the S flag but is not a regular expression");
1210 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1211 "unknown rewrite flag character '%c' "
1212 "(could be missing quotes round replacement item)", p[-1]);
1216 /* If no action flags are set, set all the "normal" rewrites. */
1218 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1219 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1221 /* Remember which exist, for optimization, and return the rule */
1223 *existflags |= next->flags;
1230 /*************************************************
1231 * Read global rewrite information *
1232 *************************************************/
1234 /* Each line is a single rewrite rule; it is parsed into a control block
1235 by readconf_one_rewrite(), and its flags are ORed into the global flag
1236 word rewrite_existflags. */
1239 readconf_rewrites(void)
1241 rewrite_rule **chain = &global_rewrite_rules;
1244 while ((p = get_config_line()) != NULL)
1246 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1248 chain = &(next->next);
1254 /*************************************************
1256 *************************************************/
1258 /* Strings are read into the normal store pool. As long we aren't too
1259 near the end of the current block, the string will just use what is necessary
1260 on the top of the stacking pool, because string_cat() uses the extension
1264 s the rest of the input line
1265 name the option name (for errors)
1267 Returns: pointer to the string
1271 read_string(uschar *s, uschar *name)
1276 if (*s != '\"') return string_copy(s);
1279 yield = string_dequote(&s);
1281 if (s == ss+1 || s[-1] != '\"')
1282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1283 "missing quote at end of string value for %s", name);
1285 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1291 /*************************************************
1292 * Handle option line *
1293 *************************************************/
1295 /* This function is called from several places to process a line containing the
1296 setting of an option. The first argument is the line to be decoded; it has been
1297 checked not to be empty and not to start with '#'. Trailing newlines and white
1298 space have been removed. The second argument is a pointer to the list of
1299 variable names that are to be recognized, together with their types and
1300 locations, and the third argument gives the number of entries in the list.
1302 The fourth argument is a pointer to a data block. If it is NULL, then the data
1303 values in the options list are absolute addresses. Otherwise, they are byte
1304 offsets in the data block.
1306 String option data may continue onto several lines; this function reads further
1307 data from config_file if necessary.
1309 The yield of this function is normally zero. If a string continues onto
1310 multiple lines, then the data value is permitted to be followed by a comma
1311 or a semicolon (for use in drivers) and the yield is that character.
1314 buffer contains the configuration line to be handled
1315 oltop points to the start of the relevant option list
1316 last one more than the offset of the last item in the option list
1317 data_block NULL when reading main options => data values in the option
1318 list are absolute addresses; otherwise they are byte offsets
1319 in data_block when they have opt_public set; otherwise
1320 they are byte offsets in data_block->options_block.
1321 unknown_txt format string to use in panic message for unknown option;
1322 must contain %s for option name
1323 if given as NULL, don't panic on unknown option
1325 Returns: TRUE if an option was read successfully,
1326 FALSE false for an unknown option if unknown_txt == NULL,
1327 otherwise panic and die on an unknown option
1331 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1332 void *data_block, uschar *unknown_txt)
1336 int n, count, type, value;
1340 BOOL boolvalue = TRUE;
1341 BOOL freesptr = TRUE;
1342 optionlist *ol, *ol2;
1346 uschar *inttype = US"";
1352 /* There may be leading spaces; thereafter, we expect an option name starting
1355 while (isspace(*s)) s++;
1357 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1359 /* Read the name of the option, and skip any subsequent white space. If
1360 it turns out that what we read was "hide", set the flag indicating that
1361 this is a secure option, and loop to read the next word. */
1363 for (n = 0; n < 2; n++)
1365 while (isalnum(*s) || *s == '_')
1367 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1371 while (isspace(*s)) s++;
1372 if (Ustrcmp(name, "hide") != 0) break;
1373 issecure = opt_secure;
1377 /* Deal with "no_" or "not_" here for booleans */
1379 if (Ustrncmp(name, "no_", 3) == 0)
1385 if (Ustrncmp(name, "not_", 4) == 0)
1391 /* Search the list for the given name. A non-existent name, or an option that
1392 is set twice, is a disaster. */
1394 ol = find_option(name + offset, oltop, last);
1398 if (unknown_txt == NULL) return FALSE;
1399 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1402 if ((ol->type & opt_set) != 0)
1404 uschar *mname = name;
1405 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1406 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1407 "\"%s\" option set for the second time", mname);
1410 ol->type |= opt_set | issecure;
1411 type = ol->type & opt_mask;
1413 /* Types with data values must be followed by '='; the "no[t]_" prefix
1414 applies only to boolean values. */
1416 if (type < opt_bool || type > opt_bool_last)
1419 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1420 "negation prefix applied to a non-boolean option");
1422 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1423 "unexpected end of line (data missing) after %s", name);
1425 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1428 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1429 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1430 ultimately expands to one of those values. */
1432 else if (*s != 0 && (offset != 0 || *s != '='))
1433 extra_chars_error(s, US"boolean option ", name, US"");
1435 /* Skip white space after = */
1437 if (*s == '=') while (isspace((*(++s))));
1439 /* If there is a data block and the opt_public flag is not set, change
1440 the data block pointer to the private options block. */
1442 if (data_block != NULL && (ol->type & opt_public) == 0)
1443 data_block = (void *)(((driver_instance *)data_block)->options_block);
1445 /* Now get the data according to the type. */
1449 /* If a string value is not enclosed in quotes, it consists of
1450 the rest of the current line, verbatim. Otherwise, string escapes
1453 A transport is specified as a string, which is then looked up in the
1454 list of transports. A search type is specified as one of a number of
1457 A set or rewrite rules for a driver is specified as a string, which is
1458 then parsed into a suitable chain of control blocks.
1460 Uids and gids are specified as strings which are then looked up in the
1461 passwd file. Lists of uids and gids are similarly specified as colon-
1462 separated strings. */
1467 case opt_expand_uid:
1468 case opt_expand_gid:
1473 reset_point = sptr = read_string(s, name);
1475 /* Having read a string, we now have several different ways of using it,
1476 depending on the data type, so do another switch. If keeping the actual
1477 string is not required (because it is interpreted), freesptr is set TRUE,
1478 and at the end we reset the pool. */
1482 /* If this was a string, set the variable to point to the new string,
1483 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1484 rules, we still keep the string (for printing), and parse the rules into a
1485 control block and flags word. */
1489 if (data_block == NULL)
1490 *((uschar **)(ol->value)) = sptr;
1492 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1494 if (type == opt_rewrite)
1499 rewrite_rule **chain;
1502 sprintf(CS name2, "*%.50s_rules", name);
1503 ol2 = find_option(name2, oltop, last);
1504 sprintf(CS name2, "*%.50s_flags", name);
1505 ol3 = find_option(name2, oltop, last);
1507 if (ol2 == NULL || ol3 == NULL)
1508 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1509 "rewrite rules not available for driver");
1511 if (data_block == NULL)
1513 chain = (rewrite_rule **)(ol2->value);
1514 flagptr = (int *)(ol3->value);
1518 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1519 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1522 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1525 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1527 chain = &(next->next);
1530 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1531 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1532 "non-header rewrite - not allowed at transport time -");
1536 /* If it was an expanded uid, see if there is any expansion to be
1537 done by checking for the presence of a $ character. If there is, save it
1538 in the corresponding *expand_user option field. Otherwise, fall through
1539 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1542 case opt_expand_uid:
1543 sprintf(CS name2, "*expand_%.50s", name);
1544 ol2 = find_option(name2, oltop, last);
1547 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1549 if (data_block == NULL)
1550 *((uschar **)(ol2->value)) = ss;
1552 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1556 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1562 /* Look up a fixed uid, and also make use of the corresponding gid
1563 if a passwd entry is returned and the gid has not been set. */
1566 if (!route_finduser(sptr, &pw, &uid))
1567 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1568 if (data_block == NULL)
1569 *((uid_t *)(ol->value)) = uid;
1571 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1573 /* Set the flag indicating a fixed value is set */
1575 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1577 /* Handle matching gid if we have a passwd entry: done by finding the
1578 same name with terminating "user" changed to "group"; if not found,
1579 ignore. Also ignore if the value is already set. */
1581 if (pw == NULL) break;
1582 Ustrcpy(name+Ustrlen(name)-4, "group");
1583 ol2 = find_option(name, oltop, last);
1584 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1585 (ol2->type & opt_mask) == opt_expand_gid))
1587 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1590 if (data_block == NULL)
1591 *((gid_t *)(ol2->value)) = pw->pw_gid;
1593 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1599 /* If it was an expanded gid, see if there is any expansion to be
1600 done by checking for the presence of a $ character. If there is, save it
1601 in the corresponding *expand_user option field. Otherwise, fall through
1602 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1605 case opt_expand_gid:
1606 sprintf(CS name2, "*expand_%.50s", name);
1607 ol2 = find_option(name2, oltop, last);
1610 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1612 if (data_block == NULL)
1613 *((uschar **)(ol2->value)) = ss;
1615 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1619 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1625 /* Handle freestanding gid */
1628 if (!route_findgroup(sptr, &gid))
1629 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1630 if (data_block == NULL)
1631 *((gid_t *)(ol->value)) = gid;
1633 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1634 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1637 /* If it was a uid list, look up each individual entry, and build
1638 a vector of uids, with a count in the first element. Put the vector
1639 in malloc store so we can free the string. (We are reading into
1640 permanent store already.) */
1648 uschar *op = expand_string (sptr);
1651 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1652 name, expand_string_message);
1655 if (*p != 0) count++;
1656 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1657 list = store_malloc(count*sizeof(uid_t));
1658 list[ptr++] = (uid_t)(count - 1);
1660 if (data_block == NULL)
1661 *((uid_t **)(ol->value)) = list;
1663 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1669 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1670 if (!route_finduser(big_buffer, NULL, &uid))
1671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1678 /* If it was a gid list, look up each individual entry, and build
1679 a vector of gids, with a count in the first element. Put the vector
1680 in malloc store so we can free the string. (We are reading into permanent
1689 uschar *op = expand_string (sptr);
1692 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1693 name, expand_string_message);
1696 if (*p != 0) count++;
1697 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1698 list = store_malloc(count*sizeof(gid_t));
1699 list[ptr++] = (gid_t)(count - 1);
1701 if (data_block == NULL)
1702 *((gid_t **)(ol->value)) = list;
1704 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1710 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1711 if (!route_findgroup(big_buffer, &gid))
1712 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1720 /* Release store if the value of the string doesn't need to be kept. */
1722 if (freesptr) store_reset(reset_point);
1725 /* Expanded boolean: if no characters follow, or if there are no dollar
1726 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1727 save the string for later expansion in the alternate place. */
1729 case opt_expand_bool:
1730 if (*s != 0 && Ustrchr(s, '$') != 0)
1732 sprintf(CS name2, "*expand_%.50s", name);
1733 ol2 = find_option(name2, oltop, last);
1736 reset_point = sptr = read_string(s, name);
1737 if (data_block == NULL)
1738 *((uschar **)(ol2->value)) = sptr;
1740 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1747 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1748 look for yes/not/true/false. Some booleans are stored in a single bit in
1749 a single int. There's a special fudge for verify settings; without a suffix
1750 they set both xx_sender and xx_recipient. The table points to the sender
1751 value; search subsequently for the recipient. There's another special case:
1752 opt_bool_set also notes when a boolean has been set. */
1756 case opt_bool_verify:
1760 s = readconf_readname(name2, 64, s);
1761 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1763 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1765 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1766 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1767 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1768 US"for boolean option ", name);
1771 /* Handle single-bit type. */
1773 if (type == opt_bit)
1775 int bit = 1 << ((ol->type >> 16) & 31);
1776 int *ptr = (data_block == NULL)?
1777 (int *)(ol->value) :
1778 (int *)((uschar *)data_block + (long int)ol->value);
1779 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1783 /* Handle full BOOL types */
1785 if (data_block == NULL)
1786 *((BOOL *)(ol->value)) = boolvalue;
1788 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1792 if (type == opt_bool_verify)
1794 sprintf(CS name2, "%.50s_recipient", name + offset);
1795 ol2 = find_option(name2, oltop, last);
1798 if (data_block == NULL)
1799 *((BOOL *)(ol2->value)) = boolvalue;
1801 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1805 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1807 else if (type == opt_bool_set)
1809 sprintf(CS name2, "*set_%.50s", name + offset);
1810 ol2 = find_option(name2, oltop, last);
1813 if (data_block == NULL)
1814 *((BOOL *)(ol2->value)) = TRUE;
1816 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1825 inttype = US"octal ";
1827 /* Integer: a simple(ish) case; allow octal and hex formats, and
1828 suffixes K and M. The different types affect output, not input. */
1837 lvalue = strtol(CS s, CSS &endptr, intbase);
1840 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1843 if (errno != ERANGE)
1845 if (tolower(*endptr) == 'k')
1847 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1848 else lvalue *= 1024;
1851 else if (tolower(*endptr) == 'm')
1853 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1855 else lvalue *= 1024*1024;
1860 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1861 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1862 "absolute value of integer \"%s\" is too large (overflow)", s);
1864 while (isspace(*endptr)) endptr++;
1866 extra_chars_error(endptr, inttype, US"integer value for ", name);
1868 value = (int)lvalue;
1871 if (data_block == NULL)
1872 *((int *)(ol->value)) = value;
1874 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1877 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1884 value = strtol(CS s, CSS &endptr, intbase);
1887 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1890 if (errno != ERANGE)
1892 if (tolower(*endptr) == 'm')
1894 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1898 else if (tolower(*endptr) == 'k')
1904 value = (value + 512)/1024;
1908 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1909 "absolute value of integer \"%s\" is too large (overflow)", s);
1911 while (isspace(*endptr)) endptr++;
1913 extra_chars_error(endptr, inttype, US"integer value for ", name);
1916 if (data_block == NULL)
1917 *((int *)(ol->value)) = value;
1919 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1922 /* Fixed-point number: held to 3 decimal places. */
1925 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1926 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1927 "fixed-point number expected for %s", name);
1929 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1930 "integer \"%s\" is too large (overflow)", s);
1934 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1935 "integer \"%s\" is too large (overflow)", s);
1937 if (s[count] == '.')
1940 while (isdigit(s[++count]))
1942 value += (s[count] - '0') * d;
1947 while (isspace(s[count])) count++;
1950 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1952 if (data_block == NULL)
1953 *((int *)(ol->value)) = value;
1955 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1958 /* There's a special routine to read time values. */
1961 value = readconf_readtime(s, 0, FALSE);
1963 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1965 if (data_block == NULL)
1966 *((int *)(ol->value)) = value;
1968 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1971 /* A time list is a list of colon-separated times, with the first
1972 element holding the size of the list and the second the number of
1978 int *list = (data_block == NULL)?
1979 (int *)(ol->value) :
1980 (int *)((uschar *)data_block + (long int)(ol->value));
1982 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1985 uschar *snext = Ustrchr(s, ':');
1989 while (ss > s && isspace(ss[-1])) ss--;
1992 value = readconf_readtime(s, terminator, FALSE);
1994 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1996 if (count > 1 && value <= list[count])
1997 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1998 "time value out of order for %s", name);
1999 list[count+1] = value;
2000 if (snext == NULL) break;
2002 while (isspace(*s)) s++;
2005 if (count > list[0] - 2)
2006 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2008 if (count > 0 && list[2] == 0) count = 0;
2020 /*************************************************
2021 * Print a time value *
2022 *************************************************/
2025 Argument: a time value in seconds
2026 Returns: pointer to a fixed buffer containing the time as a string,
2027 in readconf_readtime() format
2031 readconf_printtime(int t)
2034 uschar *p = time_buffer;
2051 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2052 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2053 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2054 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2055 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2062 /*************************************************
2063 * Print an individual option value *
2064 *************************************************/
2066 /* This is used by the -bP option, so prints to the standard output.
2067 The entire options list is passed in as an argument, because some options come
2068 in pairs - typically uid/gid settings, which can either be explicit numerical
2069 values, or strings to be expanded later. If the numerical value is unset,
2070 search for "*expand_<name>" to see if there is a string equivalent.
2073 ol option entry, or NULL for an unknown option
2075 options_block NULL for main configuration options; otherwise points to
2076 a driver block; if the option doesn't have opt_public
2077 set, then options_block->options_block is where the item
2079 oltop points to the option list in which ol exists
2080 last one more than the offset of the last entry in optop
2086 print_ol(optionlist *ol, uschar *name, void *options_block,
2087 optionlist *oltop, int last)
2100 printf("%s is not a known option\n", name);
2104 /* Non-admin callers cannot see options that have been flagged secure by the
2107 if (!admin_user && (ol->type & opt_secure) != 0)
2109 printf("%s = <value not displayable>\n", name);
2113 /* Else show the value of the option */
2116 if (options_block != NULL)
2118 if ((ol->type & opt_public) == 0)
2119 options_block = (void *)(((driver_instance *)options_block)->options_block);
2120 value = (void *)((uschar *)options_block + (long int)value);
2123 switch(ol->type & opt_mask)
2126 case opt_rewrite: /* Show the text value */
2127 s = *((uschar **)value);
2128 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2132 printf("%s = %d\n", name, *((int *)value));
2137 int x = *((int *)value);
2138 if (x != 0 && (x & 1023) == 0)
2142 if ((x & 1023) == 0)
2147 printf("%s = %d%c\n", name, x, c);
2149 else printf("%s = %d\n", name, x);
2155 int x = *((int *)value);
2156 if (x == 0) printf("%s = 0\n", name);
2157 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2158 else printf("%s = %dK\n", name, x);
2163 printf("%s = %#o\n", name, *((int *)value));
2166 /* Can be negative only when "unset", in which case integer */
2170 int x = *((int *)value);
2173 if (x < 0) printf("%s =\n", name); else
2175 printf("%s = %d.", name, x/1000);
2188 /* If the numerical value is unset, try for the string value */
2190 case opt_expand_uid:
2191 if (! *get_set_flag(name, oltop, last, options_block))
2193 sprintf(CS name2, "*expand_%.50s", name);
2194 ol2 = find_option(name2, oltop, last);
2197 void *value2 = ol2->value;
2198 if (options_block != NULL)
2199 value2 = (void *)((uschar *)options_block + (long int)value2);
2200 s = *((uschar **)value2);
2201 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2206 /* Else fall through */
2209 if (! *get_set_flag(name, oltop, last, options_block))
2210 printf("%s =\n", name);
2213 pw = getpwuid(*((uid_t *)value));
2215 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2216 else printf("%s = %s\n", name, pw->pw_name);
2220 /* If the numerical value is unset, try for the string value */
2222 case opt_expand_gid:
2223 if (! *get_set_flag(name, oltop, last, options_block))
2225 sprintf(CS name2, "*expand_%.50s", name);
2226 ol2 = find_option(name2, oltop, last);
2227 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2229 void *value2 = ol2->value;
2230 if (options_block != NULL)
2231 value2 = (void *)((uschar *)options_block + (long int)value2);
2232 s = *((uschar **)value2);
2233 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2238 /* Else fall through */
2241 if (! *get_set_flag(name, oltop, last, options_block))
2242 printf("%s =\n", name);
2245 gr = getgrgid(*((int *)value));
2247 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2248 else printf("%s = %s\n", name, gr->gr_name);
2253 uidlist = *((uid_t **)value);
2254 printf("%s =", name);
2255 if (uidlist != NULL)
2259 for (i = 1; i <= (int)(uidlist[0]); i++)
2261 uschar *name = NULL;
2262 pw = getpwuid(uidlist[i]);
2263 if (pw != NULL) name = US pw->pw_name;
2264 if (name != NULL) printf("%c%s", sep, name);
2265 else printf("%c%ld", sep, (long int)(uidlist[i]));
2273 gidlist = *((gid_t **)value);
2274 printf("%s =", name);
2275 if (gidlist != NULL)
2279 for (i = 1; i <= (int)(gidlist[0]); i++)
2281 uschar *name = NULL;
2282 gr = getgrgid(gidlist[i]);
2283 if (gr != NULL) name = US gr->gr_name;
2284 if (name != NULL) printf("%c%s", sep, name);
2285 else printf("%c%ld", sep, (long int)(gidlist[i]));
2293 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2299 int *list = (int *)value;
2300 printf("%s = ", name);
2301 for (i = 0; i < list[1]; i++)
2302 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2308 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2312 case opt_expand_bool:
2313 sprintf(CS name2, "*expand_%.50s", name);
2314 ol2 = find_option(name2, oltop, last);
2315 if (ol2 != NULL && ol2->value != NULL)
2317 void *value2 = ol2->value;
2318 if (options_block != NULL)
2319 value2 = (void *)((uschar *)options_block + (long int)value2);
2320 s = *((uschar **)value2);
2323 printf("%s = %s\n", name, string_printing(s));
2326 /* s == NULL => string not set; fall through */
2332 case opt_bool_verify:
2334 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2341 /*************************************************
2342 * Print value from main configuration *
2343 *************************************************/
2345 /* This function, called as a result of encountering the -bP option,
2346 causes the value of any main configuration variable to be output if the
2347 second argument is NULL. There are some special values:
2349 all print all main configuration options
2350 configure_file print the name of the configuration file
2351 routers print the routers' configurations
2352 transports print the transports' configuration
2353 authenticators print the authenticators' configuration
2354 router_list print a list of router names
2355 transport_list print a list of transport names
2356 authenticator_list print a list of authentication mechanism names
2357 +name print a named list item
2358 local_scan print the local_scan options
2360 If the second argument is not NULL, it must be one of "router", "transport", or
2361 "authenticator" in which case the first argument identifies the driver whose
2362 options are to be printed.
2365 name option name if type == NULL; else driver name
2366 type NULL or driver type name, as described above
2372 readconf_print(uschar *name, uschar *type)
2374 BOOL names_only = FALSE;
2376 optionlist *ol2 = NULL;
2377 driver_instance *d = NULL;
2387 static uschar *types[] = { US"address", US"domain", US"host",
2389 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2390 &hostlist_anchor, &localpartlist_anchor };
2392 for (i = 0; i < 4; i++)
2394 t = tree_search(*(anchors[i]), name+1);
2398 printf("%slist %s = %s\n", types[i], name+1,
2399 ((namedlist_block *)(t->data.ptr))->string);
2404 printf("no address, domain, host, or local part list called \"%s\" "
2405 "exists\n", name+1);
2410 if (Ustrcmp(name, "configure_file") == 0)
2412 printf("%s\n", CS config_main_filename);
2416 if (Ustrcmp(name, "all") == 0)
2418 for (ol = optionlist_config;
2419 ol < optionlist_config + optionlist_config_size; ol++)
2421 if ((ol->type & opt_hidden) == 0)
2422 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2427 if (Ustrcmp(name, "local_scan") == 0)
2429 #ifndef LOCAL_SCAN_HAS_OPTIONS
2430 printf("local_scan() options are not supported\n");
2432 for (ol = local_scan_options;
2433 ol < local_scan_options + local_scan_options_count; ol++)
2435 print_ol(ol, US ol->name, NULL, local_scan_options,
2436 local_scan_options_count);
2442 if (Ustrcmp(name, "routers") == 0)
2447 else if (Ustrcmp(name, "transports") == 0)
2449 type = US"transport";
2453 else if (Ustrcmp(name, "authenticators") == 0)
2455 type = US"authenticator";
2459 else if (Ustrcmp(name, "authenticator_list") == 0)
2461 type = US"authenticator";
2466 else if (Ustrcmp(name, "router_list") == 0)
2472 else if (Ustrcmp(name, "transport_list") == 0)
2474 type = US"transport";
2480 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2481 name, NULL, optionlist_config, optionlist_config_size);
2486 /* Handle the options for a router or transport. Skip options that are flagged
2487 as hidden. Some of these are options with names starting with '*', used for
2488 internal alternative representations of other options (which the printing
2489 function will sort out). Others are synonyms kept for backward compatibility.
2492 if (Ustrcmp(type, "router") == 0)
2494 d = (driver_instance *)routers;
2495 ol2 = optionlist_routers;
2496 size = optionlist_routers_size;
2498 else if (Ustrcmp(type, "transport") == 0)
2500 d = (driver_instance *)transports;
2501 ol2 = optionlist_transports;
2502 size = optionlist_transports_size;
2504 else if (Ustrcmp(type, "authenticator") == 0)
2506 d = (driver_instance *)auths;
2507 ol2 = optionlist_auths;
2508 size = optionlist_auths_size;
2513 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2517 /* Either search for a given driver, or print all of them */
2519 for (; d != NULL; d = d->next)
2522 printf("\n%s %s:\n", d->name, type);
2523 else if (Ustrcmp(d->name, name) != 0) continue;
2525 for (ol = ol2; ol < ol2 + size; ol++)
2527 if ((ol->type & opt_hidden) == 0)
2528 print_ol(ol, US ol->name, d, ol2, size);
2531 for (ol = d->info->options;
2532 ol < d->info->options + *(d->info->options_count); ol++)
2534 if ((ol->type & opt_hidden) == 0)
2535 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2537 if (name != NULL) return;
2539 if (name != NULL) printf("%s %s not found\n", type, name);
2544 /*************************************************
2545 * Read a named list item *
2546 *************************************************/
2548 /* This function reads a name and a list (i.e. string). The name is used to
2549 save the list in a tree, sorted by its name. Each entry also has a number,
2550 which can be used for caching tests, but if the string contains any expansion
2551 items other than $key, the number is set negative to inhibit caching. This
2552 mechanism is used for domain, host, and address lists that are referenced by
2556 anchorp points to the tree anchor
2557 numberp points to the current number for this tree
2558 max the maximum number permitted
2559 s the text of the option line, starting immediately after the name
2561 tname the name of the list type, for messages
2567 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2570 BOOL forcecache = FALSE;
2573 namedlist_block *nb = store_get(sizeof(namedlist_block));
2575 if (Ustrncmp(s, "_cache", 6) == 0)
2582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2584 if (*numberp >= max)
2585 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2588 while (isspace(*s)) s++;
2590 while (isalnum(*s) || *s == '_') s++;
2591 t = store_get(sizeof(tree_node) + s-ss);
2592 Ustrncpy(t->name, ss, s-ss);
2594 while (isspace(*s)) s++;
2596 if (!tree_insertnode(anchorp, t))
2597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2598 "duplicate name \"%s\" for a named %s", t->name, tname);
2601 nb->number = *numberp;
2604 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2605 "missing '=' after \"%s\"", t->name);
2606 while (isspace(*s)) s++;
2607 nb->string = read_string(s, t->name);
2608 nb->cache_data = NULL;
2610 /* Check the string for any expansions; if any are found, mark this list
2611 uncacheable unless the user has explicited forced caching. */
2613 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2619 /*************************************************
2620 * Unpick data for a rate limit *
2621 *************************************************/
2623 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2627 s string, in the form t,b,f,l
2628 where t is the threshold (integer)
2629 b is the initial delay (time)
2630 f is the multiplicative factor (fixed point)
2631 k is the maximum time (time)
2632 threshold where to store threshold
2633 base where to store base in milliseconds
2634 factor where to store factor in milliseconds
2635 limit where to store limit
2637 Returns: nothing (panics on error)
2641 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2644 uschar bstring[16], lstring[16];
2646 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2647 factor, lstring) == 4)
2649 *base = readconf_readtime(bstring, 0, TRUE);
2650 *limit = readconf_readtime(lstring, 0, TRUE);
2651 if (*base >= 0 && *limit >= 0) return;
2653 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2659 /*************************************************
2660 * Read main configuration options *
2661 *************************************************/
2663 /* This function is the first to be called for configuration reading. It
2664 opens the configuration file and reads general configuration settings until
2665 it reaches the end of the configuration section. The file is then left open so
2666 that the remaining configuration data can subsequently be read if needed for
2669 The configuration file must be owned either by root or exim, and be writeable
2670 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2671 in the config file, so the test is done on the compiled in values. A slight
2672 anomaly, to be carefully documented.
2674 The name of the configuration file is taken from a list that is included in the
2675 binary of Exim. It can be altered from the command line, but if that is done,
2676 root privilege is immediately withdrawn unless the caller is root or exim.
2677 The first file on the list that exists is used.
2679 For use on multiple systems that share file systems, first look for a
2680 configuration file whose name has the current node name on the end. If that is
2681 not found, try the generic name. For really contorted configurations, that run
2682 multiple Exims with different uid settings, first try adding the effective uid
2683 before the node name. These complications are going to waste resources on most
2684 systems. Therefore they are available only when requested by compile-time
2691 struct stat statbuf;
2692 uschar *s, *filename;
2693 uschar *list = config_main_filelist;
2695 /* Loop through the possible file names */
2697 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2700 /* Cut out all the fancy processing unless specifically wanted */
2702 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2703 uschar *suffix = filename + Ustrlen(filename);
2705 /* Try for the node-specific file if a node name exists */
2707 #ifdef CONFIGURE_FILE_USE_NODE
2709 if (uname(&uts) >= 0)
2711 #ifdef CONFIGURE_FILE_USE_EUID
2712 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2713 config_file = Ufopen(filename, "rb");
2714 if (config_file == NULL)
2715 #endif /* CONFIGURE_FILE_USE_EUID */
2717 sprintf(CS suffix, ".%.256s", uts.nodename);
2718 config_file = Ufopen(filename, "rb");
2721 #endif /* CONFIGURE_FILE_USE_NODE */
2723 /* Otherwise, try the generic name, possibly with the euid added */
2725 #ifdef CONFIGURE_FILE_USE_EUID
2726 if (config_file == NULL)
2728 sprintf(CS suffix, ".%ld", (long int)original_euid);
2729 config_file = Ufopen(filename, "rb");
2731 #endif /* CONFIGURE_FILE_USE_EUID */
2733 /* Finally, try the unadorned name */
2735 if (config_file == NULL)
2738 config_file = Ufopen(filename, "rb");
2740 #else /* if neither defined */
2742 /* This is the common case when the fancy processing is not included. */
2744 config_file = Ufopen(filename, "rb");
2747 /* If the file does not exist, continue to try any others. For any other
2748 error, break out (and die). */
2750 if (config_file != NULL || errno != ENOENT) break;
2753 /* On success, save the name for verification; config_filename is used when
2754 logging configuration errors (it changes for .included files) whereas
2755 config_main_filename is the name shown by -bP. Failure to open a configuration
2756 file is a serious disaster. */
2758 if (config_file != NULL)
2760 config_filename = config_main_filename = string_copy(filename);
2764 if (filename == NULL)
2765 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2766 "%s", config_main_filelist);
2768 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2769 "configuration file %s", filename));
2772 /* Check the status of the file we have opened, unless it was specified on
2773 the command line, in which case privilege was given away at the start. */
2775 if (!config_changed)
2777 if (fstat(fileno(config_file), &statbuf) != 0)
2778 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2781 if ((statbuf.st_uid != root_uid && /* owner not root */
2782 statbuf.st_uid != exim_uid /* owner not exim */
2783 #ifdef CONFIGURE_OWNER
2784 && statbuf.st_uid != config_uid /* owner not the special one */
2787 (statbuf.st_gid != exim_gid /* group not exim & */
2788 #ifdef CONFIGURE_GROUP
2789 && statbuf.st_gid != config_gid /* group not the special one */
2791 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2793 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2795 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2796 "wrong owner, group, or mode", big_buffer);
2799 /* Process the main configuration settings. They all begin with a lower case
2800 letter. If we see something starting with an upper case letter, it is taken as
2801 a macro definition. */
2803 while ((s = get_config_line()) != NULL)
2805 if (isupper(s[0])) read_macro_assignment(s);
2807 else if (Ustrncmp(s, "domainlist", 10) == 0)
2808 read_named_list(&domainlist_anchor, &domainlist_count,
2809 MAX_NAMED_LIST, s+10, US"domain list");
2811 else if (Ustrncmp(s, "hostlist", 8) == 0)
2812 read_named_list(&hostlist_anchor, &hostlist_count,
2813 MAX_NAMED_LIST, s+8, US"host list");
2815 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2816 read_named_list(&addresslist_anchor, &addresslist_count,
2817 MAX_NAMED_LIST, s+11, US"address list");
2819 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2820 read_named_list(&localpartlist_anchor, &localpartlist_count,
2821 MAX_NAMED_LIST, s+13, US"local part list");
2824 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2825 NULL, US"main option \"%s\" unknown");
2829 /* If local_sender_retain is set, local_from_check must be unset. */
2831 if (local_sender_retain && local_from_check)
2832 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2833 "local_sender_retain are set; this combination is not allowed");
2835 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2838 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2840 /* The max retry interval must not be greater than 24 hours. */
2842 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2844 /* remote_max_parallel must be > 0 */
2846 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2848 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2849 start of a new SMTP message. */
2851 freeze_tell_config = freeze_tell;
2853 /* The primary host name may be required for expansion of spool_directory
2854 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2855 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2856 canonize it. Some people like upper case letters in their host names, so we
2857 don't force the case. */
2859 if (primary_hostname == NULL)
2863 if (uname(&uts) < 0)
2864 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2865 hostname = US uts.nodename;
2867 if (Ustrchr(hostname, '.') == NULL)
2870 struct hostent *hostdata;
2873 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2874 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2884 #if HAVE_GETIPNODEBYNAME
2886 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2888 hostdata = gethostbyname2(CS hostname, af);
2891 hostdata = gethostbyname(CS hostname);
2894 if (hostdata != NULL)
2896 hostname = US hostdata->h_name;
2900 if (af == AF_INET) break;
2905 primary_hostname = string_copy(hostname);
2908 /* Set up default value for smtp_active_hostname */
2910 smtp_active_hostname = primary_hostname;
2912 /* If spool_directory wasn't set in the build-time configuration, it must have
2913 got set above. Of course, writing to the log may not work if log_file_path is
2914 not set, but it will at least get to syslog or somewhere, with any luck. */
2916 if (*spool_directory == 0)
2917 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2920 /* Expand the spool directory name; it may, for example, contain the primary
2921 host name. Same comment about failure. */
2923 s = expand_string(spool_directory);
2925 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2926 "\"%s\": %s", spool_directory, expand_string_message);
2927 spool_directory = s;
2929 /* Expand log_file_path, which must contain "%s" in any component that isn't
2930 the null string or "syslog". It is also allowed to contain one instance of %D.
2931 However, it must NOT contain % followed by anything else. */
2933 if (*log_file_path != 0)
2936 int sep = ':'; /* Fixed for log file path */
2937 s = expand_string(log_file_path);
2939 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2940 "\"%s\": %s", log_file_path, expand_string_message);
2943 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2946 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2947 t = Ustrstr(sss, "%s");
2949 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2950 "contain \"%%s\"", sss);
2952 t = Ustrchr(sss, '%');
2955 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2956 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2957 "unexpected \"%%\" character", s);
2964 /* Interpret syslog_facility into an integer argument for 'ident' param to
2965 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2968 if (syslog_facility_str != NULL)
2971 uschar *s = syslog_facility_str;
2973 if ((Ustrlen(syslog_facility_str) >= 4) &&
2974 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2977 for (i = 0; i < syslog_list_size; i++)
2979 if (strcmpic(s, syslog_list[i].name) == 0)
2981 syslog_facility = syslog_list[i].value;
2986 if (i >= syslog_list_size)
2988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2989 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2993 /* Expand pid_file_path */
2995 if (*pid_file_path != 0)
2997 s = expand_string(pid_file_path);
2999 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3000 "\"%s\": %s", pid_file_path, expand_string_message);
3004 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3007 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3009 /* Unpick the SMTP rate limiting options, if set */
3011 if (smtp_ratelimit_mail != NULL)
3013 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3014 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3017 if (smtp_ratelimit_rcpt != NULL)
3019 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3020 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3023 /* The qualify domains default to the primary host name */
3025 if (qualify_domain_sender == NULL)
3026 qualify_domain_sender = primary_hostname;
3027 if (qualify_domain_recipient == NULL)
3028 qualify_domain_recipient = qualify_domain_sender;
3030 /* Setting system_filter_user in the configuration sets the gid as well if a
3031 name is given, but a numerical value does not. */
3033 if (system_filter_uid_set && !system_filter_gid_set)
3035 struct passwd *pw = getpwuid(system_filter_uid);
3037 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3038 (long int)system_filter_uid);
3039 system_filter_gid = pw->pw_gid;
3040 system_filter_gid_set = TRUE;
3043 /* If the errors_reply_to field is set, check that it is syntactically valid
3044 and ensure it contains a domain. */
3046 if (errors_reply_to != NULL)
3049 int start, end, domain;
3050 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3051 &start, &end, &domain, FALSE);
3053 if (recipient == NULL)
3054 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3055 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3058 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3059 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3062 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3063 smtp_accept_max must also be set. */
3065 if (smtp_accept_max == 0 &&
3066 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3067 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3068 "smtp_accept_max must be set if smtp_accept_queue or "
3069 "smtp_accept_max_per_host is set");
3071 /* Set up the host number if anything is specified. It is an expanded string
3072 so that it can be computed from the host name, for example. We do this last
3073 so as to ensure that everything else is set up before the expansion. */
3075 if (host_number_string != NULL)
3078 uschar *s = expand_string(host_number_string);
3079 long int n = Ustrtol(s, &end, 0);
3080 while (isspace(*end)) end++;
3082 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3083 "localhost_number value is not a number: %s", s);
3084 if (n > LOCALHOST_MAX)
3085 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3086 "localhost_number is greater than the maximum allowed value (%d)",
3092 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3094 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3095 tls_verify_certificates == NULL)
3096 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3097 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3098 (tls_verify_hosts != NULL)? "" : "try_");
3104 /*************************************************
3105 * Initialize one driver *
3106 *************************************************/
3108 /* This is called once the driver's generic options, if any, have been read.
3109 We can now find the driver, set up defaults for the private options, and
3110 unset any "set" bits in the private options table (which might have been
3111 set by another incarnation of the same driver).
3114 d pointer to driver instance block, with generic
3116 drivers_available vector of available drivers
3117 size_of_info size of each block in drivers_available
3118 class class of driver, for error message
3120 Returns: pointer to the driver info block
3123 static driver_info *
3124 init_driver(driver_instance *d, driver_info *drivers_available,
3125 int size_of_info, uschar *class)
3129 for (dd = drivers_available; dd->driver_name[0] != 0;
3130 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3132 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3135 int len = dd->options_len;
3137 d->options_block = store_get(len);
3138 memcpy(d->options_block, dd->options_block, len);
3139 for (i = 0; i < *(dd->options_count); i++)
3140 dd->options[i].type &= ~opt_set;
3145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3146 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3148 return NULL; /* never obeyed */
3154 /*************************************************
3155 * Initialize driver list *
3156 *************************************************/
3158 /* This function is called for routers, transports, and authentication
3159 mechanisms. It reads the data from the current point in the configuration file
3160 up to the end of the section, and sets up a chain of instance blocks according
3161 to the file's contents. The file will already have been opened by a call to
3162 readconf_main, and must be left open for subsequent reading of further data.
3164 Any errors cause a panic crash. Note that the blocks with names driver_info and
3165 driver_instance must map the first portions of all the _info and _instance
3166 blocks for this shared code to work.
3169 class "router", "transport", or "authenticator"
3170 anchor &routers, &transports, &auths
3171 drivers_available available drivers
3172 size_of_info size of each info block
3173 instance_default points to default data for an instance
3174 instance_size size of instance block
3175 driver_optionlist generic option list
3176 driver_optionlist_count count of generic option list
3182 readconf_driver_init(
3184 driver_instance **anchor,
3185 driver_info *drivers_available,
3187 void *instance_default,
3189 optionlist *driver_optionlist,
3190 int driver_optionlist_count)
3192 driver_instance **p = anchor;
3193 driver_instance *d = NULL;
3196 while ((buffer = get_config_line()) != NULL)
3201 /* Read the first name on the line and test for the start of a new driver. A
3202 macro definition indicates the end of the previous driver. If this isn't the
3203 start of a new driver, the line will be re-read. */
3205 s = readconf_readname(name, sizeof(name), buffer);
3207 /* Handle macro definition, first finishing off the initialization of the
3208 previous driver, if any. */
3210 if (isupper(*name) && *s == '=')
3214 if (d->driver_name == NULL)
3215 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3216 "no driver defined for %s \"%s\"", class, d->name);
3220 read_macro_assignment(buffer);
3224 /* If the line starts with a name terminated by a colon, we are at the
3225 start of the definition of a new driver. The rest of the line must be
3232 /* Finish off initializing the previous driver. */
3236 if (d->driver_name == NULL)
3237 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3238 "no driver defined for %s \"%s\"", class, d->name);
3242 /* Check that we haven't already got a driver of this name */
3244 for (d = *anchor; d != NULL; d = d->next)
3245 if (Ustrcmp(name, d->name) == 0)
3246 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3247 "there are two %ss called \"%s\"", class, name);
3249 /* Set up a new driver instance data block on the chain, with
3250 its default values installed. */
3252 d = store_get(instance_size);
3253 memcpy(d, instance_default, instance_size);
3256 d->name = string_copy(name);
3258 /* Clear out the "set" bits in the generic options */
3260 for (i = 0; i < driver_optionlist_count; i++)
3261 driver_optionlist[i].type &= ~opt_set;
3263 /* Check nothing more on this line, then do the next loop iteration. */
3265 while (isspace(*s)) s++;
3266 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3270 /* Not the start of a new driver. Give an error if we have not set up a
3271 current driver yet. */
3273 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3274 "%s name missing", class);
3276 /* First look to see if this is a generic option; if it is "driver",
3277 initialize the driver. If is it not a generic option, we can look for a
3278 private option provided that the driver has been previously set up. */
3280 if (readconf_handle_option(buffer, driver_optionlist,
3281 driver_optionlist_count, d, NULL))
3283 if (d->info == NULL && d->driver_name != NULL)
3284 init_driver(d, drivers_available, size_of_info, class);
3287 /* Handle private options - pass the generic block because some may
3288 live therein. A flag with each option indicates if it is in the public
3291 else if (d->info != NULL)
3293 readconf_handle_option(buffer, d->info->options,
3294 *(d->info->options_count), d, US"option \"%s\" unknown");
3297 /* The option is not generic and the driver name has not yet been given. */
3299 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3300 "(\"driver\" must be specified before any private options)", name);
3303 /* Run the initialization function for the final driver. */
3307 if (d->driver_name == NULL)
3308 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3309 "no driver defined for %s \"%s\"", class, d->name);
3316 /*************************************************
3317 * Check driver dependency *
3318 *************************************************/
3320 /* This function is passed a driver instance and a string. It checks whether
3321 any of the string options for the driver contains the given string as an
3325 d points to a driver instance block
3326 s the string to search for
3328 Returns: TRUE if a dependency is found
3332 readconf_depends(driver_instance *d, uschar *s)
3334 int count = *(d->info->options_count);
3338 for (ol = d->info->options; ol < d->info->options + count; ol++)
3340 void *options_block;
3342 int type = ol->type & opt_mask;
3343 if (type != opt_stringptr) continue;
3344 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3345 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3346 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3348 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3349 isalnum(ss[Ustrlen(s)])) continue;
3350 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3351 d->name, ol->name, s);
3356 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3363 /*************************************************
3364 * Decode an error type for retries *
3365 *************************************************/
3367 /* This function is global because it is also called from the main
3368 program when testing retry information. It decodes strings such as "quota_7d"
3369 into numerical error codes.
3372 pp points to start of text
3373 p points past end of text
3374 basic_errno points to an int to receive the main error number
3375 more_errno points to an int to receive the secondary error data
3377 Returns: NULL if decoded correctly; else points to error text
3381 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3385 while (q < p && *q != '_') q++;
3388 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3390 *basic_errno = ERRNO_EXIMQUOTA;
3391 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3392 return US"bad time value";
3395 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3397 *basic_errno = ECONNREFUSED;
3400 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3401 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3402 else return US"A or MX expected after \"refused\"";
3406 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3408 *basic_errno = ETIMEDOUT;
3412 int xlen = p - q - 1;
3415 static uschar *extras[] =
3416 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3417 static int values[] =
3418 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3420 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3422 if (strncmpic(x, extras[i], xlen) == 0)
3424 *more_errno = values[i];
3429 if (i >= sizeof(extras)/sizeof(uschar *))
3431 if (strncmpic(x, US"DNS", xlen) == 0)
3433 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3434 "available in retry rules (it has never worked) - treated as "
3437 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3442 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3443 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3444 strncmpic(pp, US"data_4", 6) == 0)
3447 int x = 255; /* means "any 4xx code" */
3448 if (p != pp + 8) bad = TRUE; else
3450 int a = pp[6], b = pp[7];
3454 if (isdigit(b)) x += b - '0';
3455 else if (b == 'x') x += 100;
3458 else if (a != 'x' || b != 'x') bad = TRUE;
3462 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3463 "x is literal and d is any digit", pp);
3465 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3466 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3467 *more_errno = x << 8;
3470 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3471 strncmpic(q+1, US"failed", p-q-1) == 0)
3472 *basic_errno = ERRNO_AUTHFAIL;
3474 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3475 *basic_errno = ERRNO_SMTPCLOSED;
3477 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3478 *basic_errno = ERRNO_TLSREQUIRED;
3480 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3481 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3489 /*************************************************
3490 * Read retry information *
3491 *************************************************/
3493 /* Each line of retry information contains:
3495 . A domain name pattern or an address pattern;
3497 . An error name, possibly with additional data, or *;
3499 . An optional sequence of retry items, each consisting of an identifying
3500 letter, a cutoff time, and optional parameters.
3502 All this is decoded and placed into a control block. */
3505 /* Subroutine to read an argument, preceded by a comma and terminated
3506 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3507 1 = fixed point number (returned *1000).
3510 paddr pointer to pointer to current character; updated
3511 type 0 => read a time; 1 => read a fixed point number
3513 Returns: time in seconds or fixed point number * 1000
3517 retry_arg(uschar **paddr, int type)
3522 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3524 while (isspace(*p)) p++;
3526 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3528 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3535 return readconf_readtime(pp, *p, FALSE);
3537 return readconf_readfixed(pp, *p);
3539 return 0; /* Keep picky compilers happy */
3542 /* The function proper */
3545 readconf_retries(void)
3547 retry_config **chain = &retries;
3551 while ((p = get_config_line()) != NULL)
3553 retry_rule **rchain;
3556 next = store_get(sizeof(retry_config));
3559 chain = &(next->next);
3560 next->basic_errno = next->more_errno = 0;
3561 next->senders = NULL;
3563 rchain = &(next->rules);
3565 next->pattern = string_dequote(&p);
3566 while (isspace(*p)) p++;
3568 while (mac_isgraph(*p)) p++;
3569 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3570 "missing error type");
3572 /* Test error names for things we understand. */
3574 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3575 &(next->more_errno))) != NULL)
3576 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3578 /* There may be an optional address list of senders to be used as another
3579 constraint on the rule. This was added later, so the syntax is a bit of a
3580 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3583 while (isspace(*p)) p++;
3584 if (Ustrncmp(p, "senders", 7) == 0)
3587 while (isspace(*p)) p++;
3588 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3589 "\"=\" expected after \"senders\" in retry rule");
3590 while (isspace(*p)) p++;
3591 next->senders = string_dequote(&p);
3594 /* Now the retry rules. Keep the maximum timeout encountered. */
3596 while (isspace(*p)) p++;
3600 retry_rule *rule = store_get(sizeof(retry_rule));
3602 rchain = &(rule->next);
3604 rule->rule = toupper(*p++);
3605 rule->timeout = retry_arg(&p, 0);
3606 if (rule->timeout > retry_maximum_timeout)
3607 retry_maximum_timeout = rule->timeout;
3611 case 'F': /* Fixed interval */
3612 rule->p1 = retry_arg(&p, 0);
3615 case 'G': /* Geometrically increasing intervals */
3616 case 'H': /* Ditto, but with randomness */
3617 rule->p1 = retry_arg(&p, 0);
3618 rule->p2 = retry_arg(&p, 1);
3622 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3626 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3627 (rule->rule != 'F' && rule->p2 < 1000))
3628 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3629 "bad parameters for retry rule");
3631 while (isspace(*p)) p++;
3635 while (isspace(*p)) p++;
3638 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3645 /*************************************************
3646 * Initialize authenticators *
3647 *************************************************/
3649 /* Read the authenticators section of the configuration file.
3658 auth_instance *au, *bu;
3659 readconf_driver_init(US"authenticator",
3660 (driver_instance **)(&auths), /* chain anchor */
3661 (driver_info *)auths_available, /* available drivers */
3662 sizeof(auth_info), /* size of info block */
3663 &auth_defaults, /* default values for generic options */
3664 sizeof(auth_instance), /* size of instance block */
3665 optionlist_auths, /* generic options */
3666 optionlist_auths_size);
3668 for (au = auths; au != NULL; au = au->next)
3670 if (au->public_name == NULL)
3671 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3672 "the %s authenticator", au->name);
3673 for (bu = au->next; bu != NULL; bu = bu->next)
3675 if (strcmpic(au->public_name, bu->public_name) == 0)
3677 if ((au->client && bu->client) || (au->server && bu->server))
3678 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3679 "(%s and %s) have the same public name (%s)",
3680 (au->client)? US"client" : US"server", au->name, bu->name,
3690 /*************************************************
3691 * Read ACL information *
3692 *************************************************/
3694 /* If this run of Exim is not doing something that involves receiving a
3695 message, we can just skip over the ACL information. No need to parse it.
3697 First, we have a function for acl_read() to call back to get the next line. We
3698 need to remember the line we passed, because at the end it will contain the
3699 name of the next ACL. */
3701 static uschar *acl_line;
3706 acl_line = get_config_line();
3711 /* Now the main function:
3714 skip TRUE when this Exim process is doing something that will
3715 not need the ACL data
3721 readconf_acl(BOOL skip)
3725 /* Not receiving messages, don't need to parse the ACL data */
3729 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3730 while ((p = get_config_line()) != NULL);
3734 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3737 acl_line = get_config_line();
3739 while(acl_line != NULL)
3745 p = readconf_readname(name, sizeof(name), acl_line);
3746 if (isupper(*name) && *p == '=')
3748 read_macro_assignment(acl_line);
3749 acl_line = get_config_line();
3753 if (*p != ':' || name[0] == 0)
3754 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3756 node = store_get(sizeof(tree_node) + Ustrlen(name));
3757 Ustrcpy(node->name, name);
3758 if (!tree_insertnode(&acl_anchor, node))
3759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3760 "there are two ACLs called \"%s\"", name);
3762 node->data.ptr = acl_read(acl_callback, &error);
3764 if (node->data.ptr == NULL && error != NULL)
3765 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3771 /*************************************************
3772 * Read configuration for local_scan() *
3773 *************************************************/
3775 /* This function is called after "begin local_scan" is encountered in the
3776 configuration file. If the local_scan() function allows for configuration
3777 options, we can process them. Otherwise, we expire in a panic.
3784 local_scan_init(void)
3786 #ifndef LOCAL_SCAN_HAS_OPTIONS
3787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3788 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3792 while ((p = get_config_line()) != NULL)
3794 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3795 NULL, US"local_scan option \"%s\" unknown");
3802 /*************************************************
3803 * Read rest of configuration (after main) *
3804 *************************************************/
3806 /* This function reads the rest of the runtime configuration, after the main
3807 configuration. It is called only when actually needed. Each subsequent section
3808 of the configuration starts with a line of the form
3812 where the name is "routers", "transports", etc. A section is terminated by
3813 hitting the next "begin" line, and the next name is left in next_section.
3814 Because it may confuse people as to whether the names are singular or plural,
3815 we add "s" if it's missing. There is always enough room in next_section for
3816 this. This function is basically just a switch.
3819 skip_acl TRUE if ACL information is not needed
3824 static uschar *section_list[] = {
3834 readconf_rest(BOOL skip_acl)
3838 while(next_section[0] != 0)
3842 int last = sizeof(section_list) / sizeof(uschar *);
3844 int n = Ustrlen(next_section);
3846 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3850 int c = strcmpic(next_section, section_list[mid]);
3852 if (c > 0) first = mid + 1; else last = mid;
3854 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3855 "\"%.*s\" is not a known configuration section name", n, next_section);
3856 mid = (last + first)/2;
3860 if (((had ^= bit) & bit) == 0)
3861 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3862 "\"%.*s\" section is repeated in the configuration file", n,
3867 case 0: readconf_acl(skip_acl); break;
3868 case 1: auths_init(); break;
3869 case 2: local_scan_init(); break;
3870 case 3: readconf_retries(); break;
3871 case 4: readconf_rewrites(); break;
3872 case 5: route_init(); break;
3873 case 6: transport_init(); break;
3877 (void)fclose(config_file);
3880 /* End of readconf.c */