1 /* $Cambridge: exim/src/src/readconf.c,v 1.36 2009/06/10 07:34:04 tom 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 },
146 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
148 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
149 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
150 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
151 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
152 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
153 #ifdef WITH_CONTENT_SCAN
154 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
156 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
157 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
158 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
159 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
161 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
163 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
164 { "admin_groups", opt_gidlist, &admin_groups },
165 { "allow_domain_literals", opt_bool, &allow_domain_literals },
166 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
167 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
168 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
169 { "auto_thaw", opt_time, &auto_thaw },
170 #ifdef WITH_CONTENT_SCAN
171 { "av_scanner", opt_stringptr, &av_scanner },
173 { "bi_command", opt_stringptr, &bi_command },
174 #ifdef EXPERIMENTAL_BRIGHTMAIL
175 { "bmi_config_file", opt_stringptr, &bmi_config_file },
177 { "bounce_message_file", opt_stringptr, &bounce_message_file },
178 { "bounce_message_text", opt_stringptr, &bounce_message_text },
179 { "bounce_return_body", opt_bool, &bounce_return_body },
180 { "bounce_return_message", opt_bool, &bounce_return_message },
181 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
182 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
183 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
184 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
185 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
186 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
187 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
188 { "check_log_inodes", opt_int, &check_log_inodes },
189 { "check_log_space", opt_Kint, &check_log_space },
190 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
191 { "check_spool_inodes", opt_int, &check_spool_inodes },
192 { "check_spool_space", opt_Kint, &check_spool_space },
193 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
194 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
195 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
196 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
197 #ifdef EXPERIMENTAL_DCC
198 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
199 { "dccifd_address", opt_stringptr, &dccifd_address },
200 { "dccifd_options", opt_stringptr, &dccifd_options },
202 { "delay_warning", opt_timelist, &delay_warning },
203 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
204 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
205 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
206 { "delivery_date_remove", opt_bool, &delivery_date_remove },
207 #ifdef ENABLE_DISABLE_FSYNC
208 { "disable_fsync", opt_bool, &disable_fsync },
210 { "disable_ipv6", opt_bool, &disable_ipv6 },
212 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
214 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
215 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
216 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
217 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
218 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
219 { "dns_retrans", opt_time, &dns_retrans },
220 { "dns_retry", opt_int, &dns_retry },
221 /* This option is now a no-op, retained for compability */
222 { "drop_cr", opt_bool, &drop_cr },
223 /*********************************************************/
224 { "dsn_from", opt_stringptr, &dsn_from },
225 { "envelope_to_remove", opt_bool, &envelope_to_remove },
226 { "errors_copy", opt_stringptr, &errors_copy },
227 { "errors_reply_to", opt_stringptr, &errors_reply_to },
228 { "exim_group", opt_gid, &exim_gid },
229 { "exim_path", opt_stringptr, &exim_path },
230 { "exim_user", opt_uid, &exim_uid },
231 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
232 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
233 { "finduser_retries", opt_int, &finduser_retries },
234 { "freeze_tell", opt_stringptr, &freeze_tell },
235 { "gecos_name", opt_stringptr, &gecos_name },
236 { "gecos_pattern", opt_stringptr, &gecos_pattern },
238 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
239 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
240 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
242 { "header_line_maxsize", opt_int, &header_line_maxsize },
243 { "header_maxsize", opt_int, &header_maxsize },
244 { "headers_charset", opt_stringptr, &headers_charset },
245 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
246 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
247 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
248 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
249 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
250 { "hold_domains", opt_stringptr, &hold_domains },
251 { "host_lookup", opt_stringptr, &host_lookup },
252 { "host_lookup_order", opt_stringptr, &host_lookup_order },
253 { "host_reject_connection", opt_stringptr, &host_reject_connection },
254 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
255 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
257 { "ibase_servers", opt_stringptr, &ibase_servers },
259 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
260 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
261 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
262 { "keep_malformed", opt_time, &keep_malformed },
264 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
265 { "ldap_version", opt_int, &eldap_version },
267 { "local_from_check", opt_bool, &local_from_check },
268 { "local_from_prefix", opt_stringptr, &local_from_prefix },
269 { "local_from_suffix", opt_stringptr, &local_from_suffix },
270 { "local_interfaces", opt_stringptr, &local_interfaces },
271 { "local_scan_timeout", opt_time, &local_scan_timeout },
272 { "local_sender_retain", opt_bool, &local_sender_retain },
273 { "localhost_number", opt_stringptr, &host_number_string },
274 { "log_file_path", opt_stringptr, &log_file_path },
275 { "log_selector", opt_stringptr, &log_selector_string },
276 { "log_timezone", opt_bool, &log_timezone },
277 { "lookup_open_max", opt_int, &lookup_open_max },
278 { "max_username_length", opt_int, &max_username_length },
279 { "message_body_newlines", opt_bool, &message_body_newlines },
280 { "message_body_visible", opt_mkint, &message_body_visible },
281 { "message_id_header_domain", opt_stringptr, &message_id_domain },
282 { "message_id_header_text", opt_stringptr, &message_id_text },
283 { "message_logs", opt_bool, &message_logs },
284 { "message_size_limit", opt_stringptr, &message_size_limit },
285 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
286 { "move_frozen_messages", opt_bool, &move_frozen_messages },
288 { "mua_wrapper", opt_bool, &mua_wrapper },
290 { "mysql_servers", opt_stringptr, &mysql_servers },
292 { "never_users", opt_uidlist, &never_users },
294 { "oracle_servers", opt_stringptr, &oracle_servers },
296 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
298 { "perl_at_start", opt_bool, &opt_perl_at_start },
299 { "perl_startup", opt_stringptr, &opt_perl_startup },
302 { "pgsql_servers", opt_stringptr, &pgsql_servers },
304 { "pid_file_path", opt_stringptr, &pid_file_path },
305 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
306 { "preserve_message_logs", opt_bool, &preserve_message_logs },
307 { "primary_hostname", opt_stringptr, &primary_hostname },
308 { "print_topbitchars", opt_bool, &print_topbitchars },
309 { "process_log_path", opt_stringptr, &process_log_path },
310 { "prod_requires_admin", opt_bool, &prod_requires_admin },
311 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
312 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
313 { "queue_domains", opt_stringptr, &queue_domains },
314 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
315 { "queue_only", opt_bool, &queue_only },
316 { "queue_only_file", opt_stringptr, &queue_only_file },
317 { "queue_only_load", opt_fixed, &queue_only_load },
318 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
319 { "queue_only_override", opt_bool, &queue_only_override },
320 { "queue_run_in_order", opt_bool, &queue_run_in_order },
321 { "queue_run_max", opt_int, &queue_run_max },
322 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
323 { "receive_timeout", opt_time, &receive_timeout },
324 { "received_header_text", opt_stringptr, &received_header_text },
325 { "received_headers_max", opt_int, &received_headers_max },
326 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
327 { "recipients_max", opt_int, &recipients_max },
328 { "recipients_max_reject", opt_bool, &recipients_max_reject },
329 { "remote_max_parallel", opt_int, &remote_max_parallel },
330 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
331 { "retry_data_expire", opt_time, &retry_data_expire },
332 { "retry_interval_max", opt_time, &retry_interval_max },
333 { "return_path_remove", opt_bool, &return_path_remove },
334 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
335 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
336 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
337 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
338 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
339 { "smtp_accept_max", opt_int, &smtp_accept_max },
340 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
341 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
342 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
343 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
344 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
345 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
346 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
347 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
348 { "smtp_banner", opt_stringptr, &smtp_banner },
349 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
350 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
351 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
352 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
353 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
354 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
355 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
356 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
357 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
358 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
359 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
360 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
361 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
362 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
363 #ifdef WITH_CONTENT_SCAN
364 { "spamd_address", opt_stringptr, &spamd_address },
366 #ifdef EXPERIMENTAL_SPF
367 { "spf_guess", opt_stringptr, &spf_guess },
369 { "split_spool_directory", opt_bool, &split_spool_directory },
370 { "spool_directory", opt_stringptr, &spool_directory },
372 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
374 #ifdef EXPERIMENTAL_SRS
375 { "srs_config", opt_stringptr, &srs_config },
376 { "srs_hashlength", opt_int, &srs_hashlength },
377 { "srs_hashmin", opt_int, &srs_hashmin },
378 { "srs_maxage", opt_int, &srs_maxage },
379 { "srs_secrets", opt_stringptr, &srs_secrets },
380 { "srs_usehash", opt_bool, &srs_usehash },
381 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
383 { "strict_acl_vars", opt_bool, &strict_acl_vars },
384 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
385 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
386 { "syslog_duplication", opt_bool, &syslog_duplication },
387 { "syslog_facility", opt_stringptr, &syslog_facility_str },
388 { "syslog_processname", opt_stringptr, &syslog_processname },
389 { "syslog_timestamp", opt_bool, &syslog_timestamp },
390 { "system_filter", opt_stringptr, &system_filter },
391 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
392 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
393 { "system_filter_group", opt_gid, &system_filter_gid },
394 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
395 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
396 { "system_filter_user", opt_uid, &system_filter_uid },
397 { "tcp_nodelay", opt_bool, &tcp_nodelay },
398 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
399 { "timezone", opt_stringptr, &timezone_string },
401 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
402 { "tls_certificate", opt_stringptr, &tls_certificate },
403 { "tls_crl", opt_stringptr, &tls_crl },
404 { "tls_dhparam", opt_stringptr, &tls_dhparam },
405 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
406 { "tls_privatekey", opt_stringptr, &tls_privatekey },
407 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
408 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
409 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
410 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
411 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
413 { "trusted_groups", opt_gidlist, &trusted_groups },
414 { "trusted_users", opt_uidlist, &trusted_users },
415 { "unknown_login", opt_stringptr, &unknown_login },
416 { "unknown_username", opt_stringptr, &unknown_username },
417 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
418 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
419 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
420 { "warn_message_file", opt_stringptr, &warn_message_file },
421 { "write_rejectlog", opt_bool, &write_rejectlog }
424 static int optionlist_config_size =
425 sizeof(optionlist_config)/sizeof(optionlist);
429 /*************************************************
430 * Find the name of an option *
431 *************************************************/
433 /* This function is to aid debugging. Various functions take arguments that are
434 pointer variables in the options table or in option tables for various drivers.
435 For debugging output, it is useful to be able to find the name of the option
436 which is currently being processed. This function finds it, if it exists, by
437 searching the table(s).
439 Arguments: a value that is presumed to be in the table above
440 Returns: the option name, or an empty string
444 readconf_find_option(void *p)
448 transport_instance *t;
450 for (i = 0; i < optionlist_config_size; i++)
451 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
453 for (r = routers; r != NULL; r = r->next)
455 router_info *ri = r->info;
456 for (i = 0; i < ri->options_count[0]; i++)
458 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
459 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
460 return US ri->options[i].name;
464 for (t = transports; t != NULL; t = t->next)
466 transport_info *ti = t->info;
467 for (i = 0; i < ti->options_count[0]; i++)
469 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
470 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
471 return US ti->options[i].name;
481 /*************************************************
482 * Deal with an assignment to a macro *
483 *************************************************/
485 /* This function is called when a line that starts with an upper case letter is
486 encountered. The argument "line" should contain a complete logical line, and
487 start with the first letter of the macro name. The macro name and the
488 replacement text are extracted and stored. Redefinition of existing,
489 non-command line, macros is permitted using '==' instead of '='.
492 s points to the start of the logical line
498 read_macro_assignment(uschar *s)
504 macro_item *mlast = NULL;
506 while (isalnum(*s) || *s == '_')
508 if (namelen >= sizeof(name) - 1)
509 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
510 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
511 name[namelen++] = *s++;
515 while (isspace(*s)) s++;
517 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
524 while (isspace(*s)) s++;
526 /* If an existing macro of the same name was defined on the command line, we
527 just skip this definition. It's an error to attempt to redefine a macro without
528 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
529 It is also an error to define a macro whose name begins with the name of a
530 previously defined macro. Note: it is documented that the other way round
533 for (m = macros; m != NULL; m = m->next)
535 int len = Ustrlen(m->name);
537 if (Ustrcmp(m->name, name) == 0)
539 if (!m->command_line && !redef)
540 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
541 "defined (use \"==\" if you want to redefine it", name);
545 if (len < namelen && Ustrstr(name, m->name) != NULL)
546 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
547 "a macro because previously defined macro \"%s\" is a substring",
550 /* We cannot have this test, because it is documented that a substring
551 macro is permitted (there is even an example).
553 * if (len > namelen && Ustrstr(m->name, name) != NULL)
554 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
555 * "a macro because it is a substring of previously defined macro \"%s\"",
562 /* Check for an overriding command-line definition. */
564 if (m != NULL && m->command_line) return;
566 /* Redefinition must refer to an existing macro. */
571 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
575 /* We have a new definition. The macro_item structure includes a final vector
576 called "name" which is one byte long. Thus, adding "namelen" gives us enough
577 room to store the "name" string. */
581 m = store_get(sizeof(macro_item) + namelen);
582 if (macros == NULL) macros = m; else mlast->next = m;
583 Ustrncpy(m->name, name, namelen);
584 m->name[namelen] = 0;
586 m->command_line = FALSE;
589 /* Set the value of the new or redefined macro */
591 m->replacement = string_copy(s);
598 /*************************************************
599 * Read configuration line *
600 *************************************************/
602 /* A logical line of text is read from the configuration file into the big
603 buffer, taking account of macros, .includes, and continuations. The size of
604 big_buffer is increased if necessary. The count of configuration lines is
605 maintained. Physical input lines starting with # (ignoring leading white space,
606 and after macro replacement) and empty logical lines are always ignored.
607 Leading and trailing spaces are removed.
609 If we hit a line of the form "begin xxxx", the xxxx is placed in the
610 next_section vector, and the function returns NULL, indicating the end of a
611 configuration section. On end-of-file, NULL is returned with next_section
616 Returns: a pointer to the first non-blank in the line,
617 or NULL if eof or end of section is reached
621 get_config_line(void)
623 int startoffset = 0; /* To first non-blank char in logical line */
624 int len = 0; /* Of logical line so far */
630 /* Loop for handling continuation lines, skipping comments, and dealing with
635 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
637 if (config_file_stack != NULL) /* EOF inside .include */
639 (void)fclose(config_file);
640 config_file = config_file_stack->file;
641 config_filename = config_file_stack->filename;
642 config_lineno = config_file_stack->lineno;
643 config_file_stack = config_file_stack->next;
647 /* EOF at top level */
649 if (cstate_stack_ptr >= 0)
650 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
651 "Unexpected end of configuration file: .endif missing");
653 if (len != 0) break; /* EOF after continuation */
654 next_section[0] = 0; /* EOF at start of logical line */
659 newlen = len + Ustrlen(big_buffer + len);
661 /* Handle pathologically long physical lines - yes, it did happen - by
662 extending big_buffer at this point. The code also copes with very long
665 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
668 big_buffer_size += BIG_BUFFER_SIZE;
669 newbuffer = store_malloc(big_buffer_size);
671 /* This use of strcpy is OK because we know that the string in the old
672 buffer is shorter than the new buffer. */
674 Ustrcpy(newbuffer, big_buffer);
675 store_free(big_buffer);
676 big_buffer = newbuffer;
677 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
679 newlen += Ustrlen(big_buffer + newlen);
682 /* Find the true start of the physical line - leading spaces are always
685 ss = big_buffer + len;
686 while (isspace(*ss)) ss++;
688 /* Process the physical line for macros. If this is the start of the logical
689 line, skip over initial text at the start of the line if it starts with an
690 upper case character followed by a sequence of name characters and an equals
691 sign, because that is the definition of a new macro, and we don't do
692 replacement therein. */
695 if (len == 0 && isupper(*s))
697 while (isalnum(*s) || *s == '_') s++;
698 while (isspace(*s)) s++;
699 if (*s != '=') s = ss; /* Not a macro definition */
702 /* For each defined macro, scan the line (from after XXX= if present),
703 replacing all occurrences of the macro. */
706 for (m = macros; m != NULL; m = m->next)
711 while ((p = Ustrstr(t, m->name)) != NULL)
714 int namelen = Ustrlen(m->name);
715 int replen = Ustrlen(m->replacement);
717 /* Expand the buffer if necessary */
719 while (newlen - namelen + replen + 1 > big_buffer_size)
721 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
722 uschar *newbuffer = store_malloc(newsize);
723 memcpy(newbuffer, big_buffer, newlen + 1);
724 p = newbuffer + (p - big_buffer);
725 s = newbuffer + (s - big_buffer);
726 ss = newbuffer + (ss - big_buffer);
727 t = newbuffer + (t - big_buffer);
728 big_buffer_size = newsize;
729 store_free(big_buffer);
730 big_buffer = newbuffer;
733 /* Shuffle the remaining characters up or down in the buffer before
734 copying in the replacement text. Don't rescan the replacement for this
738 moveby = replen - namelen;
741 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
744 Ustrncpy(p, m->replacement, replen);
750 /* An empty macro replacement at the start of a line could mean that ss no
751 longer points to the first non-blank character. */
753 while (isspace(*ss)) ss++;
755 /* Check for comment lines - these are physical lines. */
757 if (*ss == '#') continue;
759 /* Handle conditionals, which are also applied to physical lines. Conditions
760 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
761 expansion occured on the rest of the line. A preliminary test for the leading
762 '.' saves effort on most lines. */
768 /* Search the list of conditional directives */
770 for (i = 0; i < cond_list_size; i++)
773 cond_item *c = cond_list+i;
774 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
776 /* The following character must be white space or end of string */
778 n = ss[1 + c->namelen];
779 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
781 /* .ifdef and .ifndef push the current state onto the stack, then set
782 a new one from the table. Stack overflow is an error */
786 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
788 ".%s nested too deeply", c->name);
789 cstate_stack[++cstate_stack_ptr] = cstate;
790 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
793 /* For any of the others, stack underflow is an error. The next state
794 comes either from the stack (.endif) or from the table. */
798 if (cstate_stack_ptr < 0)
799 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
800 ".%s without matching .ifdef", c->name);
801 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
802 next_cstate[cstate][macro_found? c->action1 : c->action2];
805 /* Having dealt with a directive, break the loop */
810 /* If we have handled a conditional directive, continue with the next
811 physical line. Otherwise, fall through. */
813 if (i < cond_list_size) continue;
816 /* If the conditional state is not 0 (actively using these lines), ignore
819 if (cstate != 0) continue; /* Conditional skip */
821 /* Handle .include lines - these are also physical lines. */
823 if (Ustrncmp(ss, ".include", 8) == 0 &&
825 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
828 int include_if_exists = isspace(ss[8])? 0 : 10;
829 config_file_item *save;
832 ss += 9 + include_if_exists;
833 while (isspace(*ss)) ss++;
834 t = ss + Ustrlen(ss);
835 while (t > ss && isspace(t[-1])) t--;
836 if (*ss == '\"' && t[-1] == '\"')
844 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
845 "absolute path \"%s\"", ss);
847 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
849 save = store_get(sizeof(config_file_item));
850 save->next = config_file_stack;
851 config_file_stack = save;
852 save->file = config_file;
853 save->filename = config_filename;
854 save->lineno = config_lineno;
856 config_file = Ufopen(ss, "rb");
857 if (config_file == NULL)
858 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
859 "configuration file %s", ss);
860 config_filename = string_copy(ss);
865 /* If this is the start of the logical line, remember where the non-blank
866 data starts. Otherwise shuffle down continuation lines to remove leading
870 startoffset = ss - big_buffer;
873 s = big_buffer + len;
876 memmove(s, ss, (newlen - len) - (ss - s) + 1);
881 /* Accept the new addition to the line. Remove trailing white space. */
884 while (len > 0 && isspace(big_buffer[len-1])) len--;
887 /* We are done if the line does not end in backslash and contains some data.
888 Empty logical lines are ignored. For continuations, remove the backslash and
889 go round the loop to read the continuation line. */
893 if (big_buffer[len-1] != '\\') break; /* End of logical line */
894 big_buffer[--len] = 0; /* Remove backslash */
896 } /* Loop for reading multiple physical lines */
898 /* We now have a logical line. Test for the end of a configuration section (or,
899 more accurately, for the start of the next section). Place the name of the next
900 section in next_section, and return NULL. If the name given is longer than
901 next_section, truncate it. It will be unrecognized later, because all the known
902 section names do fit. Leave space for pluralizing. */
904 s = big_buffer + startoffset; /* First non-space character */
905 if (strncmpic(s, US"begin ", 6) == 0)
908 while (isspace(*s)) s++;
909 if (big_buffer + len - s > sizeof(next_section) - 2)
910 s[sizeof(next_section) - 2] = 0;
911 Ustrcpy(next_section, s);
915 /* Return the first non-blank character. */
922 /*************************************************
924 *************************************************/
926 /* The yield is the pointer to the next uschar. Names longer than the
927 output space are silently truncated. This function is also used from acl.c when
931 name where to put the name
935 Returns: new input pointer
939 readconf_readname(uschar *name, int len, uschar *s)
942 while (isspace(*s)) s++;
945 while (isalnum(*s) || *s == '_')
947 if (p < len-1) name[p++] = *s;
952 while (isspace(*s)) s++;
959 /*************************************************
960 * Read a time value *
961 *************************************************/
963 /* This function is also called from outside, to read argument
964 time values. The format of a time value is:
966 [<n>w][<n>d][<n>h][<n>m][<n>s]
968 as long as at least one is present. If a format error is encountered,
969 return a negative value. The value must be terminated by the given
974 terminator required terminating character
975 return_msec if TRUE, allow fractional seconds and return milliseconds
977 Returns: the time value, or -1 on syntax error
978 value is seconds if return_msec is FALSE
979 value is milliseconds if return_msec is TRUE
983 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
991 if (!isdigit(*s)) return -1;
992 (void)sscanf(CS s, "%d%n", &value, &count);
997 case 'w': value *= 7;
998 case 'd': value *= 24;
999 case 'h': value *= 60;
1000 case 'm': value *= 60;
1005 if (!return_msec) return -1;
1006 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1008 if (*s++ != 's') return -1;
1009 yield += (int)(fraction * 1000.0);
1015 if (return_msec) value *= 1000;
1017 if (*s == terminator) return yield;
1019 /* Control never reaches here. */
1024 /*************************************************
1025 * Read a fixed point value *
1026 *************************************************/
1028 /* The value is returned *1000
1032 terminator required terminator
1034 Returns: the value, or -1 on error
1038 readconf_readfixed(uschar *s, int terminator)
1042 if (!isdigit(*s)) return -1;
1043 (void)sscanf(CS s, "%d%n", &value, &count);
1045 yield = value * 1000;
1049 while (isdigit((*(++s))))
1051 yield += (*s - '0') * m;
1056 return (*s == terminator)? yield : (-1);
1061 /*************************************************
1062 * Find option in list *
1063 *************************************************/
1065 /* The lists are always in order, so binary chop can be used.
1068 name the option name to search for
1069 ol the first entry in the option list
1070 last one more than the offset of the last entry in the option list
1072 Returns: pointer to an option entry, or NULL if not found
1076 find_option(uschar *name, optionlist *ol, int last)
1079 while (last > first)
1081 int middle = (first + last)/2;
1082 int c = Ustrcmp(name, ol[middle].name);
1083 if (c == 0) return ol + middle;
1084 else if (c > 0) first = middle + 1;
1092 /*************************************************
1093 * Find a set flag in option list *
1094 *************************************************/
1096 /* Because some versions of Unix make no restrictions on the values of uids and
1097 gids (even negative ones), we cannot represent "unset" by a special value.
1098 There is therefore a separate boolean variable for each one indicating whether
1099 a value is set or not. This function returns a pointer to the boolean, given
1100 the original option name. It is a major disaster if the flag cannot be found.
1103 name the name of the uid or gid option
1104 oltop points to the start of the relevant option list
1105 last one more than the offset of the last item in the option list
1106 data_block NULL when reading main options => data values in the option
1107 list are absolute addresses; otherwise they are byte offsets
1108 in data_block (used for driver options)
1110 Returns: a pointer to the boolean flag.
1114 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1118 sprintf(CS name2, "*set_%.50s", name);
1119 ol = find_option(name2, oltop, last);
1120 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1121 "Exim internal error: missing set flag for %s", name);
1122 return (data_block == NULL)? (BOOL *)(ol->value) :
1123 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1129 /*************************************************
1130 * Output extra characters message and die *
1131 *************************************************/
1133 /* Called when an option line has junk on the end. Sometimes this is because
1134 the sysadmin thinks comments are permitted.
1137 s points to the extra characters
1138 t1..t3 strings to insert in the log message
1140 Returns: doesn't return; dies
1144 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1146 uschar *comment = US"";
1147 if (*s == '#') comment = US" (# is comment only at line start)";
1148 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1149 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1154 /*************************************************
1155 * Read rewrite information *
1156 *************************************************/
1158 /* Each line of rewrite information contains:
1160 . A complete address in the form user@domain, possibly with
1161 leading * for each part; or alternatively, a regex.
1163 . A replacement string (which will be expanded).
1165 . An optional sequence of one-letter flags, indicating which
1166 headers etc. to apply this rule to.
1168 All this is decoded and placed into a control block. The OR of the flags is
1169 maintained in a common word.
1172 p points to the string that makes up the rule
1173 existflags points to the overall flag word
1174 isglobal TRUE if reading global rewrite rules
1176 Returns: the control block for the parsed rule.
1179 static rewrite_rule *
1180 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1182 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1185 next->key = string_dequote(&p);
1187 while (isspace(*p)) p++;
1189 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1190 "missing rewrite replacement string");
1193 next->replacement = string_dequote(&p);
1195 while (*p != 0) switch (*p++)
1197 case ' ': case '\t': break;
1199 case 'q': next->flags |= rewrite_quit; break;
1200 case 'w': next->flags |= rewrite_whole; break;
1202 case 'h': next->flags |= rewrite_all_headers; break;
1203 case 's': next->flags |= rewrite_sender; break;
1204 case 'f': next->flags |= rewrite_from; break;
1205 case 't': next->flags |= rewrite_to; break;
1206 case 'c': next->flags |= rewrite_cc; break;
1207 case 'b': next->flags |= rewrite_bcc; break;
1208 case 'r': next->flags |= rewrite_replyto; break;
1210 case 'E': next->flags |= rewrite_all_envelope; break;
1211 case 'F': next->flags |= rewrite_envfrom; break;
1212 case 'T': next->flags |= rewrite_envto; break;
1214 case 'Q': next->flags |= rewrite_qualify; break;
1215 case 'R': next->flags |= rewrite_repeat; break;
1218 next->flags |= rewrite_smtp;
1219 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1221 "rewrite rule has the S flag but is not a regular expression");
1225 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1226 "unknown rewrite flag character '%c' "
1227 "(could be missing quotes round replacement item)", p[-1]);
1231 /* If no action flags are set, set all the "normal" rewrites. */
1233 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1234 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1236 /* Remember which exist, for optimization, and return the rule */
1238 *existflags |= next->flags;
1245 /*************************************************
1246 * Read global rewrite information *
1247 *************************************************/
1249 /* Each line is a single rewrite rule; it is parsed into a control block
1250 by readconf_one_rewrite(), and its flags are ORed into the global flag
1251 word rewrite_existflags. */
1254 readconf_rewrites(void)
1256 rewrite_rule **chain = &global_rewrite_rules;
1259 while ((p = get_config_line()) != NULL)
1261 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1263 chain = &(next->next);
1269 /*************************************************
1271 *************************************************/
1273 /* Strings are read into the normal store pool. As long we aren't too
1274 near the end of the current block, the string will just use what is necessary
1275 on the top of the stacking pool, because string_cat() uses the extension
1279 s the rest of the input line
1280 name the option name (for errors)
1282 Returns: pointer to the string
1286 read_string(uschar *s, uschar *name)
1291 if (*s != '\"') return string_copy(s);
1294 yield = string_dequote(&s);
1296 if (s == ss+1 || s[-1] != '\"')
1297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1298 "missing quote at end of string value for %s", name);
1300 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1306 /*************************************************
1307 * Handle option line *
1308 *************************************************/
1310 /* This function is called from several places to process a line containing the
1311 setting of an option. The first argument is the line to be decoded; it has been
1312 checked not to be empty and not to start with '#'. Trailing newlines and white
1313 space have been removed. The second argument is a pointer to the list of
1314 variable names that are to be recognized, together with their types and
1315 locations, and the third argument gives the number of entries in the list.
1317 The fourth argument is a pointer to a data block. If it is NULL, then the data
1318 values in the options list are absolute addresses. Otherwise, they are byte
1319 offsets in the data block.
1321 String option data may continue onto several lines; this function reads further
1322 data from config_file if necessary.
1324 The yield of this function is normally zero. If a string continues onto
1325 multiple lines, then the data value is permitted to be followed by a comma
1326 or a semicolon (for use in drivers) and the yield is that character.
1329 buffer contains the configuration line to be handled
1330 oltop points to the start of the relevant option list
1331 last one more than the offset of the last item in the option list
1332 data_block NULL when reading main options => data values in the option
1333 list are absolute addresses; otherwise they are byte offsets
1334 in data_block when they have opt_public set; otherwise
1335 they are byte offsets in data_block->options_block.
1336 unknown_txt format string to use in panic message for unknown option;
1337 must contain %s for option name
1338 if given as NULL, don't panic on unknown option
1340 Returns: TRUE if an option was read successfully,
1341 FALSE false for an unknown option if unknown_txt == NULL,
1342 otherwise panic and die on an unknown option
1346 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1347 void *data_block, uschar *unknown_txt)
1351 int n, count, type, value;
1355 BOOL boolvalue = TRUE;
1356 BOOL freesptr = TRUE;
1357 optionlist *ol, *ol2;
1361 uschar *inttype = US"";
1367 /* There may be leading spaces; thereafter, we expect an option name starting
1370 while (isspace(*s)) s++;
1372 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1374 /* Read the name of the option, and skip any subsequent white space. If
1375 it turns out that what we read was "hide", set the flag indicating that
1376 this is a secure option, and loop to read the next word. */
1378 for (n = 0; n < 2; n++)
1380 while (isalnum(*s) || *s == '_')
1382 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1386 while (isspace(*s)) s++;
1387 if (Ustrcmp(name, "hide") != 0) break;
1388 issecure = opt_secure;
1392 /* Deal with "no_" or "not_" here for booleans */
1394 if (Ustrncmp(name, "no_", 3) == 0)
1400 if (Ustrncmp(name, "not_", 4) == 0)
1406 /* Search the list for the given name. A non-existent name, or an option that
1407 is set twice, is a disaster. */
1409 ol = find_option(name + offset, oltop, last);
1413 if (unknown_txt == NULL) return FALSE;
1414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1417 if ((ol->type & opt_set) != 0)
1419 uschar *mname = name;
1420 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1421 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1422 "\"%s\" option set for the second time", mname);
1425 ol->type |= opt_set | issecure;
1426 type = ol->type & opt_mask;
1428 /* Types with data values must be followed by '='; the "no[t]_" prefix
1429 applies only to boolean values. */
1431 if (type < opt_bool || type > opt_bool_last)
1434 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1435 "negation prefix applied to a non-boolean option");
1437 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1438 "unexpected end of line (data missing) after %s", name);
1440 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1443 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1444 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1445 ultimately expands to one of those values. */
1447 else if (*s != 0 && (offset != 0 || *s != '='))
1448 extra_chars_error(s, US"boolean option ", name, US"");
1450 /* Skip white space after = */
1452 if (*s == '=') while (isspace((*(++s))));
1454 /* If there is a data block and the opt_public flag is not set, change
1455 the data block pointer to the private options block. */
1457 if (data_block != NULL && (ol->type & opt_public) == 0)
1458 data_block = (void *)(((driver_instance *)data_block)->options_block);
1460 /* Now get the data according to the type. */
1464 /* If a string value is not enclosed in quotes, it consists of
1465 the rest of the current line, verbatim. Otherwise, string escapes
1468 A transport is specified as a string, which is then looked up in the
1469 list of transports. A search type is specified as one of a number of
1472 A set or rewrite rules for a driver is specified as a string, which is
1473 then parsed into a suitable chain of control blocks.
1475 Uids and gids are specified as strings which are then looked up in the
1476 passwd file. Lists of uids and gids are similarly specified as colon-
1477 separated strings. */
1482 case opt_expand_uid:
1483 case opt_expand_gid:
1488 reset_point = sptr = read_string(s, name);
1490 /* Having read a string, we now have several different ways of using it,
1491 depending on the data type, so do another switch. If keeping the actual
1492 string is not required (because it is interpreted), freesptr is set TRUE,
1493 and at the end we reset the pool. */
1497 /* If this was a string, set the variable to point to the new string,
1498 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1499 rules, we still keep the string (for printing), and parse the rules into a
1500 control block and flags word. */
1504 if (data_block == NULL)
1505 *((uschar **)(ol->value)) = sptr;
1507 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1509 if (type == opt_rewrite)
1514 rewrite_rule **chain;
1517 sprintf(CS name2, "*%.50s_rules", name);
1518 ol2 = find_option(name2, oltop, last);
1519 sprintf(CS name2, "*%.50s_flags", name);
1520 ol3 = find_option(name2, oltop, last);
1522 if (ol2 == NULL || ol3 == NULL)
1523 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1524 "rewrite rules not available for driver");
1526 if (data_block == NULL)
1528 chain = (rewrite_rule **)(ol2->value);
1529 flagptr = (int *)(ol3->value);
1533 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1534 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1537 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1540 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1542 chain = &(next->next);
1545 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1546 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1547 "non-header rewrite - not allowed at transport time -");
1551 /* If it was an expanded uid, see if there is any expansion to be
1552 done by checking for the presence of a $ character. If there is, save it
1553 in the corresponding *expand_user option field. Otherwise, fall through
1554 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1557 case opt_expand_uid:
1558 sprintf(CS name2, "*expand_%.50s", name);
1559 ol2 = find_option(name2, oltop, last);
1562 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1564 if (data_block == NULL)
1565 *((uschar **)(ol2->value)) = ss;
1567 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1571 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1577 /* Look up a fixed uid, and also make use of the corresponding gid
1578 if a passwd entry is returned and the gid has not been set. */
1581 if (!route_finduser(sptr, &pw, &uid))
1582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1583 if (data_block == NULL)
1584 *((uid_t *)(ol->value)) = uid;
1586 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1588 /* Set the flag indicating a fixed value is set */
1590 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1592 /* Handle matching gid if we have a passwd entry: done by finding the
1593 same name with terminating "user" changed to "group"; if not found,
1594 ignore. Also ignore if the value is already set. */
1596 if (pw == NULL) break;
1597 Ustrcpy(name+Ustrlen(name)-4, "group");
1598 ol2 = find_option(name, oltop, last);
1599 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1600 (ol2->type & opt_mask) == opt_expand_gid))
1602 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1605 if (data_block == NULL)
1606 *((gid_t *)(ol2->value)) = pw->pw_gid;
1608 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1614 /* If it was an expanded gid, see if there is any expansion to be
1615 done by checking for the presence of a $ character. If there is, save it
1616 in the corresponding *expand_user option field. Otherwise, fall through
1617 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1620 case opt_expand_gid:
1621 sprintf(CS name2, "*expand_%.50s", name);
1622 ol2 = find_option(name2, oltop, last);
1625 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1627 if (data_block == NULL)
1628 *((uschar **)(ol2->value)) = ss;
1630 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1634 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1640 /* Handle freestanding gid */
1643 if (!route_findgroup(sptr, &gid))
1644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1645 if (data_block == NULL)
1646 *((gid_t *)(ol->value)) = gid;
1648 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1649 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1652 /* If it was a uid list, look up each individual entry, and build
1653 a vector of uids, with a count in the first element. Put the vector
1654 in malloc store so we can free the string. (We are reading into
1655 permanent store already.) */
1663 uschar *op = expand_string (sptr);
1666 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1667 name, expand_string_message);
1670 if (*p != 0) count++;
1671 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1672 list = store_malloc(count*sizeof(uid_t));
1673 list[ptr++] = (uid_t)(count - 1);
1675 if (data_block == NULL)
1676 *((uid_t **)(ol->value)) = list;
1678 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1684 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1685 if (!route_finduser(big_buffer, NULL, &uid))
1686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1693 /* If it was a gid list, look up each individual entry, and build
1694 a vector of gids, with a count in the first element. Put the vector
1695 in malloc store so we can free the string. (We are reading into permanent
1704 uschar *op = expand_string (sptr);
1707 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1708 name, expand_string_message);
1711 if (*p != 0) count++;
1712 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1713 list = store_malloc(count*sizeof(gid_t));
1714 list[ptr++] = (gid_t)(count - 1);
1716 if (data_block == NULL)
1717 *((gid_t **)(ol->value)) = list;
1719 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1725 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1726 if (!route_findgroup(big_buffer, &gid))
1727 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1735 /* Release store if the value of the string doesn't need to be kept. */
1737 if (freesptr) store_reset(reset_point);
1740 /* Expanded boolean: if no characters follow, or if there are no dollar
1741 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1742 save the string for later expansion in the alternate place. */
1744 case opt_expand_bool:
1745 if (*s != 0 && Ustrchr(s, '$') != 0)
1747 sprintf(CS name2, "*expand_%.50s", name);
1748 ol2 = find_option(name2, oltop, last);
1751 reset_point = sptr = read_string(s, name);
1752 if (data_block == NULL)
1753 *((uschar **)(ol2->value)) = sptr;
1755 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1762 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1763 look for yes/not/true/false. Some booleans are stored in a single bit in
1764 a single int. There's a special fudge for verify settings; without a suffix
1765 they set both xx_sender and xx_recipient. The table points to the sender
1766 value; search subsequently for the recipient. There's another special case:
1767 opt_bool_set also notes when a boolean has been set. */
1771 case opt_bool_verify:
1775 s = readconf_readname(name2, 64, s);
1776 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1778 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1780 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1781 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1782 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1783 US"for boolean option ", name);
1786 /* Handle single-bit type. */
1788 if (type == opt_bit)
1790 int bit = 1 << ((ol->type >> 16) & 31);
1791 int *ptr = (data_block == NULL)?
1792 (int *)(ol->value) :
1793 (int *)((uschar *)data_block + (long int)ol->value);
1794 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1798 /* Handle full BOOL types */
1800 if (data_block == NULL)
1801 *((BOOL *)(ol->value)) = boolvalue;
1803 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1807 if (type == opt_bool_verify)
1809 sprintf(CS name2, "%.50s_recipient", name + offset);
1810 ol2 = find_option(name2, oltop, last);
1813 if (data_block == NULL)
1814 *((BOOL *)(ol2->value)) = boolvalue;
1816 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1820 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1822 else if (type == opt_bool_set)
1824 sprintf(CS name2, "*set_%.50s", name + offset);
1825 ol2 = find_option(name2, oltop, last);
1828 if (data_block == NULL)
1829 *((BOOL *)(ol2->value)) = TRUE;
1831 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1840 inttype = US"octal ";
1842 /* Integer: a simple(ish) case; allow octal and hex formats, and
1843 suffixes K and M. The different types affect output, not input. */
1852 lvalue = strtol(CS s, CSS &endptr, intbase);
1855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1858 if (errno != ERANGE)
1860 if (tolower(*endptr) == 'k')
1862 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1863 else lvalue *= 1024;
1866 else if (tolower(*endptr) == 'm')
1868 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1870 else lvalue *= 1024*1024;
1875 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1876 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1877 "absolute value of integer \"%s\" is too large (overflow)", s);
1879 while (isspace(*endptr)) endptr++;
1881 extra_chars_error(endptr, inttype, US"integer value for ", name);
1883 value = (int)lvalue;
1886 if (data_block == NULL)
1887 *((int *)(ol->value)) = value;
1889 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1892 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1899 value = strtol(CS s, CSS &endptr, intbase);
1902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1905 if (errno != ERANGE)
1907 if (tolower(*endptr) == 'm')
1909 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1913 else if (tolower(*endptr) == 'k')
1919 value = (value + 512)/1024;
1923 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1924 "absolute value of integer \"%s\" is too large (overflow)", s);
1926 while (isspace(*endptr)) endptr++;
1928 extra_chars_error(endptr, inttype, US"integer value for ", name);
1931 if (data_block == NULL)
1932 *((int *)(ol->value)) = value;
1934 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1937 /* Fixed-point number: held to 3 decimal places. */
1940 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1941 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1942 "fixed-point number expected for %s", name);
1944 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1945 "integer \"%s\" is too large (overflow)", s);
1949 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1950 "integer \"%s\" is too large (overflow)", s);
1952 if (s[count] == '.')
1955 while (isdigit(s[++count]))
1957 value += (s[count] - '0') * d;
1962 while (isspace(s[count])) count++;
1965 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1967 if (data_block == NULL)
1968 *((int *)(ol->value)) = value;
1970 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1973 /* There's a special routine to read time values. */
1976 value = readconf_readtime(s, 0, FALSE);
1978 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1980 if (data_block == NULL)
1981 *((int *)(ol->value)) = value;
1983 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1986 /* A time list is a list of colon-separated times, with the first
1987 element holding the size of the list and the second the number of
1993 int *list = (data_block == NULL)?
1994 (int *)(ol->value) :
1995 (int *)((uschar *)data_block + (long int)(ol->value));
1997 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
2000 uschar *snext = Ustrchr(s, ':');
2004 while (ss > s && isspace(ss[-1])) ss--;
2007 value = readconf_readtime(s, terminator, FALSE);
2009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2011 if (count > 1 && value <= list[count])
2012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2013 "time value out of order for %s", name);
2014 list[count+1] = value;
2015 if (snext == NULL) break;
2017 while (isspace(*s)) s++;
2020 if (count > list[0] - 2)
2021 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2023 if (count > 0 && list[2] == 0) count = 0;
2035 /*************************************************
2036 * Print a time value *
2037 *************************************************/
2040 Argument: a time value in seconds
2041 Returns: pointer to a fixed buffer containing the time as a string,
2042 in readconf_readtime() format
2046 readconf_printtime(int t)
2049 uschar *p = time_buffer;
2066 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2067 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2068 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2069 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2070 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2077 /*************************************************
2078 * Print an individual option value *
2079 *************************************************/
2081 /* This is used by the -bP option, so prints to the standard output.
2082 The entire options list is passed in as an argument, because some options come
2083 in pairs - typically uid/gid settings, which can either be explicit numerical
2084 values, or strings to be expanded later. If the numerical value is unset,
2085 search for "*expand_<name>" to see if there is a string equivalent.
2088 ol option entry, or NULL for an unknown option
2090 options_block NULL for main configuration options; otherwise points to
2091 a driver block; if the option doesn't have opt_public
2092 set, then options_block->options_block is where the item
2094 oltop points to the option list in which ol exists
2095 last one more than the offset of the last entry in optop
2101 print_ol(optionlist *ol, uschar *name, void *options_block,
2102 optionlist *oltop, int last)
2115 printf("%s is not a known option\n", name);
2119 /* Non-admin callers cannot see options that have been flagged secure by the
2122 if (!admin_user && (ol->type & opt_secure) != 0)
2124 printf("%s = <value not displayable>\n", name);
2128 /* Else show the value of the option */
2131 if (options_block != NULL)
2133 if ((ol->type & opt_public) == 0)
2134 options_block = (void *)(((driver_instance *)options_block)->options_block);
2135 value = (void *)((uschar *)options_block + (long int)value);
2138 switch(ol->type & opt_mask)
2141 case opt_rewrite: /* Show the text value */
2142 s = *((uschar **)value);
2143 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2147 printf("%s = %d\n", name, *((int *)value));
2152 int x = *((int *)value);
2153 if (x != 0 && (x & 1023) == 0)
2157 if ((x & 1023) == 0)
2162 printf("%s = %d%c\n", name, x, c);
2164 else printf("%s = %d\n", name, x);
2170 int x = *((int *)value);
2171 if (x == 0) printf("%s = 0\n", name);
2172 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2173 else printf("%s = %dK\n", name, x);
2178 printf("%s = %#o\n", name, *((int *)value));
2181 /* Can be negative only when "unset", in which case integer */
2185 int x = *((int *)value);
2188 if (x < 0) printf("%s =\n", name); else
2190 printf("%s = %d.", name, x/1000);
2203 /* If the numerical value is unset, try for the string value */
2205 case opt_expand_uid:
2206 if (! *get_set_flag(name, oltop, last, options_block))
2208 sprintf(CS name2, "*expand_%.50s", name);
2209 ol2 = find_option(name2, oltop, last);
2212 void *value2 = ol2->value;
2213 if (options_block != NULL)
2214 value2 = (void *)((uschar *)options_block + (long int)value2);
2215 s = *((uschar **)value2);
2216 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2221 /* Else fall through */
2224 if (! *get_set_flag(name, oltop, last, options_block))
2225 printf("%s =\n", name);
2228 pw = getpwuid(*((uid_t *)value));
2230 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2231 else printf("%s = %s\n", name, pw->pw_name);
2235 /* If the numerical value is unset, try for the string value */
2237 case opt_expand_gid:
2238 if (! *get_set_flag(name, oltop, last, options_block))
2240 sprintf(CS name2, "*expand_%.50s", name);
2241 ol2 = find_option(name2, oltop, last);
2242 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2244 void *value2 = ol2->value;
2245 if (options_block != NULL)
2246 value2 = (void *)((uschar *)options_block + (long int)value2);
2247 s = *((uschar **)value2);
2248 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2253 /* Else fall through */
2256 if (! *get_set_flag(name, oltop, last, options_block))
2257 printf("%s =\n", name);
2260 gr = getgrgid(*((int *)value));
2262 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2263 else printf("%s = %s\n", name, gr->gr_name);
2268 uidlist = *((uid_t **)value);
2269 printf("%s =", name);
2270 if (uidlist != NULL)
2274 for (i = 1; i <= (int)(uidlist[0]); i++)
2276 uschar *name = NULL;
2277 pw = getpwuid(uidlist[i]);
2278 if (pw != NULL) name = US pw->pw_name;
2279 if (name != NULL) printf("%c%s", sep, name);
2280 else printf("%c%ld", sep, (long int)(uidlist[i]));
2288 gidlist = *((gid_t **)value);
2289 printf("%s =", name);
2290 if (gidlist != NULL)
2294 for (i = 1; i <= (int)(gidlist[0]); i++)
2296 uschar *name = NULL;
2297 gr = getgrgid(gidlist[i]);
2298 if (gr != NULL) name = US gr->gr_name;
2299 if (name != NULL) printf("%c%s", sep, name);
2300 else printf("%c%ld", sep, (long int)(gidlist[i]));
2308 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2314 int *list = (int *)value;
2315 printf("%s = ", name);
2316 for (i = 0; i < list[1]; i++)
2317 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2323 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2327 case opt_expand_bool:
2328 sprintf(CS name2, "*expand_%.50s", name);
2329 ol2 = find_option(name2, oltop, last);
2330 if (ol2 != NULL && ol2->value != NULL)
2332 void *value2 = ol2->value;
2333 if (options_block != NULL)
2334 value2 = (void *)((uschar *)options_block + (long int)value2);
2335 s = *((uschar **)value2);
2338 printf("%s = %s\n", name, string_printing(s));
2341 /* s == NULL => string not set; fall through */
2347 case opt_bool_verify:
2349 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2356 /*************************************************
2357 * Print value from main configuration *
2358 *************************************************/
2360 /* This function, called as a result of encountering the -bP option,
2361 causes the value of any main configuration variable to be output if the
2362 second argument is NULL. There are some special values:
2364 all print all main configuration options
2365 configure_file print the name of the configuration file
2366 routers print the routers' configurations
2367 transports print the transports' configuration
2368 authenticators print the authenticators' configuration
2369 router_list print a list of router names
2370 transport_list print a list of transport names
2371 authenticator_list print a list of authentication mechanism names
2372 +name print a named list item
2373 local_scan print the local_scan options
2375 If the second argument is not NULL, it must be one of "router", "transport", or
2376 "authenticator" in which case the first argument identifies the driver whose
2377 options are to be printed.
2380 name option name if type == NULL; else driver name
2381 type NULL or driver type name, as described above
2387 readconf_print(uschar *name, uschar *type)
2389 BOOL names_only = FALSE;
2391 optionlist *ol2 = NULL;
2392 driver_instance *d = NULL;
2402 static uschar *types[] = { US"address", US"domain", US"host",
2404 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2405 &hostlist_anchor, &localpartlist_anchor };
2407 for (i = 0; i < 4; i++)
2409 t = tree_search(*(anchors[i]), name+1);
2413 printf("%slist %s = %s\n", types[i], name+1,
2414 ((namedlist_block *)(t->data.ptr))->string);
2419 printf("no address, domain, host, or local part list called \"%s\" "
2420 "exists\n", name+1);
2425 if (Ustrcmp(name, "configure_file") == 0)
2427 printf("%s\n", CS config_main_filename);
2431 if (Ustrcmp(name, "all") == 0)
2433 for (ol = optionlist_config;
2434 ol < optionlist_config + optionlist_config_size; ol++)
2436 if ((ol->type & opt_hidden) == 0)
2437 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2442 if (Ustrcmp(name, "local_scan") == 0)
2444 #ifndef LOCAL_SCAN_HAS_OPTIONS
2445 printf("local_scan() options are not supported\n");
2447 for (ol = local_scan_options;
2448 ol < local_scan_options + local_scan_options_count; ol++)
2450 print_ol(ol, US ol->name, NULL, local_scan_options,
2451 local_scan_options_count);
2457 if (Ustrcmp(name, "routers") == 0)
2462 else if (Ustrcmp(name, "transports") == 0)
2464 type = US"transport";
2468 else if (Ustrcmp(name, "authenticators") == 0)
2470 type = US"authenticator";
2474 else if (Ustrcmp(name, "authenticator_list") == 0)
2476 type = US"authenticator";
2481 else if (Ustrcmp(name, "router_list") == 0)
2487 else if (Ustrcmp(name, "transport_list") == 0)
2489 type = US"transport";
2495 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2496 name, NULL, optionlist_config, optionlist_config_size);
2501 /* Handle the options for a router or transport. Skip options that are flagged
2502 as hidden. Some of these are options with names starting with '*', used for
2503 internal alternative representations of other options (which the printing
2504 function will sort out). Others are synonyms kept for backward compatibility.
2507 if (Ustrcmp(type, "router") == 0)
2509 d = (driver_instance *)routers;
2510 ol2 = optionlist_routers;
2511 size = optionlist_routers_size;
2513 else if (Ustrcmp(type, "transport") == 0)
2515 d = (driver_instance *)transports;
2516 ol2 = optionlist_transports;
2517 size = optionlist_transports_size;
2519 else if (Ustrcmp(type, "authenticator") == 0)
2521 d = (driver_instance *)auths;
2522 ol2 = optionlist_auths;
2523 size = optionlist_auths_size;
2528 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2532 /* Either search for a given driver, or print all of them */
2534 for (; d != NULL; d = d->next)
2537 printf("\n%s %s:\n", d->name, type);
2538 else if (Ustrcmp(d->name, name) != 0) continue;
2540 for (ol = ol2; ol < ol2 + size; ol++)
2542 if ((ol->type & opt_hidden) == 0)
2543 print_ol(ol, US ol->name, d, ol2, size);
2546 for (ol = d->info->options;
2547 ol < d->info->options + *(d->info->options_count); ol++)
2549 if ((ol->type & opt_hidden) == 0)
2550 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2552 if (name != NULL) return;
2554 if (name != NULL) printf("%s %s not found\n", type, name);
2559 /*************************************************
2560 * Read a named list item *
2561 *************************************************/
2563 /* This function reads a name and a list (i.e. string). The name is used to
2564 save the list in a tree, sorted by its name. Each entry also has a number,
2565 which can be used for caching tests, but if the string contains any expansion
2566 items other than $key, the number is set negative to inhibit caching. This
2567 mechanism is used for domain, host, and address lists that are referenced by
2571 anchorp points to the tree anchor
2572 numberp points to the current number for this tree
2573 max the maximum number permitted
2574 s the text of the option line, starting immediately after the name
2576 tname the name of the list type, for messages
2582 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2585 BOOL forcecache = FALSE;
2588 namedlist_block *nb = store_get(sizeof(namedlist_block));
2590 if (Ustrncmp(s, "_cache", 6) == 0)
2597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2599 if (*numberp >= max)
2600 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2603 while (isspace(*s)) s++;
2605 while (isalnum(*s) || *s == '_') s++;
2606 t = store_get(sizeof(tree_node) + s-ss);
2607 Ustrncpy(t->name, ss, s-ss);
2609 while (isspace(*s)) s++;
2611 if (!tree_insertnode(anchorp, t))
2612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2613 "duplicate name \"%s\" for a named %s", t->name, tname);
2616 nb->number = *numberp;
2619 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2620 "missing '=' after \"%s\"", t->name);
2621 while (isspace(*s)) s++;
2622 nb->string = read_string(s, t->name);
2623 nb->cache_data = NULL;
2625 /* Check the string for any expansions; if any are found, mark this list
2626 uncacheable unless the user has explicited forced caching. */
2628 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2634 /*************************************************
2635 * Unpick data for a rate limit *
2636 *************************************************/
2638 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2642 s string, in the form t,b,f,l
2643 where t is the threshold (integer)
2644 b is the initial delay (time)
2645 f is the multiplicative factor (fixed point)
2646 k is the maximum time (time)
2647 threshold where to store threshold
2648 base where to store base in milliseconds
2649 factor where to store factor in milliseconds
2650 limit where to store limit
2652 Returns: nothing (panics on error)
2656 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2659 uschar bstring[16], lstring[16];
2661 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2662 factor, lstring) == 4)
2664 *base = readconf_readtime(bstring, 0, TRUE);
2665 *limit = readconf_readtime(lstring, 0, TRUE);
2666 if (*base >= 0 && *limit >= 0) return;
2668 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2674 /*************************************************
2675 * Read main configuration options *
2676 *************************************************/
2678 /* This function is the first to be called for configuration reading. It
2679 opens the configuration file and reads general configuration settings until
2680 it reaches the end of the configuration section. The file is then left open so
2681 that the remaining configuration data can subsequently be read if needed for
2684 The configuration file must be owned either by root or exim, and be writeable
2685 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2686 in the config file, so the test is done on the compiled in values. A slight
2687 anomaly, to be carefully documented.
2689 The name of the configuration file is taken from a list that is included in the
2690 binary of Exim. It can be altered from the command line, but if that is done,
2691 root privilege is immediately withdrawn unless the caller is root or exim.
2692 The first file on the list that exists is used.
2694 For use on multiple systems that share file systems, first look for a
2695 configuration file whose name has the current node name on the end. If that is
2696 not found, try the generic name. For really contorted configurations, that run
2697 multiple Exims with different uid settings, first try adding the effective uid
2698 before the node name. These complications are going to waste resources on most
2699 systems. Therefore they are available only when requested by compile-time
2706 struct stat statbuf;
2707 uschar *s, *filename;
2708 uschar *list = config_main_filelist;
2710 /* Loop through the possible file names */
2712 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2715 /* Cut out all the fancy processing unless specifically wanted */
2717 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2718 uschar *suffix = filename + Ustrlen(filename);
2720 /* Try for the node-specific file if a node name exists */
2722 #ifdef CONFIGURE_FILE_USE_NODE
2724 if (uname(&uts) >= 0)
2726 #ifdef CONFIGURE_FILE_USE_EUID
2727 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2728 config_file = Ufopen(filename, "rb");
2729 if (config_file == NULL)
2730 #endif /* CONFIGURE_FILE_USE_EUID */
2732 sprintf(CS suffix, ".%.256s", uts.nodename);
2733 config_file = Ufopen(filename, "rb");
2736 #endif /* CONFIGURE_FILE_USE_NODE */
2738 /* Otherwise, try the generic name, possibly with the euid added */
2740 #ifdef CONFIGURE_FILE_USE_EUID
2741 if (config_file == NULL)
2743 sprintf(CS suffix, ".%ld", (long int)original_euid);
2744 config_file = Ufopen(filename, "rb");
2746 #endif /* CONFIGURE_FILE_USE_EUID */
2748 /* Finally, try the unadorned name */
2750 if (config_file == NULL)
2753 config_file = Ufopen(filename, "rb");
2755 #else /* if neither defined */
2757 /* This is the common case when the fancy processing is not included. */
2759 config_file = Ufopen(filename, "rb");
2762 /* If the file does not exist, continue to try any others. For any other
2763 error, break out (and die). */
2765 if (config_file != NULL || errno != ENOENT) break;
2768 /* On success, save the name for verification; config_filename is used when
2769 logging configuration errors (it changes for .included files) whereas
2770 config_main_filename is the name shown by -bP. Failure to open a configuration
2771 file is a serious disaster. */
2773 if (config_file != NULL)
2775 config_filename = config_main_filename = string_copy(filename);
2779 if (filename == NULL)
2780 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2781 "%s", config_main_filelist);
2783 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2784 "configuration file %s", filename));
2787 /* Check the status of the file we have opened, unless it was specified on
2788 the command line, in which case privilege was given away at the start. */
2790 if (!config_changed)
2792 if (fstat(fileno(config_file), &statbuf) != 0)
2793 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2796 if ((statbuf.st_uid != root_uid && /* owner not root */
2797 statbuf.st_uid != exim_uid /* owner not exim */
2798 #ifdef CONFIGURE_OWNER
2799 && statbuf.st_uid != config_uid /* owner not the special one */
2802 (statbuf.st_gid != exim_gid /* group not exim & */
2803 #ifdef CONFIGURE_GROUP
2804 && statbuf.st_gid != config_gid /* group not the special one */
2806 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2808 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2810 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2811 "wrong owner, group, or mode", big_buffer);
2814 /* Process the main configuration settings. They all begin with a lower case
2815 letter. If we see something starting with an upper case letter, it is taken as
2816 a macro definition. */
2818 while ((s = get_config_line()) != NULL)
2820 if (isupper(s[0])) read_macro_assignment(s);
2822 else if (Ustrncmp(s, "domainlist", 10) == 0)
2823 read_named_list(&domainlist_anchor, &domainlist_count,
2824 MAX_NAMED_LIST, s+10, US"domain list");
2826 else if (Ustrncmp(s, "hostlist", 8) == 0)
2827 read_named_list(&hostlist_anchor, &hostlist_count,
2828 MAX_NAMED_LIST, s+8, US"host list");
2830 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2831 read_named_list(&addresslist_anchor, &addresslist_count,
2832 MAX_NAMED_LIST, s+11, US"address list");
2834 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2835 read_named_list(&localpartlist_anchor, &localpartlist_count,
2836 MAX_NAMED_LIST, s+13, US"local part list");
2839 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2840 NULL, US"main option \"%s\" unknown");
2844 /* If local_sender_retain is set, local_from_check must be unset. */
2846 if (local_sender_retain && local_from_check)
2847 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2848 "local_sender_retain are set; this combination is not allowed");
2850 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2853 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2855 /* The max retry interval must not be greater than 24 hours. */
2857 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2859 /* remote_max_parallel must be > 0 */
2861 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2863 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2864 start of a new SMTP message. */
2866 freeze_tell_config = freeze_tell;
2868 /* The primary host name may be required for expansion of spool_directory
2869 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2870 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2871 canonize it. Some people like upper case letters in their host names, so we
2872 don't force the case. */
2874 if (primary_hostname == NULL)
2878 if (uname(&uts) < 0)
2879 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2880 hostname = US uts.nodename;
2882 if (Ustrchr(hostname, '.') == NULL)
2885 struct hostent *hostdata;
2888 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2889 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2899 #if HAVE_GETIPNODEBYNAME
2901 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2903 hostdata = gethostbyname2(CS hostname, af);
2906 hostdata = gethostbyname(CS hostname);
2909 if (hostdata != NULL)
2911 hostname = US hostdata->h_name;
2915 if (af == AF_INET) break;
2920 primary_hostname = string_copy(hostname);
2923 /* Set up default value for smtp_active_hostname */
2925 smtp_active_hostname = primary_hostname;
2927 /* If spool_directory wasn't set in the build-time configuration, it must have
2928 got set above. Of course, writing to the log may not work if log_file_path is
2929 not set, but it will at least get to syslog or somewhere, with any luck. */
2931 if (*spool_directory == 0)
2932 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2935 /* Expand the spool directory name; it may, for example, contain the primary
2936 host name. Same comment about failure. */
2938 s = expand_string(spool_directory);
2940 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2941 "\"%s\": %s", spool_directory, expand_string_message);
2942 spool_directory = s;
2944 /* Expand log_file_path, which must contain "%s" in any component that isn't
2945 the null string or "syslog". It is also allowed to contain one instance of %D.
2946 However, it must NOT contain % followed by anything else. */
2948 if (*log_file_path != 0)
2951 int sep = ':'; /* Fixed for log file path */
2952 s = expand_string(log_file_path);
2954 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2955 "\"%s\": %s", log_file_path, expand_string_message);
2958 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2961 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2962 t = Ustrstr(sss, "%s");
2964 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2965 "contain \"%%s\"", sss);
2967 t = Ustrchr(sss, '%');
2970 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2971 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2972 "unexpected \"%%\" character", s);
2979 /* Interpret syslog_facility into an integer argument for 'ident' param to
2980 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2983 if (syslog_facility_str != NULL)
2986 uschar *s = syslog_facility_str;
2988 if ((Ustrlen(syslog_facility_str) >= 4) &&
2989 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2992 for (i = 0; i < syslog_list_size; i++)
2994 if (strcmpic(s, syslog_list[i].name) == 0)
2996 syslog_facility = syslog_list[i].value;
3001 if (i >= syslog_list_size)
3003 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3004 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3008 /* Expand pid_file_path */
3010 if (*pid_file_path != 0)
3012 s = expand_string(pid_file_path);
3014 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3015 "\"%s\": %s", pid_file_path, expand_string_message);
3019 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3022 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3024 /* Unpick the SMTP rate limiting options, if set */
3026 if (smtp_ratelimit_mail != NULL)
3028 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3029 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3032 if (smtp_ratelimit_rcpt != NULL)
3034 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3035 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3038 /* The qualify domains default to the primary host name */
3040 if (qualify_domain_sender == NULL)
3041 qualify_domain_sender = primary_hostname;
3042 if (qualify_domain_recipient == NULL)
3043 qualify_domain_recipient = qualify_domain_sender;
3045 /* Setting system_filter_user in the configuration sets the gid as well if a
3046 name is given, but a numerical value does not. */
3048 if (system_filter_uid_set && !system_filter_gid_set)
3050 struct passwd *pw = getpwuid(system_filter_uid);
3052 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3053 (long int)system_filter_uid);
3054 system_filter_gid = pw->pw_gid;
3055 system_filter_gid_set = TRUE;
3058 /* If the errors_reply_to field is set, check that it is syntactically valid
3059 and ensure it contains a domain. */
3061 if (errors_reply_to != NULL)
3064 int start, end, domain;
3065 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3066 &start, &end, &domain, FALSE);
3068 if (recipient == NULL)
3069 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3070 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3073 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3074 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3077 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3078 smtp_accept_max must also be set. */
3080 if (smtp_accept_max == 0 &&
3081 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3082 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3083 "smtp_accept_max must be set if smtp_accept_queue or "
3084 "smtp_accept_max_per_host is set");
3086 /* Set up the host number if anything is specified. It is an expanded string
3087 so that it can be computed from the host name, for example. We do this last
3088 so as to ensure that everything else is set up before the expansion. */
3090 if (host_number_string != NULL)
3093 uschar *s = expand_string(host_number_string);
3094 long int n = Ustrtol(s, &end, 0);
3095 while (isspace(*end)) end++;
3097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3098 "localhost_number value is not a number: %s", s);
3099 if (n > LOCALHOST_MAX)
3100 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3101 "localhost_number is greater than the maximum allowed value (%d)",
3107 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3109 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3110 tls_verify_certificates == NULL)
3111 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3112 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3113 (tls_verify_hosts != NULL)? "" : "try_");
3119 /*************************************************
3120 * Initialize one driver *
3121 *************************************************/
3123 /* This is called once the driver's generic options, if any, have been read.
3124 We can now find the driver, set up defaults for the private options, and
3125 unset any "set" bits in the private options table (which might have been
3126 set by another incarnation of the same driver).
3129 d pointer to driver instance block, with generic
3131 drivers_available vector of available drivers
3132 size_of_info size of each block in drivers_available
3133 class class of driver, for error message
3135 Returns: pointer to the driver info block
3138 static driver_info *
3139 init_driver(driver_instance *d, driver_info *drivers_available,
3140 int size_of_info, uschar *class)
3144 for (dd = drivers_available; dd->driver_name[0] != 0;
3145 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3147 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3150 int len = dd->options_len;
3152 d->options_block = store_get(len);
3153 memcpy(d->options_block, dd->options_block, len);
3154 for (i = 0; i < *(dd->options_count); i++)
3155 dd->options[i].type &= ~opt_set;
3160 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3161 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3163 return NULL; /* never obeyed */
3169 /*************************************************
3170 * Initialize driver list *
3171 *************************************************/
3173 /* This function is called for routers, transports, and authentication
3174 mechanisms. It reads the data from the current point in the configuration file
3175 up to the end of the section, and sets up a chain of instance blocks according
3176 to the file's contents. The file will already have been opened by a call to
3177 readconf_main, and must be left open for subsequent reading of further data.
3179 Any errors cause a panic crash. Note that the blocks with names driver_info and
3180 driver_instance must map the first portions of all the _info and _instance
3181 blocks for this shared code to work.
3184 class "router", "transport", or "authenticator"
3185 anchor &routers, &transports, &auths
3186 drivers_available available drivers
3187 size_of_info size of each info block
3188 instance_default points to default data for an instance
3189 instance_size size of instance block
3190 driver_optionlist generic option list
3191 driver_optionlist_count count of generic option list
3197 readconf_driver_init(
3199 driver_instance **anchor,
3200 driver_info *drivers_available,
3202 void *instance_default,
3204 optionlist *driver_optionlist,
3205 int driver_optionlist_count)
3207 driver_instance **p = anchor;
3208 driver_instance *d = NULL;
3211 while ((buffer = get_config_line()) != NULL)
3216 /* Read the first name on the line and test for the start of a new driver. A
3217 macro definition indicates the end of the previous driver. If this isn't the
3218 start of a new driver, the line will be re-read. */
3220 s = readconf_readname(name, sizeof(name), buffer);
3222 /* Handle macro definition, first finishing off the initialization of the
3223 previous driver, if any. */
3225 if (isupper(*name) && *s == '=')
3229 if (d->driver_name == NULL)
3230 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3231 "no driver defined for %s \"%s\"", class, d->name);
3235 read_macro_assignment(buffer);
3239 /* If the line starts with a name terminated by a colon, we are at the
3240 start of the definition of a new driver. The rest of the line must be
3247 /* Finish off initializing the previous driver. */
3251 if (d->driver_name == NULL)
3252 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3253 "no driver defined for %s \"%s\"", class, d->name);
3257 /* Check that we haven't already got a driver of this name */
3259 for (d = *anchor; d != NULL; d = d->next)
3260 if (Ustrcmp(name, d->name) == 0)
3261 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3262 "there are two %ss called \"%s\"", class, name);
3264 /* Set up a new driver instance data block on the chain, with
3265 its default values installed. */
3267 d = store_get(instance_size);
3268 memcpy(d, instance_default, instance_size);
3271 d->name = string_copy(name);
3273 /* Clear out the "set" bits in the generic options */
3275 for (i = 0; i < driver_optionlist_count; i++)
3276 driver_optionlist[i].type &= ~opt_set;
3278 /* Check nothing more on this line, then do the next loop iteration. */
3280 while (isspace(*s)) s++;
3281 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3285 /* Not the start of a new driver. Give an error if we have not set up a
3286 current driver yet. */
3288 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3289 "%s name missing", class);
3291 /* First look to see if this is a generic option; if it is "driver",
3292 initialize the driver. If is it not a generic option, we can look for a
3293 private option provided that the driver has been previously set up. */
3295 if (readconf_handle_option(buffer, driver_optionlist,
3296 driver_optionlist_count, d, NULL))
3298 if (d->info == NULL && d->driver_name != NULL)
3299 init_driver(d, drivers_available, size_of_info, class);
3302 /* Handle private options - pass the generic block because some may
3303 live therein. A flag with each option indicates if it is in the public
3306 else if (d->info != NULL)
3308 readconf_handle_option(buffer, d->info->options,
3309 *(d->info->options_count), d, US"option \"%s\" unknown");
3312 /* The option is not generic and the driver name has not yet been given. */
3314 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3315 "(\"driver\" must be specified before any private options)", name);
3318 /* Run the initialization function for the final driver. */
3322 if (d->driver_name == NULL)
3323 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3324 "no driver defined for %s \"%s\"", class, d->name);
3331 /*************************************************
3332 * Check driver dependency *
3333 *************************************************/
3335 /* This function is passed a driver instance and a string. It checks whether
3336 any of the string options for the driver contains the given string as an
3340 d points to a driver instance block
3341 s the string to search for
3343 Returns: TRUE if a dependency is found
3347 readconf_depends(driver_instance *d, uschar *s)
3349 int count = *(d->info->options_count);
3353 for (ol = d->info->options; ol < d->info->options + count; ol++)
3355 void *options_block;
3357 int type = ol->type & opt_mask;
3358 if (type != opt_stringptr) continue;
3359 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3360 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3361 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3363 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3364 isalnum(ss[Ustrlen(s)])) continue;
3365 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3366 d->name, ol->name, s);
3371 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3378 /*************************************************
3379 * Decode an error type for retries *
3380 *************************************************/
3382 /* This function is global because it is also called from the main
3383 program when testing retry information. It decodes strings such as "quota_7d"
3384 into numerical error codes.
3387 pp points to start of text
3388 p points past end of text
3389 basic_errno points to an int to receive the main error number
3390 more_errno points to an int to receive the secondary error data
3392 Returns: NULL if decoded correctly; else points to error text
3396 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3400 while (q < p && *q != '_') q++;
3403 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3405 *basic_errno = ERRNO_EXIMQUOTA;
3406 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3407 return US"bad time value";
3410 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3412 *basic_errno = ECONNREFUSED;
3415 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3416 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3417 else return US"A or MX expected after \"refused\"";
3421 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3423 *basic_errno = ETIMEDOUT;
3427 int xlen = p - q - 1;
3430 static uschar *extras[] =
3431 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3432 static int values[] =
3433 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3435 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3437 if (strncmpic(x, extras[i], xlen) == 0)
3439 *more_errno = values[i];
3444 if (i >= sizeof(extras)/sizeof(uschar *))
3446 if (strncmpic(x, US"DNS", xlen) == 0)
3448 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3449 "available in retry rules (it has never worked) - treated as "
3452 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3457 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3458 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3459 strncmpic(pp, US"data_4", 6) == 0)
3462 int x = 255; /* means "any 4xx code" */
3463 if (p != pp + 8) bad = TRUE; else
3465 int a = pp[6], b = pp[7];
3469 if (isdigit(b)) x += b - '0';
3470 else if (b == 'x') x += 100;
3473 else if (a != 'x' || b != 'x') bad = TRUE;
3477 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3478 "x is literal and d is any digit", pp);
3480 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3481 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3482 *more_errno = x << 8;
3485 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3486 strncmpic(q+1, US"failed", p-q-1) == 0)
3487 *basic_errno = ERRNO_AUTHFAIL;
3489 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3490 *basic_errno = ERRNO_SMTPCLOSED;
3492 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3493 *basic_errno = ERRNO_TLSREQUIRED;
3495 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3496 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3504 /*************************************************
3505 * Read retry information *
3506 *************************************************/
3508 /* Each line of retry information contains:
3510 . A domain name pattern or an address pattern;
3512 . An error name, possibly with additional data, or *;
3514 . An optional sequence of retry items, each consisting of an identifying
3515 letter, a cutoff time, and optional parameters.
3517 All this is decoded and placed into a control block. */
3520 /* Subroutine to read an argument, preceded by a comma and terminated
3521 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3522 1 = fixed point number (returned *1000).
3525 paddr pointer to pointer to current character; updated
3526 type 0 => read a time; 1 => read a fixed point number
3528 Returns: time in seconds or fixed point number * 1000
3532 retry_arg(uschar **paddr, int type)
3537 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3539 while (isspace(*p)) p++;
3541 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3543 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3544 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3550 return readconf_readtime(pp, *p, FALSE);
3552 return readconf_readfixed(pp, *p);
3554 return 0; /* Keep picky compilers happy */
3557 /* The function proper */
3560 readconf_retries(void)
3562 retry_config **chain = &retries;
3566 while ((p = get_config_line()) != NULL)
3568 retry_rule **rchain;
3571 next = store_get(sizeof(retry_config));
3574 chain = &(next->next);
3575 next->basic_errno = next->more_errno = 0;
3576 next->senders = NULL;
3578 rchain = &(next->rules);
3580 next->pattern = string_dequote(&p);
3581 while (isspace(*p)) p++;
3583 while (mac_isgraph(*p)) p++;
3584 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3585 "missing error type");
3587 /* Test error names for things we understand. */
3589 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3590 &(next->more_errno))) != NULL)
3591 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3593 /* There may be an optional address list of senders to be used as another
3594 constraint on the rule. This was added later, so the syntax is a bit of a
3595 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3598 while (isspace(*p)) p++;
3599 if (Ustrncmp(p, "senders", 7) == 0)
3602 while (isspace(*p)) p++;
3603 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3604 "\"=\" expected after \"senders\" in retry rule");
3605 while (isspace(*p)) p++;
3606 next->senders = string_dequote(&p);
3609 /* Now the retry rules. Keep the maximum timeout encountered. */
3611 while (isspace(*p)) p++;
3615 retry_rule *rule = store_get(sizeof(retry_rule));
3617 rchain = &(rule->next);
3619 rule->rule = toupper(*p++);
3620 rule->timeout = retry_arg(&p, 0);
3621 if (rule->timeout > retry_maximum_timeout)
3622 retry_maximum_timeout = rule->timeout;
3626 case 'F': /* Fixed interval */
3627 rule->p1 = retry_arg(&p, 0);
3630 case 'G': /* Geometrically increasing intervals */
3631 case 'H': /* Ditto, but with randomness */
3632 rule->p1 = retry_arg(&p, 0);
3633 rule->p2 = retry_arg(&p, 1);
3637 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3641 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3642 (rule->rule != 'F' && rule->p2 < 1000))
3643 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3644 "bad parameters for retry rule");
3646 while (isspace(*p)) p++;
3650 while (isspace(*p)) p++;
3653 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3660 /*************************************************
3661 * Initialize authenticators *
3662 *************************************************/
3664 /* Read the authenticators section of the configuration file.
3673 auth_instance *au, *bu;
3674 readconf_driver_init(US"authenticator",
3675 (driver_instance **)(&auths), /* chain anchor */
3676 (driver_info *)auths_available, /* available drivers */
3677 sizeof(auth_info), /* size of info block */
3678 &auth_defaults, /* default values for generic options */
3679 sizeof(auth_instance), /* size of instance block */
3680 optionlist_auths, /* generic options */
3681 optionlist_auths_size);
3683 for (au = auths; au != NULL; au = au->next)
3685 if (au->public_name == NULL)
3686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3687 "the %s authenticator", au->name);
3688 for (bu = au->next; bu != NULL; bu = bu->next)
3690 if (strcmpic(au->public_name, bu->public_name) == 0)
3692 if ((au->client && bu->client) || (au->server && bu->server))
3693 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3694 "(%s and %s) have the same public name (%s)",
3695 (au->client)? US"client" : US"server", au->name, bu->name,
3705 /*************************************************
3706 * Read ACL information *
3707 *************************************************/
3709 /* If this run of Exim is not doing something that involves receiving a
3710 message, we can just skip over the ACL information. No need to parse it.
3712 First, we have a function for acl_read() to call back to get the next line. We
3713 need to remember the line we passed, because at the end it will contain the
3714 name of the next ACL. */
3716 static uschar *acl_line;
3721 acl_line = get_config_line();
3726 /* Now the main function:
3729 skip TRUE when this Exim process is doing something that will
3730 not need the ACL data
3736 readconf_acl(BOOL skip)
3740 /* Not receiving messages, don't need to parse the ACL data */
3744 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3745 while ((p = get_config_line()) != NULL);
3749 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3752 acl_line = get_config_line();
3754 while(acl_line != NULL)
3760 p = readconf_readname(name, sizeof(name), acl_line);
3761 if (isupper(*name) && *p == '=')
3763 read_macro_assignment(acl_line);
3764 acl_line = get_config_line();
3768 if (*p != ':' || name[0] == 0)
3769 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3771 node = store_get(sizeof(tree_node) + Ustrlen(name));
3772 Ustrcpy(node->name, name);
3773 if (!tree_insertnode(&acl_anchor, node))
3774 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3775 "there are two ACLs called \"%s\"", name);
3777 node->data.ptr = acl_read(acl_callback, &error);
3779 if (node->data.ptr == NULL && error != NULL)
3780 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3786 /*************************************************
3787 * Read configuration for local_scan() *
3788 *************************************************/
3790 /* This function is called after "begin local_scan" is encountered in the
3791 configuration file. If the local_scan() function allows for configuration
3792 options, we can process them. Otherwise, we expire in a panic.
3799 local_scan_init(void)
3801 #ifndef LOCAL_SCAN_HAS_OPTIONS
3802 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3803 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3807 while ((p = get_config_line()) != NULL)
3809 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3810 NULL, US"local_scan option \"%s\" unknown");
3817 /*************************************************
3818 * Read rest of configuration (after main) *
3819 *************************************************/
3821 /* This function reads the rest of the runtime configuration, after the main
3822 configuration. It is called only when actually needed. Each subsequent section
3823 of the configuration starts with a line of the form
3827 where the name is "routers", "transports", etc. A section is terminated by
3828 hitting the next "begin" line, and the next name is left in next_section.
3829 Because it may confuse people as to whether the names are singular or plural,
3830 we add "s" if it's missing. There is always enough room in next_section for
3831 this. This function is basically just a switch.
3834 skip_acl TRUE if ACL information is not needed
3839 static uschar *section_list[] = {
3849 readconf_rest(BOOL skip_acl)
3853 while(next_section[0] != 0)
3857 int last = sizeof(section_list) / sizeof(uschar *);
3859 int n = Ustrlen(next_section);
3861 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3865 int c = strcmpic(next_section, section_list[mid]);
3867 if (c > 0) first = mid + 1; else last = mid;
3869 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3870 "\"%.*s\" is not a known configuration section name", n, next_section);
3871 mid = (last + first)/2;
3875 if (((had ^= bit) & bit) == 0)
3876 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3877 "\"%.*s\" section is repeated in the configuration file", n,
3882 case 0: readconf_acl(skip_acl); break;
3883 case 1: auths_init(); break;
3884 case 2: local_scan_init(); break;
3885 case 3: readconf_retries(); break;
3886 case 4: readconf_rewrites(); break;
3887 case 5: route_init(); break;
3888 case 6: transport_init(); break;
3892 (void)fclose(config_file);
3895 /* End of readconf.c */