1 /* $Cambridge: exim/src/src/readconf.c,v 1.35.2.1 2009/05/20 14:30:14 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 },
145 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
146 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
147 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
148 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
149 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
150 #ifdef WITH_CONTENT_SCAN
151 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
153 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
154 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
155 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
156 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
158 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
160 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
161 { "admin_groups", opt_gidlist, &admin_groups },
162 { "allow_domain_literals", opt_bool, &allow_domain_literals },
163 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
164 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
165 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
166 { "auto_thaw", opt_time, &auto_thaw },
167 #ifdef WITH_CONTENT_SCAN
168 { "av_scanner", opt_stringptr, &av_scanner },
170 { "bi_command", opt_stringptr, &bi_command },
171 #ifdef EXPERIMENTAL_BRIGHTMAIL
172 { "bmi_config_file", opt_stringptr, &bmi_config_file },
174 { "bounce_message_file", opt_stringptr, &bounce_message_file },
175 { "bounce_message_text", opt_stringptr, &bounce_message_text },
176 { "bounce_return_body", opt_bool, &bounce_return_body },
177 { "bounce_return_message", opt_bool, &bounce_return_message },
178 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
179 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
180 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
181 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
182 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
183 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
184 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
185 { "check_log_inodes", opt_int, &check_log_inodes },
186 { "check_log_space", opt_Kint, &check_log_space },
187 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
188 { "check_spool_inodes", opt_int, &check_spool_inodes },
189 { "check_spool_space", opt_Kint, &check_spool_space },
190 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
191 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
192 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
193 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
194 #ifdef EXPERIMENTAL_DCC
195 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
196 { "dccifd_address", opt_stringptr, &dccifd_address },
197 { "dccifd_options", opt_stringptr, &dccifd_options },
199 { "delay_warning", opt_timelist, &delay_warning },
200 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
201 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
202 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
203 { "delivery_date_remove", opt_bool, &delivery_date_remove },
204 #ifdef ENABLE_DISABLE_FSYNC
205 { "disable_fsync", opt_bool, &disable_fsync },
207 { "disable_ipv6", opt_bool, &disable_ipv6 },
209 { "dkim_verify_domains", opt_stringptr, &dkim_verify_domains },
211 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
212 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
213 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
214 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
215 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
216 { "dns_retrans", opt_time, &dns_retrans },
217 { "dns_retry", opt_int, &dns_retry },
218 /* This option is now a no-op, retained for compability */
219 { "drop_cr", opt_bool, &drop_cr },
220 /*********************************************************/
221 { "dsn_from", opt_stringptr, &dsn_from },
222 { "envelope_to_remove", opt_bool, &envelope_to_remove },
223 { "errors_copy", opt_stringptr, &errors_copy },
224 { "errors_reply_to", opt_stringptr, &errors_reply_to },
225 { "exim_group", opt_gid, &exim_gid },
226 { "exim_path", opt_stringptr, &exim_path },
227 { "exim_user", opt_uid, &exim_uid },
228 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
229 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
230 { "finduser_retries", opt_int, &finduser_retries },
231 { "freeze_tell", opt_stringptr, &freeze_tell },
232 { "gecos_name", opt_stringptr, &gecos_name },
233 { "gecos_pattern", opt_stringptr, &gecos_pattern },
235 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
236 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
237 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
239 { "header_line_maxsize", opt_int, &header_line_maxsize },
240 { "header_maxsize", opt_int, &header_maxsize },
241 { "headers_charset", opt_stringptr, &headers_charset },
242 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
243 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
244 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
245 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
246 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
247 { "hold_domains", opt_stringptr, &hold_domains },
248 { "host_lookup", opt_stringptr, &host_lookup },
249 { "host_lookup_order", opt_stringptr, &host_lookup_order },
250 { "host_reject_connection", opt_stringptr, &host_reject_connection },
251 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
252 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
254 { "ibase_servers", opt_stringptr, &ibase_servers },
256 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
257 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
258 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
259 { "keep_malformed", opt_time, &keep_malformed },
261 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
262 { "ldap_version", opt_int, &eldap_version },
264 { "local_from_check", opt_bool, &local_from_check },
265 { "local_from_prefix", opt_stringptr, &local_from_prefix },
266 { "local_from_suffix", opt_stringptr, &local_from_suffix },
267 { "local_interfaces", opt_stringptr, &local_interfaces },
268 { "local_scan_timeout", opt_time, &local_scan_timeout },
269 { "local_sender_retain", opt_bool, &local_sender_retain },
270 { "localhost_number", opt_stringptr, &host_number_string },
271 { "log_file_path", opt_stringptr, &log_file_path },
272 { "log_selector", opt_stringptr, &log_selector_string },
273 { "log_timezone", opt_bool, &log_timezone },
274 { "lookup_open_max", opt_int, &lookup_open_max },
275 { "max_username_length", opt_int, &max_username_length },
276 { "message_body_newlines", opt_bool, &message_body_newlines },
277 { "message_body_visible", opt_mkint, &message_body_visible },
278 { "message_id_header_domain", opt_stringptr, &message_id_domain },
279 { "message_id_header_text", opt_stringptr, &message_id_text },
280 { "message_logs", opt_bool, &message_logs },
281 { "message_size_limit", opt_stringptr, &message_size_limit },
282 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
283 { "move_frozen_messages", opt_bool, &move_frozen_messages },
285 { "mua_wrapper", opt_bool, &mua_wrapper },
287 { "mysql_servers", opt_stringptr, &mysql_servers },
289 { "never_users", opt_uidlist, &never_users },
291 { "oracle_servers", opt_stringptr, &oracle_servers },
293 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
295 { "perl_at_start", opt_bool, &opt_perl_at_start },
296 { "perl_startup", opt_stringptr, &opt_perl_startup },
299 { "pgsql_servers", opt_stringptr, &pgsql_servers },
301 { "pid_file_path", opt_stringptr, &pid_file_path },
302 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
303 { "preserve_message_logs", opt_bool, &preserve_message_logs },
304 { "primary_hostname", opt_stringptr, &primary_hostname },
305 { "print_topbitchars", opt_bool, &print_topbitchars },
306 { "process_log_path", opt_stringptr, &process_log_path },
307 { "prod_requires_admin", opt_bool, &prod_requires_admin },
308 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
309 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
310 { "queue_domains", opt_stringptr, &queue_domains },
311 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
312 { "queue_only", opt_bool, &queue_only },
313 { "queue_only_file", opt_stringptr, &queue_only_file },
314 { "queue_only_load", opt_fixed, &queue_only_load },
315 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
316 { "queue_only_override", opt_bool, &queue_only_override },
317 { "queue_run_in_order", opt_bool, &queue_run_in_order },
318 { "queue_run_max", opt_int, &queue_run_max },
319 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
320 { "receive_timeout", opt_time, &receive_timeout },
321 { "received_header_text", opt_stringptr, &received_header_text },
322 { "received_headers_max", opt_int, &received_headers_max },
323 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
324 { "recipients_max", opt_int, &recipients_max },
325 { "recipients_max_reject", opt_bool, &recipients_max_reject },
326 { "remote_max_parallel", opt_int, &remote_max_parallel },
327 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
328 { "retry_data_expire", opt_time, &retry_data_expire },
329 { "retry_interval_max", opt_time, &retry_interval_max },
330 { "return_path_remove", opt_bool, &return_path_remove },
331 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
332 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
333 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
334 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
335 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
336 { "smtp_accept_max", opt_int, &smtp_accept_max },
337 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
338 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
339 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
340 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
341 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
342 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
343 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
344 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
345 { "smtp_banner", opt_stringptr, &smtp_banner },
346 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
347 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
348 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
349 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
350 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
351 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
352 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
353 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
354 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
355 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
356 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
357 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
358 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
359 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
360 #ifdef WITH_CONTENT_SCAN
361 { "spamd_address", opt_stringptr, &spamd_address },
363 #ifdef EXPERIMENTAL_SPF
364 { "spf_guess", opt_stringptr, &spf_guess },
366 { "split_spool_directory", opt_bool, &split_spool_directory },
367 { "spool_directory", opt_stringptr, &spool_directory },
369 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
371 #ifdef EXPERIMENTAL_SRS
372 { "srs_config", opt_stringptr, &srs_config },
373 { "srs_hashlength", opt_int, &srs_hashlength },
374 { "srs_hashmin", opt_int, &srs_hashmin },
375 { "srs_maxage", opt_int, &srs_maxage },
376 { "srs_secrets", opt_stringptr, &srs_secrets },
377 { "srs_usehash", opt_bool, &srs_usehash },
378 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
380 { "strict_acl_vars", opt_bool, &strict_acl_vars },
381 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
382 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
383 { "syslog_duplication", opt_bool, &syslog_duplication },
384 { "syslog_facility", opt_stringptr, &syslog_facility_str },
385 { "syslog_processname", opt_stringptr, &syslog_processname },
386 { "syslog_timestamp", opt_bool, &syslog_timestamp },
387 { "system_filter", opt_stringptr, &system_filter },
388 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
389 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
390 { "system_filter_group", opt_gid, &system_filter_gid },
391 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
392 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
393 { "system_filter_user", opt_uid, &system_filter_uid },
394 { "tcp_nodelay", opt_bool, &tcp_nodelay },
395 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
396 { "timezone", opt_stringptr, &timezone_string },
398 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
399 { "tls_certificate", opt_stringptr, &tls_certificate },
400 { "tls_crl", opt_stringptr, &tls_crl },
401 { "tls_dhparam", opt_stringptr, &tls_dhparam },
402 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
403 { "tls_privatekey", opt_stringptr, &tls_privatekey },
404 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
405 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
406 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
407 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
408 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
410 { "trusted_groups", opt_gidlist, &trusted_groups },
411 { "trusted_users", opt_uidlist, &trusted_users },
412 { "unknown_login", opt_stringptr, &unknown_login },
413 { "unknown_username", opt_stringptr, &unknown_username },
414 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
415 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
416 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
417 { "warn_message_file", opt_stringptr, &warn_message_file },
418 { "write_rejectlog", opt_bool, &write_rejectlog }
421 static int optionlist_config_size =
422 sizeof(optionlist_config)/sizeof(optionlist);
426 /*************************************************
427 * Find the name of an option *
428 *************************************************/
430 /* This function is to aid debugging. Various functions take arguments that are
431 pointer variables in the options table or in option tables for various drivers.
432 For debugging output, it is useful to be able to find the name of the option
433 which is currently being processed. This function finds it, if it exists, by
434 searching the table(s).
436 Arguments: a value that is presumed to be in the table above
437 Returns: the option name, or an empty string
441 readconf_find_option(void *p)
445 transport_instance *t;
447 for (i = 0; i < optionlist_config_size; i++)
448 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
450 for (r = routers; r != NULL; r = r->next)
452 router_info *ri = r->info;
453 for (i = 0; i < ri->options_count[0]; i++)
455 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
456 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
457 return US ri->options[i].name;
461 for (t = transports; t != NULL; t = t->next)
463 transport_info *ti = t->info;
464 for (i = 0; i < ti->options_count[0]; i++)
466 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
467 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
468 return US ti->options[i].name;
478 /*************************************************
479 * Deal with an assignment to a macro *
480 *************************************************/
482 /* This function is called when a line that starts with an upper case letter is
483 encountered. The argument "line" should contain a complete logical line, and
484 start with the first letter of the macro name. The macro name and the
485 replacement text are extracted and stored. Redefinition of existing,
486 non-command line, macros is permitted using '==' instead of '='.
489 s points to the start of the logical line
495 read_macro_assignment(uschar *s)
501 macro_item *mlast = NULL;
503 while (isalnum(*s) || *s == '_')
505 if (namelen >= sizeof(name) - 1)
506 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
507 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
508 name[namelen++] = *s++;
512 while (isspace(*s)) s++;
514 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
521 while (isspace(*s)) s++;
523 /* If an existing macro of the same name was defined on the command line, we
524 just skip this definition. It's an error to attempt to redefine a macro without
525 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
526 It is also an error to define a macro whose name begins with the name of a
527 previously defined macro. Note: it is documented that the other way round
530 for (m = macros; m != NULL; m = m->next)
532 int len = Ustrlen(m->name);
534 if (Ustrcmp(m->name, name) == 0)
536 if (!m->command_line && !redef)
537 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
538 "defined (use \"==\" if you want to redefine it", name);
542 if (len < namelen && Ustrstr(name, m->name) != NULL)
543 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
544 "a macro because previously defined macro \"%s\" is a substring",
547 /* We cannot have this test, because it is documented that a substring
548 macro is permitted (there is even an example).
550 * if (len > namelen && Ustrstr(m->name, name) != NULL)
551 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
552 * "a macro because it is a substring of previously defined macro \"%s\"",
559 /* Check for an overriding command-line definition. */
561 if (m != NULL && m->command_line) return;
563 /* Redefinition must refer to an existing macro. */
568 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
572 /* We have a new definition. The macro_item structure includes a final vector
573 called "name" which is one byte long. Thus, adding "namelen" gives us enough
574 room to store the "name" string. */
578 m = store_get(sizeof(macro_item) + namelen);
579 if (macros == NULL) macros = m; else mlast->next = m;
580 Ustrncpy(m->name, name, namelen);
581 m->name[namelen] = 0;
583 m->command_line = FALSE;
586 /* Set the value of the new or redefined macro */
588 m->replacement = string_copy(s);
595 /*************************************************
596 * Read configuration line *
597 *************************************************/
599 /* A logical line of text is read from the configuration file into the big
600 buffer, taking account of macros, .includes, and continuations. The size of
601 big_buffer is increased if necessary. The count of configuration lines is
602 maintained. Physical input lines starting with # (ignoring leading white space,
603 and after macro replacement) and empty logical lines are always ignored.
604 Leading and trailing spaces are removed.
606 If we hit a line of the form "begin xxxx", the xxxx is placed in the
607 next_section vector, and the function returns NULL, indicating the end of a
608 configuration section. On end-of-file, NULL is returned with next_section
613 Returns: a pointer to the first non-blank in the line,
614 or NULL if eof or end of section is reached
618 get_config_line(void)
620 int startoffset = 0; /* To first non-blank char in logical line */
621 int len = 0; /* Of logical line so far */
627 /* Loop for handling continuation lines, skipping comments, and dealing with
632 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
634 if (config_file_stack != NULL) /* EOF inside .include */
636 (void)fclose(config_file);
637 config_file = config_file_stack->file;
638 config_filename = config_file_stack->filename;
639 config_lineno = config_file_stack->lineno;
640 config_file_stack = config_file_stack->next;
644 /* EOF at top level */
646 if (cstate_stack_ptr >= 0)
647 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
648 "Unexpected end of configuration file: .endif missing");
650 if (len != 0) break; /* EOF after continuation */
651 next_section[0] = 0; /* EOF at start of logical line */
656 newlen = len + Ustrlen(big_buffer + len);
658 /* Handle pathologically long physical lines - yes, it did happen - by
659 extending big_buffer at this point. The code also copes with very long
662 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
665 big_buffer_size += BIG_BUFFER_SIZE;
666 newbuffer = store_malloc(big_buffer_size);
668 /* This use of strcpy is OK because we know that the string in the old
669 buffer is shorter than the new buffer. */
671 Ustrcpy(newbuffer, big_buffer);
672 store_free(big_buffer);
673 big_buffer = newbuffer;
674 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
676 newlen += Ustrlen(big_buffer + newlen);
679 /* Find the true start of the physical line - leading spaces are always
682 ss = big_buffer + len;
683 while (isspace(*ss)) ss++;
685 /* Process the physical line for macros. If this is the start of the logical
686 line, skip over initial text at the start of the line if it starts with an
687 upper case character followed by a sequence of name characters and an equals
688 sign, because that is the definition of a new macro, and we don't do
689 replacement therein. */
692 if (len == 0 && isupper(*s))
694 while (isalnum(*s) || *s == '_') s++;
695 while (isspace(*s)) s++;
696 if (*s != '=') s = ss; /* Not a macro definition */
699 /* For each defined macro, scan the line (from after XXX= if present),
700 replacing all occurrences of the macro. */
703 for (m = macros; m != NULL; m = m->next)
708 while ((p = Ustrstr(t, m->name)) != NULL)
711 int namelen = Ustrlen(m->name);
712 int replen = Ustrlen(m->replacement);
714 /* Expand the buffer if necessary */
716 while (newlen - namelen + replen + 1 > big_buffer_size)
718 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
719 uschar *newbuffer = store_malloc(newsize);
720 memcpy(newbuffer, big_buffer, newlen + 1);
721 p = newbuffer + (p - big_buffer);
722 s = newbuffer + (s - big_buffer);
723 ss = newbuffer + (ss - big_buffer);
724 t = newbuffer + (t - big_buffer);
725 big_buffer_size = newsize;
726 store_free(big_buffer);
727 big_buffer = newbuffer;
730 /* Shuffle the remaining characters up or down in the buffer before
731 copying in the replacement text. Don't rescan the replacement for this
735 moveby = replen - namelen;
738 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
741 Ustrncpy(p, m->replacement, replen);
747 /* An empty macro replacement at the start of a line could mean that ss no
748 longer points to the first non-blank character. */
750 while (isspace(*ss)) ss++;
752 /* Check for comment lines - these are physical lines. */
754 if (*ss == '#') continue;
756 /* Handle conditionals, which are also applied to physical lines. Conditions
757 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
758 expansion occured on the rest of the line. A preliminary test for the leading
759 '.' saves effort on most lines. */
765 /* Search the list of conditional directives */
767 for (i = 0; i < cond_list_size; i++)
770 cond_item *c = cond_list+i;
771 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
773 /* The following character must be white space or end of string */
775 n = ss[1 + c->namelen];
776 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
778 /* .ifdef and .ifndef push the current state onto the stack, then set
779 a new one from the table. Stack overflow is an error */
783 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
784 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
785 ".%s nested too deeply", c->name);
786 cstate_stack[++cstate_stack_ptr] = cstate;
787 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
790 /* For any of the others, stack underflow is an error. The next state
791 comes either from the stack (.endif) or from the table. */
795 if (cstate_stack_ptr < 0)
796 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
797 ".%s without matching .ifdef", c->name);
798 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
799 next_cstate[cstate][macro_found? c->action1 : c->action2];
802 /* Having dealt with a directive, break the loop */
807 /* If we have handled a conditional directive, continue with the next
808 physical line. Otherwise, fall through. */
810 if (i < cond_list_size) continue;
813 /* If the conditional state is not 0 (actively using these lines), ignore
816 if (cstate != 0) continue; /* Conditional skip */
818 /* Handle .include lines - these are also physical lines. */
820 if (Ustrncmp(ss, ".include", 8) == 0 &&
822 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
825 int include_if_exists = isspace(ss[8])? 0 : 10;
826 config_file_item *save;
829 ss += 9 + include_if_exists;
830 while (isspace(*ss)) ss++;
831 t = ss + Ustrlen(ss);
832 while (t > ss && isspace(t[-1])) t--;
833 if (*ss == '\"' && t[-1] == '\"')
841 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
842 "absolute path \"%s\"", ss);
844 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
846 save = store_get(sizeof(config_file_item));
847 save->next = config_file_stack;
848 config_file_stack = save;
849 save->file = config_file;
850 save->filename = config_filename;
851 save->lineno = config_lineno;
853 config_file = Ufopen(ss, "rb");
854 if (config_file == NULL)
855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
856 "configuration file %s", ss);
857 config_filename = string_copy(ss);
862 /* If this is the start of the logical line, remember where the non-blank
863 data starts. Otherwise shuffle down continuation lines to remove leading
867 startoffset = ss - big_buffer;
870 s = big_buffer + len;
873 memmove(s, ss, (newlen - len) - (ss - s) + 1);
878 /* Accept the new addition to the line. Remove trailing white space. */
881 while (len > 0 && isspace(big_buffer[len-1])) len--;
884 /* We are done if the line does not end in backslash and contains some data.
885 Empty logical lines are ignored. For continuations, remove the backslash and
886 go round the loop to read the continuation line. */
890 if (big_buffer[len-1] != '\\') break; /* End of logical line */
891 big_buffer[--len] = 0; /* Remove backslash */
893 } /* Loop for reading multiple physical lines */
895 /* We now have a logical line. Test for the end of a configuration section (or,
896 more accurately, for the start of the next section). Place the name of the next
897 section in next_section, and return NULL. If the name given is longer than
898 next_section, truncate it. It will be unrecognized later, because all the known
899 section names do fit. Leave space for pluralizing. */
901 s = big_buffer + startoffset; /* First non-space character */
902 if (strncmpic(s, US"begin ", 6) == 0)
905 while (isspace(*s)) s++;
906 if (big_buffer + len - s > sizeof(next_section) - 2)
907 s[sizeof(next_section) - 2] = 0;
908 Ustrcpy(next_section, s);
912 /* Return the first non-blank character. */
919 /*************************************************
921 *************************************************/
923 /* The yield is the pointer to the next uschar. Names longer than the
924 output space are silently truncated. This function is also used from acl.c when
928 name where to put the name
932 Returns: new input pointer
936 readconf_readname(uschar *name, int len, uschar *s)
939 while (isspace(*s)) s++;
942 while (isalnum(*s) || *s == '_')
944 if (p < len-1) name[p++] = *s;
949 while (isspace(*s)) s++;
956 /*************************************************
957 * Read a time value *
958 *************************************************/
960 /* This function is also called from outside, to read argument
961 time values. The format of a time value is:
963 [<n>w][<n>d][<n>h][<n>m][<n>s]
965 as long as at least one is present. If a format error is encountered,
966 return a negative value. The value must be terminated by the given
971 terminator required terminating character
972 return_msec if TRUE, allow fractional seconds and return milliseconds
974 Returns: the time value, or -1 on syntax error
975 value is seconds if return_msec is FALSE
976 value is milliseconds if return_msec is TRUE
980 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
988 if (!isdigit(*s)) return -1;
989 (void)sscanf(CS s, "%d%n", &value, &count);
994 case 'w': value *= 7;
995 case 'd': value *= 24;
996 case 'h': value *= 60;
997 case 'm': value *= 60;
1002 if (!return_msec) return -1;
1003 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1005 if (*s++ != 's') return -1;
1006 yield += (int)(fraction * 1000.0);
1012 if (return_msec) value *= 1000;
1014 if (*s == terminator) return yield;
1016 /* Control never reaches here. */
1021 /*************************************************
1022 * Read a fixed point value *
1023 *************************************************/
1025 /* The value is returned *1000
1029 terminator required terminator
1031 Returns: the value, or -1 on error
1035 readconf_readfixed(uschar *s, int terminator)
1039 if (!isdigit(*s)) return -1;
1040 (void)sscanf(CS s, "%d%n", &value, &count);
1042 yield = value * 1000;
1046 while (isdigit((*(++s))))
1048 yield += (*s - '0') * m;
1053 return (*s == terminator)? yield : (-1);
1058 /*************************************************
1059 * Find option in list *
1060 *************************************************/
1062 /* The lists are always in order, so binary chop can be used.
1065 name the option name to search for
1066 ol the first entry in the option list
1067 last one more than the offset of the last entry in the option list
1069 Returns: pointer to an option entry, or NULL if not found
1073 find_option(uschar *name, optionlist *ol, int last)
1076 while (last > first)
1078 int middle = (first + last)/2;
1079 int c = Ustrcmp(name, ol[middle].name);
1080 if (c == 0) return ol + middle;
1081 else if (c > 0) first = middle + 1;
1089 /*************************************************
1090 * Find a set flag in option list *
1091 *************************************************/
1093 /* Because some versions of Unix make no restrictions on the values of uids and
1094 gids (even negative ones), we cannot represent "unset" by a special value.
1095 There is therefore a separate boolean variable for each one indicating whether
1096 a value is set or not. This function returns a pointer to the boolean, given
1097 the original option name. It is a major disaster if the flag cannot be found.
1100 name the name of the uid or gid option
1101 oltop points to the start of the relevant option list
1102 last one more than the offset of the last item in the option list
1103 data_block NULL when reading main options => data values in the option
1104 list are absolute addresses; otherwise they are byte offsets
1105 in data_block (used for driver options)
1107 Returns: a pointer to the boolean flag.
1111 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1115 sprintf(CS name2, "*set_%.50s", name);
1116 ol = find_option(name2, oltop, last);
1117 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1118 "Exim internal error: missing set flag for %s", name);
1119 return (data_block == NULL)? (BOOL *)(ol->value) :
1120 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1126 /*************************************************
1127 * Output extra characters message and die *
1128 *************************************************/
1130 /* Called when an option line has junk on the end. Sometimes this is because
1131 the sysadmin thinks comments are permitted.
1134 s points to the extra characters
1135 t1..t3 strings to insert in the log message
1137 Returns: doesn't return; dies
1141 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1143 uschar *comment = US"";
1144 if (*s == '#') comment = US" (# is comment only at line start)";
1145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1146 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1151 /*************************************************
1152 * Read rewrite information *
1153 *************************************************/
1155 /* Each line of rewrite information contains:
1157 . A complete address in the form user@domain, possibly with
1158 leading * for each part; or alternatively, a regex.
1160 . A replacement string (which will be expanded).
1162 . An optional sequence of one-letter flags, indicating which
1163 headers etc. to apply this rule to.
1165 All this is decoded and placed into a control block. The OR of the flags is
1166 maintained in a common word.
1169 p points to the string that makes up the rule
1170 existflags points to the overall flag word
1171 isglobal TRUE if reading global rewrite rules
1173 Returns: the control block for the parsed rule.
1176 static rewrite_rule *
1177 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1179 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1182 next->key = string_dequote(&p);
1184 while (isspace(*p)) p++;
1186 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1187 "missing rewrite replacement string");
1190 next->replacement = string_dequote(&p);
1192 while (*p != 0) switch (*p++)
1194 case ' ': case '\t': break;
1196 case 'q': next->flags |= rewrite_quit; break;
1197 case 'w': next->flags |= rewrite_whole; break;
1199 case 'h': next->flags |= rewrite_all_headers; break;
1200 case 's': next->flags |= rewrite_sender; break;
1201 case 'f': next->flags |= rewrite_from; break;
1202 case 't': next->flags |= rewrite_to; break;
1203 case 'c': next->flags |= rewrite_cc; break;
1204 case 'b': next->flags |= rewrite_bcc; break;
1205 case 'r': next->flags |= rewrite_replyto; break;
1207 case 'E': next->flags |= rewrite_all_envelope; break;
1208 case 'F': next->flags |= rewrite_envfrom; break;
1209 case 'T': next->flags |= rewrite_envto; break;
1211 case 'Q': next->flags |= rewrite_qualify; break;
1212 case 'R': next->flags |= rewrite_repeat; break;
1215 next->flags |= rewrite_smtp;
1216 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1217 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1218 "rewrite rule has the S flag but is not a regular expression");
1222 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1223 "unknown rewrite flag character '%c' "
1224 "(could be missing quotes round replacement item)", p[-1]);
1228 /* If no action flags are set, set all the "normal" rewrites. */
1230 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1231 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1233 /* Remember which exist, for optimization, and return the rule */
1235 *existflags |= next->flags;
1242 /*************************************************
1243 * Read global rewrite information *
1244 *************************************************/
1246 /* Each line is a single rewrite rule; it is parsed into a control block
1247 by readconf_one_rewrite(), and its flags are ORed into the global flag
1248 word rewrite_existflags. */
1251 readconf_rewrites(void)
1253 rewrite_rule **chain = &global_rewrite_rules;
1256 while ((p = get_config_line()) != NULL)
1258 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1260 chain = &(next->next);
1266 /*************************************************
1268 *************************************************/
1270 /* Strings are read into the normal store pool. As long we aren't too
1271 near the end of the current block, the string will just use what is necessary
1272 on the top of the stacking pool, because string_cat() uses the extension
1276 s the rest of the input line
1277 name the option name (for errors)
1279 Returns: pointer to the string
1283 read_string(uschar *s, uschar *name)
1288 if (*s != '\"') return string_copy(s);
1291 yield = string_dequote(&s);
1293 if (s == ss+1 || s[-1] != '\"')
1294 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1295 "missing quote at end of string value for %s", name);
1297 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1303 /*************************************************
1304 * Handle option line *
1305 *************************************************/
1307 /* This function is called from several places to process a line containing the
1308 setting of an option. The first argument is the line to be decoded; it has been
1309 checked not to be empty and not to start with '#'. Trailing newlines and white
1310 space have been removed. The second argument is a pointer to the list of
1311 variable names that are to be recognized, together with their types and
1312 locations, and the third argument gives the number of entries in the list.
1314 The fourth argument is a pointer to a data block. If it is NULL, then the data
1315 values in the options list are absolute addresses. Otherwise, they are byte
1316 offsets in the data block.
1318 String option data may continue onto several lines; this function reads further
1319 data from config_file if necessary.
1321 The yield of this function is normally zero. If a string continues onto
1322 multiple lines, then the data value is permitted to be followed by a comma
1323 or a semicolon (for use in drivers) and the yield is that character.
1326 buffer contains the configuration line to be handled
1327 oltop points to the start of the relevant option list
1328 last one more than the offset of the last item in the option list
1329 data_block NULL when reading main options => data values in the option
1330 list are absolute addresses; otherwise they are byte offsets
1331 in data_block when they have opt_public set; otherwise
1332 they are byte offsets in data_block->options_block.
1333 unknown_txt format string to use in panic message for unknown option;
1334 must contain %s for option name
1335 if given as NULL, don't panic on unknown option
1337 Returns: TRUE if an option was read successfully,
1338 FALSE false for an unknown option if unknown_txt == NULL,
1339 otherwise panic and die on an unknown option
1343 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1344 void *data_block, uschar *unknown_txt)
1348 int n, count, type, value;
1352 BOOL boolvalue = TRUE;
1353 BOOL freesptr = TRUE;
1354 optionlist *ol, *ol2;
1358 uschar *inttype = US"";
1364 /* There may be leading spaces; thereafter, we expect an option name starting
1367 while (isspace(*s)) s++;
1369 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1371 /* Read the name of the option, and skip any subsequent white space. If
1372 it turns out that what we read was "hide", set the flag indicating that
1373 this is a secure option, and loop to read the next word. */
1375 for (n = 0; n < 2; n++)
1377 while (isalnum(*s) || *s == '_')
1379 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1383 while (isspace(*s)) s++;
1384 if (Ustrcmp(name, "hide") != 0) break;
1385 issecure = opt_secure;
1389 /* Deal with "no_" or "not_" here for booleans */
1391 if (Ustrncmp(name, "no_", 3) == 0)
1397 if (Ustrncmp(name, "not_", 4) == 0)
1403 /* Search the list for the given name. A non-existent name, or an option that
1404 is set twice, is a disaster. */
1406 ol = find_option(name + offset, oltop, last);
1410 if (unknown_txt == NULL) return FALSE;
1411 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1414 if ((ol->type & opt_set) != 0)
1416 uschar *mname = name;
1417 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1418 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1419 "\"%s\" option set for the second time", mname);
1422 ol->type |= opt_set | issecure;
1423 type = ol->type & opt_mask;
1425 /* Types with data values must be followed by '='; the "no[t]_" prefix
1426 applies only to boolean values. */
1428 if (type < opt_bool || type > opt_bool_last)
1431 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1432 "negation prefix applied to a non-boolean option");
1434 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1435 "unexpected end of line (data missing) after %s", name);
1437 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1440 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1441 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1442 ultimately expands to one of those values. */
1444 else if (*s != 0 && (offset != 0 || *s != '='))
1445 extra_chars_error(s, US"boolean option ", name, US"");
1447 /* Skip white space after = */
1449 if (*s == '=') while (isspace((*(++s))));
1451 /* If there is a data block and the opt_public flag is not set, change
1452 the data block pointer to the private options block. */
1454 if (data_block != NULL && (ol->type & opt_public) == 0)
1455 data_block = (void *)(((driver_instance *)data_block)->options_block);
1457 /* Now get the data according to the type. */
1461 /* If a string value is not enclosed in quotes, it consists of
1462 the rest of the current line, verbatim. Otherwise, string escapes
1465 A transport is specified as a string, which is then looked up in the
1466 list of transports. A search type is specified as one of a number of
1469 A set or rewrite rules for a driver is specified as a string, which is
1470 then parsed into a suitable chain of control blocks.
1472 Uids and gids are specified as strings which are then looked up in the
1473 passwd file. Lists of uids and gids are similarly specified as colon-
1474 separated strings. */
1479 case opt_expand_uid:
1480 case opt_expand_gid:
1485 reset_point = sptr = read_string(s, name);
1487 /* Having read a string, we now have several different ways of using it,
1488 depending on the data type, so do another switch. If keeping the actual
1489 string is not required (because it is interpreted), freesptr is set TRUE,
1490 and at the end we reset the pool. */
1494 /* If this was a string, set the variable to point to the new string,
1495 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1496 rules, we still keep the string (for printing), and parse the rules into a
1497 control block and flags word. */
1501 if (data_block == NULL)
1502 *((uschar **)(ol->value)) = sptr;
1504 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1506 if (type == opt_rewrite)
1511 rewrite_rule **chain;
1514 sprintf(CS name2, "*%.50s_rules", name);
1515 ol2 = find_option(name2, oltop, last);
1516 sprintf(CS name2, "*%.50s_flags", name);
1517 ol3 = find_option(name2, oltop, last);
1519 if (ol2 == NULL || ol3 == NULL)
1520 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1521 "rewrite rules not available for driver");
1523 if (data_block == NULL)
1525 chain = (rewrite_rule **)(ol2->value);
1526 flagptr = (int *)(ol3->value);
1530 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1531 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1534 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1537 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1539 chain = &(next->next);
1542 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1543 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1544 "non-header rewrite - not allowed at transport time -");
1548 /* If it was an expanded uid, see if there is any expansion to be
1549 done by checking for the presence of a $ character. If there is, save it
1550 in the corresponding *expand_user option field. Otherwise, fall through
1551 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1554 case opt_expand_uid:
1555 sprintf(CS name2, "*expand_%.50s", name);
1556 ol2 = find_option(name2, oltop, last);
1559 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1561 if (data_block == NULL)
1562 *((uschar **)(ol2->value)) = ss;
1564 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1568 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1574 /* Look up a fixed uid, and also make use of the corresponding gid
1575 if a passwd entry is returned and the gid has not been set. */
1578 if (!route_finduser(sptr, &pw, &uid))
1579 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1580 if (data_block == NULL)
1581 *((uid_t *)(ol->value)) = uid;
1583 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1585 /* Set the flag indicating a fixed value is set */
1587 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1589 /* Handle matching gid if we have a passwd entry: done by finding the
1590 same name with terminating "user" changed to "group"; if not found,
1591 ignore. Also ignore if the value is already set. */
1593 if (pw == NULL) break;
1594 Ustrcpy(name+Ustrlen(name)-4, "group");
1595 ol2 = find_option(name, oltop, last);
1596 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1597 (ol2->type & opt_mask) == opt_expand_gid))
1599 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1602 if (data_block == NULL)
1603 *((gid_t *)(ol2->value)) = pw->pw_gid;
1605 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1611 /* If it was an expanded gid, see if there is any expansion to be
1612 done by checking for the presence of a $ character. If there is, save it
1613 in the corresponding *expand_user option field. Otherwise, fall through
1614 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1617 case opt_expand_gid:
1618 sprintf(CS name2, "*expand_%.50s", name);
1619 ol2 = find_option(name2, oltop, last);
1622 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1624 if (data_block == NULL)
1625 *((uschar **)(ol2->value)) = ss;
1627 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1631 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1637 /* Handle freestanding gid */
1640 if (!route_findgroup(sptr, &gid))
1641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1642 if (data_block == NULL)
1643 *((gid_t *)(ol->value)) = gid;
1645 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1646 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1649 /* If it was a uid list, look up each individual entry, and build
1650 a vector of uids, with a count in the first element. Put the vector
1651 in malloc store so we can free the string. (We are reading into
1652 permanent store already.) */
1660 uschar *op = expand_string (sptr);
1663 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1664 name, expand_string_message);
1667 if (*p != 0) count++;
1668 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1669 list = store_malloc(count*sizeof(uid_t));
1670 list[ptr++] = (uid_t)(count - 1);
1672 if (data_block == NULL)
1673 *((uid_t **)(ol->value)) = list;
1675 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1681 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1682 if (!route_finduser(big_buffer, NULL, &uid))
1683 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1690 /* If it was a gid list, look up each individual entry, and build
1691 a vector of gids, with a count in the first element. Put the vector
1692 in malloc store so we can free the string. (We are reading into permanent
1701 uschar *op = expand_string (sptr);
1704 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1705 name, expand_string_message);
1708 if (*p != 0) count++;
1709 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1710 list = store_malloc(count*sizeof(gid_t));
1711 list[ptr++] = (gid_t)(count - 1);
1713 if (data_block == NULL)
1714 *((gid_t **)(ol->value)) = list;
1716 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1722 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1723 if (!route_findgroup(big_buffer, &gid))
1724 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1732 /* Release store if the value of the string doesn't need to be kept. */
1734 if (freesptr) store_reset(reset_point);
1737 /* Expanded boolean: if no characters follow, or if there are no dollar
1738 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1739 save the string for later expansion in the alternate place. */
1741 case opt_expand_bool:
1742 if (*s != 0 && Ustrchr(s, '$') != 0)
1744 sprintf(CS name2, "*expand_%.50s", name);
1745 ol2 = find_option(name2, oltop, last);
1748 reset_point = sptr = read_string(s, name);
1749 if (data_block == NULL)
1750 *((uschar **)(ol2->value)) = sptr;
1752 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1759 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1760 look for yes/not/true/false. Some booleans are stored in a single bit in
1761 a single int. There's a special fudge for verify settings; without a suffix
1762 they set both xx_sender and xx_recipient. The table points to the sender
1763 value; search subsequently for the recipient. There's another special case:
1764 opt_bool_set also notes when a boolean has been set. */
1768 case opt_bool_verify:
1772 s = readconf_readname(name2, 64, s);
1773 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1775 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1777 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1778 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1779 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1780 US"for boolean option ", name);
1783 /* Handle single-bit type. */
1785 if (type == opt_bit)
1787 int bit = 1 << ((ol->type >> 16) & 31);
1788 int *ptr = (data_block == NULL)?
1789 (int *)(ol->value) :
1790 (int *)((uschar *)data_block + (long int)ol->value);
1791 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1795 /* Handle full BOOL types */
1797 if (data_block == NULL)
1798 *((BOOL *)(ol->value)) = boolvalue;
1800 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1804 if (type == opt_bool_verify)
1806 sprintf(CS name2, "%.50s_recipient", name + offset);
1807 ol2 = find_option(name2, oltop, last);
1810 if (data_block == NULL)
1811 *((BOOL *)(ol2->value)) = boolvalue;
1813 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1817 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1819 else if (type == opt_bool_set)
1821 sprintf(CS name2, "*set_%.50s", name + offset);
1822 ol2 = find_option(name2, oltop, last);
1825 if (data_block == NULL)
1826 *((BOOL *)(ol2->value)) = TRUE;
1828 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1837 inttype = US"octal ";
1839 /* Integer: a simple(ish) case; allow octal and hex formats, and
1840 suffixes K and M. The different types affect output, not input. */
1849 lvalue = strtol(CS s, CSS &endptr, intbase);
1852 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1855 if (errno != ERANGE)
1857 if (tolower(*endptr) == 'k')
1859 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1860 else lvalue *= 1024;
1863 else if (tolower(*endptr) == 'm')
1865 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1867 else lvalue *= 1024*1024;
1872 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1873 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1874 "absolute value of integer \"%s\" is too large (overflow)", s);
1876 while (isspace(*endptr)) endptr++;
1878 extra_chars_error(endptr, inttype, US"integer value for ", name);
1880 value = (int)lvalue;
1883 if (data_block == NULL)
1884 *((int *)(ol->value)) = value;
1886 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1889 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1896 value = strtol(CS s, CSS &endptr, intbase);
1899 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1902 if (errno != ERANGE)
1904 if (tolower(*endptr) == 'm')
1906 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1910 else if (tolower(*endptr) == 'k')
1916 value = (value + 512)/1024;
1920 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1921 "absolute value of integer \"%s\" is too large (overflow)", s);
1923 while (isspace(*endptr)) endptr++;
1925 extra_chars_error(endptr, inttype, US"integer value for ", name);
1928 if (data_block == NULL)
1929 *((int *)(ol->value)) = value;
1931 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1934 /* Fixed-point number: held to 3 decimal places. */
1937 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1938 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1939 "fixed-point number expected for %s", name);
1941 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1942 "integer \"%s\" is too large (overflow)", s);
1946 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1947 "integer \"%s\" is too large (overflow)", s);
1949 if (s[count] == '.')
1952 while (isdigit(s[++count]))
1954 value += (s[count] - '0') * d;
1959 while (isspace(s[count])) count++;
1962 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1964 if (data_block == NULL)
1965 *((int *)(ol->value)) = value;
1967 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1970 /* There's a special routine to read time values. */
1973 value = readconf_readtime(s, 0, FALSE);
1975 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1977 if (data_block == NULL)
1978 *((int *)(ol->value)) = value;
1980 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1983 /* A time list is a list of colon-separated times, with the first
1984 element holding the size of the list and the second the number of
1990 int *list = (data_block == NULL)?
1991 (int *)(ol->value) :
1992 (int *)((uschar *)data_block + (long int)(ol->value));
1994 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1997 uschar *snext = Ustrchr(s, ':');
2001 while (ss > s && isspace(ss[-1])) ss--;
2004 value = readconf_readtime(s, terminator, FALSE);
2006 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2008 if (count > 1 && value <= list[count])
2009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2010 "time value out of order for %s", name);
2011 list[count+1] = value;
2012 if (snext == NULL) break;
2014 while (isspace(*s)) s++;
2017 if (count > list[0] - 2)
2018 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2020 if (count > 0 && list[2] == 0) count = 0;
2032 /*************************************************
2033 * Print a time value *
2034 *************************************************/
2037 Argument: a time value in seconds
2038 Returns: pointer to a fixed buffer containing the time as a string,
2039 in readconf_readtime() format
2043 readconf_printtime(int t)
2046 uschar *p = time_buffer;
2063 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2064 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2065 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2066 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2067 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2074 /*************************************************
2075 * Print an individual option value *
2076 *************************************************/
2078 /* This is used by the -bP option, so prints to the standard output.
2079 The entire options list is passed in as an argument, because some options come
2080 in pairs - typically uid/gid settings, which can either be explicit numerical
2081 values, or strings to be expanded later. If the numerical value is unset,
2082 search for "*expand_<name>" to see if there is a string equivalent.
2085 ol option entry, or NULL for an unknown option
2087 options_block NULL for main configuration options; otherwise points to
2088 a driver block; if the option doesn't have opt_public
2089 set, then options_block->options_block is where the item
2091 oltop points to the option list in which ol exists
2092 last one more than the offset of the last entry in optop
2098 print_ol(optionlist *ol, uschar *name, void *options_block,
2099 optionlist *oltop, int last)
2112 printf("%s is not a known option\n", name);
2116 /* Non-admin callers cannot see options that have been flagged secure by the
2119 if (!admin_user && (ol->type & opt_secure) != 0)
2121 printf("%s = <value not displayable>\n", name);
2125 /* Else show the value of the option */
2128 if (options_block != NULL)
2130 if ((ol->type & opt_public) == 0)
2131 options_block = (void *)(((driver_instance *)options_block)->options_block);
2132 value = (void *)((uschar *)options_block + (long int)value);
2135 switch(ol->type & opt_mask)
2138 case opt_rewrite: /* Show the text value */
2139 s = *((uschar **)value);
2140 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2144 printf("%s = %d\n", name, *((int *)value));
2149 int x = *((int *)value);
2150 if (x != 0 && (x & 1023) == 0)
2154 if ((x & 1023) == 0)
2159 printf("%s = %d%c\n", name, x, c);
2161 else printf("%s = %d\n", name, x);
2167 int x = *((int *)value);
2168 if (x == 0) printf("%s = 0\n", name);
2169 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2170 else printf("%s = %dK\n", name, x);
2175 printf("%s = %#o\n", name, *((int *)value));
2178 /* Can be negative only when "unset", in which case integer */
2182 int x = *((int *)value);
2185 if (x < 0) printf("%s =\n", name); else
2187 printf("%s = %d.", name, x/1000);
2200 /* If the numerical value is unset, try for the string value */
2202 case opt_expand_uid:
2203 if (! *get_set_flag(name, oltop, last, options_block))
2205 sprintf(CS name2, "*expand_%.50s", name);
2206 ol2 = find_option(name2, oltop, last);
2209 void *value2 = ol2->value;
2210 if (options_block != NULL)
2211 value2 = (void *)((uschar *)options_block + (long int)value2);
2212 s = *((uschar **)value2);
2213 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2218 /* Else fall through */
2221 if (! *get_set_flag(name, oltop, last, options_block))
2222 printf("%s =\n", name);
2225 pw = getpwuid(*((uid_t *)value));
2227 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2228 else printf("%s = %s\n", name, pw->pw_name);
2232 /* If the numerical value is unset, try for the string value */
2234 case opt_expand_gid:
2235 if (! *get_set_flag(name, oltop, last, options_block))
2237 sprintf(CS name2, "*expand_%.50s", name);
2238 ol2 = find_option(name2, oltop, last);
2239 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2241 void *value2 = ol2->value;
2242 if (options_block != NULL)
2243 value2 = (void *)((uschar *)options_block + (long int)value2);
2244 s = *((uschar **)value2);
2245 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2250 /* Else fall through */
2253 if (! *get_set_flag(name, oltop, last, options_block))
2254 printf("%s =\n", name);
2257 gr = getgrgid(*((int *)value));
2259 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2260 else printf("%s = %s\n", name, gr->gr_name);
2265 uidlist = *((uid_t **)value);
2266 printf("%s =", name);
2267 if (uidlist != NULL)
2271 for (i = 1; i <= (int)(uidlist[0]); i++)
2273 uschar *name = NULL;
2274 pw = getpwuid(uidlist[i]);
2275 if (pw != NULL) name = US pw->pw_name;
2276 if (name != NULL) printf("%c%s", sep, name);
2277 else printf("%c%ld", sep, (long int)(uidlist[i]));
2285 gidlist = *((gid_t **)value);
2286 printf("%s =", name);
2287 if (gidlist != NULL)
2291 for (i = 1; i <= (int)(gidlist[0]); i++)
2293 uschar *name = NULL;
2294 gr = getgrgid(gidlist[i]);
2295 if (gr != NULL) name = US gr->gr_name;
2296 if (name != NULL) printf("%c%s", sep, name);
2297 else printf("%c%ld", sep, (long int)(gidlist[i]));
2305 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2311 int *list = (int *)value;
2312 printf("%s = ", name);
2313 for (i = 0; i < list[1]; i++)
2314 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2320 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2324 case opt_expand_bool:
2325 sprintf(CS name2, "*expand_%.50s", name);
2326 ol2 = find_option(name2, oltop, last);
2327 if (ol2 != NULL && ol2->value != NULL)
2329 void *value2 = ol2->value;
2330 if (options_block != NULL)
2331 value2 = (void *)((uschar *)options_block + (long int)value2);
2332 s = *((uschar **)value2);
2335 printf("%s = %s\n", name, string_printing(s));
2338 /* s == NULL => string not set; fall through */
2344 case opt_bool_verify:
2346 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2353 /*************************************************
2354 * Print value from main configuration *
2355 *************************************************/
2357 /* This function, called as a result of encountering the -bP option,
2358 causes the value of any main configuration variable to be output if the
2359 second argument is NULL. There are some special values:
2361 all print all main configuration options
2362 configure_file print the name of the configuration file
2363 routers print the routers' configurations
2364 transports print the transports' configuration
2365 authenticators print the authenticators' configuration
2366 router_list print a list of router names
2367 transport_list print a list of transport names
2368 authenticator_list print a list of authentication mechanism names
2369 +name print a named list item
2370 local_scan print the local_scan options
2372 If the second argument is not NULL, it must be one of "router", "transport", or
2373 "authenticator" in which case the first argument identifies the driver whose
2374 options are to be printed.
2377 name option name if type == NULL; else driver name
2378 type NULL or driver type name, as described above
2384 readconf_print(uschar *name, uschar *type)
2386 BOOL names_only = FALSE;
2388 optionlist *ol2 = NULL;
2389 driver_instance *d = NULL;
2399 static uschar *types[] = { US"address", US"domain", US"host",
2401 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2402 &hostlist_anchor, &localpartlist_anchor };
2404 for (i = 0; i < 4; i++)
2406 t = tree_search(*(anchors[i]), name+1);
2410 printf("%slist %s = %s\n", types[i], name+1,
2411 ((namedlist_block *)(t->data.ptr))->string);
2416 printf("no address, domain, host, or local part list called \"%s\" "
2417 "exists\n", name+1);
2422 if (Ustrcmp(name, "configure_file") == 0)
2424 printf("%s\n", CS config_main_filename);
2428 if (Ustrcmp(name, "all") == 0)
2430 for (ol = optionlist_config;
2431 ol < optionlist_config + optionlist_config_size; ol++)
2433 if ((ol->type & opt_hidden) == 0)
2434 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2439 if (Ustrcmp(name, "local_scan") == 0)
2441 #ifndef LOCAL_SCAN_HAS_OPTIONS
2442 printf("local_scan() options are not supported\n");
2444 for (ol = local_scan_options;
2445 ol < local_scan_options + local_scan_options_count; ol++)
2447 print_ol(ol, US ol->name, NULL, local_scan_options,
2448 local_scan_options_count);
2454 if (Ustrcmp(name, "routers") == 0)
2459 else if (Ustrcmp(name, "transports") == 0)
2461 type = US"transport";
2465 else if (Ustrcmp(name, "authenticators") == 0)
2467 type = US"authenticator";
2471 else if (Ustrcmp(name, "authenticator_list") == 0)
2473 type = US"authenticator";
2478 else if (Ustrcmp(name, "router_list") == 0)
2484 else if (Ustrcmp(name, "transport_list") == 0)
2486 type = US"transport";
2492 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2493 name, NULL, optionlist_config, optionlist_config_size);
2498 /* Handle the options for a router or transport. Skip options that are flagged
2499 as hidden. Some of these are options with names starting with '*', used for
2500 internal alternative representations of other options (which the printing
2501 function will sort out). Others are synonyms kept for backward compatibility.
2504 if (Ustrcmp(type, "router") == 0)
2506 d = (driver_instance *)routers;
2507 ol2 = optionlist_routers;
2508 size = optionlist_routers_size;
2510 else if (Ustrcmp(type, "transport") == 0)
2512 d = (driver_instance *)transports;
2513 ol2 = optionlist_transports;
2514 size = optionlist_transports_size;
2516 else if (Ustrcmp(type, "authenticator") == 0)
2518 d = (driver_instance *)auths;
2519 ol2 = optionlist_auths;
2520 size = optionlist_auths_size;
2525 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2529 /* Either search for a given driver, or print all of them */
2531 for (; d != NULL; d = d->next)
2534 printf("\n%s %s:\n", d->name, type);
2535 else if (Ustrcmp(d->name, name) != 0) continue;
2537 for (ol = ol2; ol < ol2 + size; ol++)
2539 if ((ol->type & opt_hidden) == 0)
2540 print_ol(ol, US ol->name, d, ol2, size);
2543 for (ol = d->info->options;
2544 ol < d->info->options + *(d->info->options_count); ol++)
2546 if ((ol->type & opt_hidden) == 0)
2547 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2549 if (name != NULL) return;
2551 if (name != NULL) printf("%s %s not found\n", type, name);
2556 /*************************************************
2557 * Read a named list item *
2558 *************************************************/
2560 /* This function reads a name and a list (i.e. string). The name is used to
2561 save the list in a tree, sorted by its name. Each entry also has a number,
2562 which can be used for caching tests, but if the string contains any expansion
2563 items other than $key, the number is set negative to inhibit caching. This
2564 mechanism is used for domain, host, and address lists that are referenced by
2568 anchorp points to the tree anchor
2569 numberp points to the current number for this tree
2570 max the maximum number permitted
2571 s the text of the option line, starting immediately after the name
2573 tname the name of the list type, for messages
2579 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2582 BOOL forcecache = FALSE;
2585 namedlist_block *nb = store_get(sizeof(namedlist_block));
2587 if (Ustrncmp(s, "_cache", 6) == 0)
2594 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2596 if (*numberp >= max)
2597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2600 while (isspace(*s)) s++;
2602 while (isalnum(*s) || *s == '_') s++;
2603 t = store_get(sizeof(tree_node) + s-ss);
2604 Ustrncpy(t->name, ss, s-ss);
2606 while (isspace(*s)) s++;
2608 if (!tree_insertnode(anchorp, t))
2609 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2610 "duplicate name \"%s\" for a named %s", t->name, tname);
2613 nb->number = *numberp;
2616 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2617 "missing '=' after \"%s\"", t->name);
2618 while (isspace(*s)) s++;
2619 nb->string = read_string(s, t->name);
2620 nb->cache_data = NULL;
2622 /* Check the string for any expansions; if any are found, mark this list
2623 uncacheable unless the user has explicited forced caching. */
2625 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2631 /*************************************************
2632 * Unpick data for a rate limit *
2633 *************************************************/
2635 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2639 s string, in the form t,b,f,l
2640 where t is the threshold (integer)
2641 b is the initial delay (time)
2642 f is the multiplicative factor (fixed point)
2643 k is the maximum time (time)
2644 threshold where to store threshold
2645 base where to store base in milliseconds
2646 factor where to store factor in milliseconds
2647 limit where to store limit
2649 Returns: nothing (panics on error)
2653 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2656 uschar bstring[16], lstring[16];
2658 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2659 factor, lstring) == 4)
2661 *base = readconf_readtime(bstring, 0, TRUE);
2662 *limit = readconf_readtime(lstring, 0, TRUE);
2663 if (*base >= 0 && *limit >= 0) return;
2665 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2671 /*************************************************
2672 * Read main configuration options *
2673 *************************************************/
2675 /* This function is the first to be called for configuration reading. It
2676 opens the configuration file and reads general configuration settings until
2677 it reaches the end of the configuration section. The file is then left open so
2678 that the remaining configuration data can subsequently be read if needed for
2681 The configuration file must be owned either by root or exim, and be writeable
2682 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2683 in the config file, so the test is done on the compiled in values. A slight
2684 anomaly, to be carefully documented.
2686 The name of the configuration file is taken from a list that is included in the
2687 binary of Exim. It can be altered from the command line, but if that is done,
2688 root privilege is immediately withdrawn unless the caller is root or exim.
2689 The first file on the list that exists is used.
2691 For use on multiple systems that share file systems, first look for a
2692 configuration file whose name has the current node name on the end. If that is
2693 not found, try the generic name. For really contorted configurations, that run
2694 multiple Exims with different uid settings, first try adding the effective uid
2695 before the node name. These complications are going to waste resources on most
2696 systems. Therefore they are available only when requested by compile-time
2703 struct stat statbuf;
2704 uschar *s, *filename;
2705 uschar *list = config_main_filelist;
2707 /* Loop through the possible file names */
2709 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2712 /* Cut out all the fancy processing unless specifically wanted */
2714 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2715 uschar *suffix = filename + Ustrlen(filename);
2717 /* Try for the node-specific file if a node name exists */
2719 #ifdef CONFIGURE_FILE_USE_NODE
2721 if (uname(&uts) >= 0)
2723 #ifdef CONFIGURE_FILE_USE_EUID
2724 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2725 config_file = Ufopen(filename, "rb");
2726 if (config_file == NULL)
2727 #endif /* CONFIGURE_FILE_USE_EUID */
2729 sprintf(CS suffix, ".%.256s", uts.nodename);
2730 config_file = Ufopen(filename, "rb");
2733 #endif /* CONFIGURE_FILE_USE_NODE */
2735 /* Otherwise, try the generic name, possibly with the euid added */
2737 #ifdef CONFIGURE_FILE_USE_EUID
2738 if (config_file == NULL)
2740 sprintf(CS suffix, ".%ld", (long int)original_euid);
2741 config_file = Ufopen(filename, "rb");
2743 #endif /* CONFIGURE_FILE_USE_EUID */
2745 /* Finally, try the unadorned name */
2747 if (config_file == NULL)
2750 config_file = Ufopen(filename, "rb");
2752 #else /* if neither defined */
2754 /* This is the common case when the fancy processing is not included. */
2756 config_file = Ufopen(filename, "rb");
2759 /* If the file does not exist, continue to try any others. For any other
2760 error, break out (and die). */
2762 if (config_file != NULL || errno != ENOENT) break;
2765 /* On success, save the name for verification; config_filename is used when
2766 logging configuration errors (it changes for .included files) whereas
2767 config_main_filename is the name shown by -bP. Failure to open a configuration
2768 file is a serious disaster. */
2770 if (config_file != NULL)
2772 config_filename = config_main_filename = string_copy(filename);
2776 if (filename == NULL)
2777 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2778 "%s", config_main_filelist);
2780 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2781 "configuration file %s", filename));
2784 /* Check the status of the file we have opened, unless it was specified on
2785 the command line, in which case privilege was given away at the start. */
2787 if (!config_changed)
2789 if (fstat(fileno(config_file), &statbuf) != 0)
2790 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2793 if ((statbuf.st_uid != root_uid && /* owner not root */
2794 statbuf.st_uid != exim_uid /* owner not exim */
2795 #ifdef CONFIGURE_OWNER
2796 && statbuf.st_uid != config_uid /* owner not the special one */
2799 (statbuf.st_gid != exim_gid /* group not exim & */
2800 #ifdef CONFIGURE_GROUP
2801 && statbuf.st_gid != config_gid /* group not the special one */
2803 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2805 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2807 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2808 "wrong owner, group, or mode", big_buffer);
2811 /* Process the main configuration settings. They all begin with a lower case
2812 letter. If we see something starting with an upper case letter, it is taken as
2813 a macro definition. */
2815 while ((s = get_config_line()) != NULL)
2817 if (isupper(s[0])) read_macro_assignment(s);
2819 else if (Ustrncmp(s, "domainlist", 10) == 0)
2820 read_named_list(&domainlist_anchor, &domainlist_count,
2821 MAX_NAMED_LIST, s+10, US"domain list");
2823 else if (Ustrncmp(s, "hostlist", 8) == 0)
2824 read_named_list(&hostlist_anchor, &hostlist_count,
2825 MAX_NAMED_LIST, s+8, US"host list");
2827 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2828 read_named_list(&addresslist_anchor, &addresslist_count,
2829 MAX_NAMED_LIST, s+11, US"address list");
2831 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2832 read_named_list(&localpartlist_anchor, &localpartlist_count,
2833 MAX_NAMED_LIST, s+13, US"local part list");
2836 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2837 NULL, US"main option \"%s\" unknown");
2841 /* If local_sender_retain is set, local_from_check must be unset. */
2843 if (local_sender_retain && local_from_check)
2844 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2845 "local_sender_retain are set; this combination is not allowed");
2847 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2850 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2852 /* The max retry interval must not be greater than 24 hours. */
2854 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2856 /* remote_max_parallel must be > 0 */
2858 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2860 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2861 start of a new SMTP message. */
2863 freeze_tell_config = freeze_tell;
2865 /* The primary host name may be required for expansion of spool_directory
2866 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2867 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2868 canonize it. Some people like upper case letters in their host names, so we
2869 don't force the case. */
2871 if (primary_hostname == NULL)
2875 if (uname(&uts) < 0)
2876 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2877 hostname = US uts.nodename;
2879 if (Ustrchr(hostname, '.') == NULL)
2882 struct hostent *hostdata;
2885 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2886 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2896 #if HAVE_GETIPNODEBYNAME
2898 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2900 hostdata = gethostbyname2(CS hostname, af);
2903 hostdata = gethostbyname(CS hostname);
2906 if (hostdata != NULL)
2908 hostname = US hostdata->h_name;
2912 if (af == AF_INET) break;
2917 primary_hostname = string_copy(hostname);
2920 /* Set up default value for smtp_active_hostname */
2922 smtp_active_hostname = primary_hostname;
2924 /* If spool_directory wasn't set in the build-time configuration, it must have
2925 got set above. Of course, writing to the log may not work if log_file_path is
2926 not set, but it will at least get to syslog or somewhere, with any luck. */
2928 if (*spool_directory == 0)
2929 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2932 /* Expand the spool directory name; it may, for example, contain the primary
2933 host name. Same comment about failure. */
2935 s = expand_string(spool_directory);
2937 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2938 "\"%s\": %s", spool_directory, expand_string_message);
2939 spool_directory = s;
2941 /* Expand log_file_path, which must contain "%s" in any component that isn't
2942 the null string or "syslog". It is also allowed to contain one instance of %D.
2943 However, it must NOT contain % followed by anything else. */
2945 if (*log_file_path != 0)
2948 int sep = ':'; /* Fixed for log file path */
2949 s = expand_string(log_file_path);
2951 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2952 "\"%s\": %s", log_file_path, expand_string_message);
2955 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2958 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2959 t = Ustrstr(sss, "%s");
2961 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2962 "contain \"%%s\"", sss);
2964 t = Ustrchr(sss, '%');
2967 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2968 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2969 "unexpected \"%%\" character", s);
2976 /* Interpret syslog_facility into an integer argument for 'ident' param to
2977 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2980 if (syslog_facility_str != NULL)
2983 uschar *s = syslog_facility_str;
2985 if ((Ustrlen(syslog_facility_str) >= 4) &&
2986 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2989 for (i = 0; i < syslog_list_size; i++)
2991 if (strcmpic(s, syslog_list[i].name) == 0)
2993 syslog_facility = syslog_list[i].value;
2998 if (i >= syslog_list_size)
3000 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3001 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3005 /* Expand pid_file_path */
3007 if (*pid_file_path != 0)
3009 s = expand_string(pid_file_path);
3011 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3012 "\"%s\": %s", pid_file_path, expand_string_message);
3016 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3019 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3021 /* Unpick the SMTP rate limiting options, if set */
3023 if (smtp_ratelimit_mail != NULL)
3025 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3026 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3029 if (smtp_ratelimit_rcpt != NULL)
3031 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3032 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3035 /* The qualify domains default to the primary host name */
3037 if (qualify_domain_sender == NULL)
3038 qualify_domain_sender = primary_hostname;
3039 if (qualify_domain_recipient == NULL)
3040 qualify_domain_recipient = qualify_domain_sender;
3042 /* Setting system_filter_user in the configuration sets the gid as well if a
3043 name is given, but a numerical value does not. */
3045 if (system_filter_uid_set && !system_filter_gid_set)
3047 struct passwd *pw = getpwuid(system_filter_uid);
3049 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3050 (long int)system_filter_uid);
3051 system_filter_gid = pw->pw_gid;
3052 system_filter_gid_set = TRUE;
3055 /* If the errors_reply_to field is set, check that it is syntactically valid
3056 and ensure it contains a domain. */
3058 if (errors_reply_to != NULL)
3061 int start, end, domain;
3062 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3063 &start, &end, &domain, FALSE);
3065 if (recipient == NULL)
3066 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3067 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3070 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3071 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3074 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3075 smtp_accept_max must also be set. */
3077 if (smtp_accept_max == 0 &&
3078 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3079 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3080 "smtp_accept_max must be set if smtp_accept_queue or "
3081 "smtp_accept_max_per_host is set");
3083 /* Set up the host number if anything is specified. It is an expanded string
3084 so that it can be computed from the host name, for example. We do this last
3085 so as to ensure that everything else is set up before the expansion. */
3087 if (host_number_string != NULL)
3090 uschar *s = expand_string(host_number_string);
3091 long int n = Ustrtol(s, &end, 0);
3092 while (isspace(*end)) end++;
3094 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3095 "localhost_number value is not a number: %s", s);
3096 if (n > LOCALHOST_MAX)
3097 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3098 "localhost_number is greater than the maximum allowed value (%d)",
3104 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3106 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3107 tls_verify_certificates == NULL)
3108 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3109 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3110 (tls_verify_hosts != NULL)? "" : "try_");
3116 /*************************************************
3117 * Initialize one driver *
3118 *************************************************/
3120 /* This is called once the driver's generic options, if any, have been read.
3121 We can now find the driver, set up defaults for the private options, and
3122 unset any "set" bits in the private options table (which might have been
3123 set by another incarnation of the same driver).
3126 d pointer to driver instance block, with generic
3128 drivers_available vector of available drivers
3129 size_of_info size of each block in drivers_available
3130 class class of driver, for error message
3132 Returns: pointer to the driver info block
3135 static driver_info *
3136 init_driver(driver_instance *d, driver_info *drivers_available,
3137 int size_of_info, uschar *class)
3141 for (dd = drivers_available; dd->driver_name[0] != 0;
3142 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3144 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3147 int len = dd->options_len;
3149 d->options_block = store_get(len);
3150 memcpy(d->options_block, dd->options_block, len);
3151 for (i = 0; i < *(dd->options_count); i++)
3152 dd->options[i].type &= ~opt_set;
3157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3158 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3160 return NULL; /* never obeyed */
3166 /*************************************************
3167 * Initialize driver list *
3168 *************************************************/
3170 /* This function is called for routers, transports, and authentication
3171 mechanisms. It reads the data from the current point in the configuration file
3172 up to the end of the section, and sets up a chain of instance blocks according
3173 to the file's contents. The file will already have been opened by a call to
3174 readconf_main, and must be left open for subsequent reading of further data.
3176 Any errors cause a panic crash. Note that the blocks with names driver_info and
3177 driver_instance must map the first portions of all the _info and _instance
3178 blocks for this shared code to work.
3181 class "router", "transport", or "authenticator"
3182 anchor &routers, &transports, &auths
3183 drivers_available available drivers
3184 size_of_info size of each info block
3185 instance_default points to default data for an instance
3186 instance_size size of instance block
3187 driver_optionlist generic option list
3188 driver_optionlist_count count of generic option list
3194 readconf_driver_init(
3196 driver_instance **anchor,
3197 driver_info *drivers_available,
3199 void *instance_default,
3201 optionlist *driver_optionlist,
3202 int driver_optionlist_count)
3204 driver_instance **p = anchor;
3205 driver_instance *d = NULL;
3208 while ((buffer = get_config_line()) != NULL)
3213 /* Read the first name on the line and test for the start of a new driver. A
3214 macro definition indicates the end of the previous driver. If this isn't the
3215 start of a new driver, the line will be re-read. */
3217 s = readconf_readname(name, sizeof(name), buffer);
3219 /* Handle macro definition, first finishing off the initialization of the
3220 previous driver, if any. */
3222 if (isupper(*name) && *s == '=')
3226 if (d->driver_name == NULL)
3227 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3228 "no driver defined for %s \"%s\"", class, d->name);
3232 read_macro_assignment(buffer);
3236 /* If the line starts with a name terminated by a colon, we are at the
3237 start of the definition of a new driver. The rest of the line must be
3244 /* Finish off initializing the previous driver. */
3248 if (d->driver_name == NULL)
3249 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3250 "no driver defined for %s \"%s\"", class, d->name);
3254 /* Check that we haven't already got a driver of this name */
3256 for (d = *anchor; d != NULL; d = d->next)
3257 if (Ustrcmp(name, d->name) == 0)
3258 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3259 "there are two %ss called \"%s\"", class, name);
3261 /* Set up a new driver instance data block on the chain, with
3262 its default values installed. */
3264 d = store_get(instance_size);
3265 memcpy(d, instance_default, instance_size);
3268 d->name = string_copy(name);
3270 /* Clear out the "set" bits in the generic options */
3272 for (i = 0; i < driver_optionlist_count; i++)
3273 driver_optionlist[i].type &= ~opt_set;
3275 /* Check nothing more on this line, then do the next loop iteration. */
3277 while (isspace(*s)) s++;
3278 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3282 /* Not the start of a new driver. Give an error if we have not set up a
3283 current driver yet. */
3285 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3286 "%s name missing", class);
3288 /* First look to see if this is a generic option; if it is "driver",
3289 initialize the driver. If is it not a generic option, we can look for a
3290 private option provided that the driver has been previously set up. */
3292 if (readconf_handle_option(buffer, driver_optionlist,
3293 driver_optionlist_count, d, NULL))
3295 if (d->info == NULL && d->driver_name != NULL)
3296 init_driver(d, drivers_available, size_of_info, class);
3299 /* Handle private options - pass the generic block because some may
3300 live therein. A flag with each option indicates if it is in the public
3303 else if (d->info != NULL)
3305 readconf_handle_option(buffer, d->info->options,
3306 *(d->info->options_count), d, US"option \"%s\" unknown");
3309 /* The option is not generic and the driver name has not yet been given. */
3311 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3312 "(\"driver\" must be specified before any private options)", name);
3315 /* Run the initialization function for the final driver. */
3319 if (d->driver_name == NULL)
3320 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3321 "no driver defined for %s \"%s\"", class, d->name);
3328 /*************************************************
3329 * Check driver dependency *
3330 *************************************************/
3332 /* This function is passed a driver instance and a string. It checks whether
3333 any of the string options for the driver contains the given string as an
3337 d points to a driver instance block
3338 s the string to search for
3340 Returns: TRUE if a dependency is found
3344 readconf_depends(driver_instance *d, uschar *s)
3346 int count = *(d->info->options_count);
3350 for (ol = d->info->options; ol < d->info->options + count; ol++)
3352 void *options_block;
3354 int type = ol->type & opt_mask;
3355 if (type != opt_stringptr) continue;
3356 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3357 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3358 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3360 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3361 isalnum(ss[Ustrlen(s)])) continue;
3362 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3363 d->name, ol->name, s);
3368 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3375 /*************************************************
3376 * Decode an error type for retries *
3377 *************************************************/
3379 /* This function is global because it is also called from the main
3380 program when testing retry information. It decodes strings such as "quota_7d"
3381 into numerical error codes.
3384 pp points to start of text
3385 p points past end of text
3386 basic_errno points to an int to receive the main error number
3387 more_errno points to an int to receive the secondary error data
3389 Returns: NULL if decoded correctly; else points to error text
3393 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3397 while (q < p && *q != '_') q++;
3400 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3402 *basic_errno = ERRNO_EXIMQUOTA;
3403 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3404 return US"bad time value";
3407 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3409 *basic_errno = ECONNREFUSED;
3412 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3413 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3414 else return US"A or MX expected after \"refused\"";
3418 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3420 *basic_errno = ETIMEDOUT;
3424 int xlen = p - q - 1;
3427 static uschar *extras[] =
3428 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3429 static int values[] =
3430 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3432 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3434 if (strncmpic(x, extras[i], xlen) == 0)
3436 *more_errno = values[i];
3441 if (i >= sizeof(extras)/sizeof(uschar *))
3443 if (strncmpic(x, US"DNS", xlen) == 0)
3445 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3446 "available in retry rules (it has never worked) - treated as "
3449 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3454 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3455 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3456 strncmpic(pp, US"data_4", 6) == 0)
3459 int x = 255; /* means "any 4xx code" */
3460 if (p != pp + 8) bad = TRUE; else
3462 int a = pp[6], b = pp[7];
3466 if (isdigit(b)) x += b - '0';
3467 else if (b == 'x') x += 100;
3470 else if (a != 'x' || b != 'x') bad = TRUE;
3474 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3475 "x is literal and d is any digit", pp);
3477 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3478 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3479 *more_errno = x << 8;
3482 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3483 strncmpic(q+1, US"failed", p-q-1) == 0)
3484 *basic_errno = ERRNO_AUTHFAIL;
3486 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3487 *basic_errno = ERRNO_SMTPCLOSED;
3489 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3490 *basic_errno = ERRNO_TLSREQUIRED;
3492 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3493 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3501 /*************************************************
3502 * Read retry information *
3503 *************************************************/
3505 /* Each line of retry information contains:
3507 . A domain name pattern or an address pattern;
3509 . An error name, possibly with additional data, or *;
3511 . An optional sequence of retry items, each consisting of an identifying
3512 letter, a cutoff time, and optional parameters.
3514 All this is decoded and placed into a control block. */
3517 /* Subroutine to read an argument, preceded by a comma and terminated
3518 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3519 1 = fixed point number (returned *1000).
3522 paddr pointer to pointer to current character; updated
3523 type 0 => read a time; 1 => read a fixed point number
3525 Returns: time in seconds or fixed point number * 1000
3529 retry_arg(uschar **paddr, int type)
3534 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3536 while (isspace(*p)) p++;
3538 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3540 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3541 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3547 return readconf_readtime(pp, *p, FALSE);
3549 return readconf_readfixed(pp, *p);
3551 return 0; /* Keep picky compilers happy */
3554 /* The function proper */
3557 readconf_retries(void)
3559 retry_config **chain = &retries;
3563 while ((p = get_config_line()) != NULL)
3565 retry_rule **rchain;
3568 next = store_get(sizeof(retry_config));
3571 chain = &(next->next);
3572 next->basic_errno = next->more_errno = 0;
3573 next->senders = NULL;
3575 rchain = &(next->rules);
3577 next->pattern = string_dequote(&p);
3578 while (isspace(*p)) p++;
3580 while (mac_isgraph(*p)) p++;
3581 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3582 "missing error type");
3584 /* Test error names for things we understand. */
3586 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3587 &(next->more_errno))) != NULL)
3588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3590 /* There may be an optional address list of senders to be used as another
3591 constraint on the rule. This was added later, so the syntax is a bit of a
3592 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3595 while (isspace(*p)) p++;
3596 if (Ustrncmp(p, "senders", 7) == 0)
3599 while (isspace(*p)) p++;
3600 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3601 "\"=\" expected after \"senders\" in retry rule");
3602 while (isspace(*p)) p++;
3603 next->senders = string_dequote(&p);
3606 /* Now the retry rules. Keep the maximum timeout encountered. */
3608 while (isspace(*p)) p++;
3612 retry_rule *rule = store_get(sizeof(retry_rule));
3614 rchain = &(rule->next);
3616 rule->rule = toupper(*p++);
3617 rule->timeout = retry_arg(&p, 0);
3618 if (rule->timeout > retry_maximum_timeout)
3619 retry_maximum_timeout = rule->timeout;
3623 case 'F': /* Fixed interval */
3624 rule->p1 = retry_arg(&p, 0);
3627 case 'G': /* Geometrically increasing intervals */
3628 case 'H': /* Ditto, but with randomness */
3629 rule->p1 = retry_arg(&p, 0);
3630 rule->p2 = retry_arg(&p, 1);
3634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3638 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3639 (rule->rule != 'F' && rule->p2 < 1000))
3640 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3641 "bad parameters for retry rule");
3643 while (isspace(*p)) p++;
3647 while (isspace(*p)) p++;
3650 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3657 /*************************************************
3658 * Initialize authenticators *
3659 *************************************************/
3661 /* Read the authenticators section of the configuration file.
3670 auth_instance *au, *bu;
3671 readconf_driver_init(US"authenticator",
3672 (driver_instance **)(&auths), /* chain anchor */
3673 (driver_info *)auths_available, /* available drivers */
3674 sizeof(auth_info), /* size of info block */
3675 &auth_defaults, /* default values for generic options */
3676 sizeof(auth_instance), /* size of instance block */
3677 optionlist_auths, /* generic options */
3678 optionlist_auths_size);
3680 for (au = auths; au != NULL; au = au->next)
3682 if (au->public_name == NULL)
3683 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3684 "the %s authenticator", au->name);
3685 for (bu = au->next; bu != NULL; bu = bu->next)
3687 if (strcmpic(au->public_name, bu->public_name) == 0)
3689 if ((au->client && bu->client) || (au->server && bu->server))
3690 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3691 "(%s and %s) have the same public name (%s)",
3692 (au->client)? US"client" : US"server", au->name, bu->name,
3702 /*************************************************
3703 * Read ACL information *
3704 *************************************************/
3706 /* If this run of Exim is not doing something that involves receiving a
3707 message, we can just skip over the ACL information. No need to parse it.
3709 First, we have a function for acl_read() to call back to get the next line. We
3710 need to remember the line we passed, because at the end it will contain the
3711 name of the next ACL. */
3713 static uschar *acl_line;
3718 acl_line = get_config_line();
3723 /* Now the main function:
3726 skip TRUE when this Exim process is doing something that will
3727 not need the ACL data
3733 readconf_acl(BOOL skip)
3737 /* Not receiving messages, don't need to parse the ACL data */
3741 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3742 while ((p = get_config_line()) != NULL);
3746 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3749 acl_line = get_config_line();
3751 while(acl_line != NULL)
3757 p = readconf_readname(name, sizeof(name), acl_line);
3758 if (isupper(*name) && *p == '=')
3760 read_macro_assignment(acl_line);
3761 acl_line = get_config_line();
3765 if (*p != ':' || name[0] == 0)
3766 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3768 node = store_get(sizeof(tree_node) + Ustrlen(name));
3769 Ustrcpy(node->name, name);
3770 if (!tree_insertnode(&acl_anchor, node))
3771 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3772 "there are two ACLs called \"%s\"", name);
3774 node->data.ptr = acl_read(acl_callback, &error);
3776 if (node->data.ptr == NULL && error != NULL)
3777 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3783 /*************************************************
3784 * Read configuration for local_scan() *
3785 *************************************************/
3787 /* This function is called after "begin local_scan" is encountered in the
3788 configuration file. If the local_scan() function allows for configuration
3789 options, we can process them. Otherwise, we expire in a panic.
3796 local_scan_init(void)
3798 #ifndef LOCAL_SCAN_HAS_OPTIONS
3799 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3800 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3804 while ((p = get_config_line()) != NULL)
3806 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3807 NULL, US"local_scan option \"%s\" unknown");
3814 /*************************************************
3815 * Read rest of configuration (after main) *
3816 *************************************************/
3818 /* This function reads the rest of the runtime configuration, after the main
3819 configuration. It is called only when actually needed. Each subsequent section
3820 of the configuration starts with a line of the form
3824 where the name is "routers", "transports", etc. A section is terminated by
3825 hitting the next "begin" line, and the next name is left in next_section.
3826 Because it may confuse people as to whether the names are singular or plural,
3827 we add "s" if it's missing. There is always enough room in next_section for
3828 this. This function is basically just a switch.
3831 skip_acl TRUE if ACL information is not needed
3836 static uschar *section_list[] = {
3846 readconf_rest(BOOL skip_acl)
3850 while(next_section[0] != 0)
3854 int last = sizeof(section_list) / sizeof(uschar *);
3856 int n = Ustrlen(next_section);
3858 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3862 int c = strcmpic(next_section, section_list[mid]);
3864 if (c > 0) first = mid + 1; else last = mid;
3866 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3867 "\"%.*s\" is not a known configuration section name", n, next_section);
3868 mid = (last + first)/2;
3872 if (((had ^= bit) & bit) == 0)
3873 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3874 "\"%.*s\" section is repeated in the configuration file", n,
3879 case 0: readconf_acl(skip_acl); break;
3880 case 1: auths_init(); break;
3881 case 2: local_scan_init(); break;
3882 case 3: readconf_retries(); break;
3883 case 4: readconf_rewrites(); break;
3884 case 5: route_init(); break;
3885 case 6: transport_init(); break;
3889 (void)fclose(config_file);
3892 /* End of readconf.c */