1 /* $Cambridge: exim/src/src/readconf.c,v 1.8 2005/05/10 10:19:11 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
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_smtp_auth", opt_stringptr, &acl_smtp_auth },
142 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
143 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
144 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
145 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
146 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
147 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
148 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
149 #ifdef WITH_CONTENT_SCAN
150 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
152 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
153 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
154 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
156 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
158 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
159 { "admin_groups", opt_gidlist, &admin_groups },
160 { "allow_domain_literals", opt_bool, &allow_domain_literals },
161 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
162 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
163 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
164 { "auto_thaw", opt_time, &auto_thaw },
165 #ifdef WITH_CONTENT_SCAN
166 { "av_scanner", opt_stringptr, &av_scanner },
168 { "bi_command", opt_stringptr, &bi_command },
169 #ifdef EXPERIMENTAL_BRIGHTMAIL
170 { "bmi_config_file", opt_stringptr, &bmi_config_file },
172 { "bounce_message_file", opt_stringptr, &bounce_message_file },
173 { "bounce_message_text", opt_stringptr, &bounce_message_text },
174 { "bounce_return_body", opt_bool, &bounce_return_body },
175 { "bounce_return_message", opt_bool, &bounce_return_message },
176 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
177 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
178 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
179 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
180 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
181 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
182 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
183 { "check_log_inodes", opt_int, &check_log_inodes },
184 { "check_log_space", opt_Kint, &check_log_space },
185 { "check_spool_inodes", opt_int, &check_spool_inodes },
186 { "check_spool_space", opt_Kint, &check_spool_space },
187 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
188 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
189 { "delay_warning", opt_timelist, &delay_warning },
190 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
191 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
192 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
193 { "delivery_date_remove", opt_bool, &delivery_date_remove },
194 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
195 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
196 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
197 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
198 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
199 { "dns_retrans", opt_time, &dns_retrans },
200 { "dns_retry", opt_int, &dns_retry },
201 /* This option is now a no-op, retained for compability */
202 { "drop_cr", opt_bool, &drop_cr },
203 /*********************************************************/
204 { "envelope_to_remove", opt_bool, &envelope_to_remove },
205 { "errors_copy", opt_stringptr, &errors_copy },
206 { "errors_reply_to", opt_stringptr, &errors_reply_to },
207 { "exim_group", opt_gid, &exim_gid },
208 { "exim_path", opt_stringptr, &exim_path },
209 { "exim_user", opt_uid, &exim_uid },
210 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
211 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
212 { "finduser_retries", opt_int, &finduser_retries },
213 { "freeze_tell", opt_stringptr, &freeze_tell },
214 { "gecos_name", opt_stringptr, &gecos_name },
215 { "gecos_pattern", opt_stringptr, &gecos_pattern },
216 { "header_line_maxsize", opt_int, &header_line_maxsize },
217 { "header_maxsize", opt_int, &header_maxsize },
218 { "headers_charset", opt_stringptr, &headers_charset },
219 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
220 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
221 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
222 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
223 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
224 { "hold_domains", opt_stringptr, &hold_domains },
225 { "host_lookup", opt_stringptr, &host_lookup },
226 { "host_lookup_order", opt_stringptr, &host_lookup_order },
227 { "host_reject_connection", opt_stringptr, &host_reject_connection },
228 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
229 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
231 { "ibase_servers", opt_stringptr, &ibase_servers },
233 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
234 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
235 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
236 { "keep_malformed", opt_time, &keep_malformed },
238 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
239 { "ldap_version", opt_int, &eldap_version },
241 { "local_from_check", opt_bool, &local_from_check },
242 { "local_from_prefix", opt_stringptr, &local_from_prefix },
243 { "local_from_suffix", opt_stringptr, &local_from_suffix },
244 { "local_interfaces", opt_stringptr, &local_interfaces },
245 { "local_scan_timeout", opt_time, &local_scan_timeout },
246 { "local_sender_retain", opt_bool, &local_sender_retain },
247 { "localhost_number", opt_stringptr, &host_number_string },
248 { "log_file_path", opt_stringptr, &log_file_path },
249 { "log_selector", opt_stringptr, &log_selector_string },
250 { "log_timezone", opt_bool, &log_timezone },
251 { "lookup_open_max", opt_int, &lookup_open_max },
252 { "max_username_length", opt_int, &max_username_length },
253 { "message_body_visible", opt_mkint, &message_body_visible },
254 { "message_id_header_domain", opt_stringptr, &message_id_domain },
255 { "message_id_header_text", opt_stringptr, &message_id_text },
256 { "message_logs", opt_bool, &message_logs },
257 { "message_size_limit", opt_stringptr, &message_size_limit },
258 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
259 { "move_frozen_messages", opt_bool, &move_frozen_messages },
261 { "mua_wrapper", opt_bool, &mua_wrapper },
263 { "mysql_servers", opt_stringptr, &mysql_servers },
265 { "never_users", opt_uidlist, &never_users },
267 { "oracle_servers", opt_stringptr, &oracle_servers },
269 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
271 { "perl_at_start", opt_bool, &opt_perl_at_start },
272 { "perl_startup", opt_stringptr, &opt_perl_startup },
275 { "pgsql_servers", opt_stringptr, &pgsql_servers },
277 { "pid_file_path", opt_stringptr, &pid_file_path },
278 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
279 { "preserve_message_logs", opt_bool, &preserve_message_logs },
280 { "primary_hostname", opt_stringptr, &primary_hostname },
281 { "print_topbitchars", opt_bool, &print_topbitchars },
282 { "process_log_path", opt_stringptr, &process_log_path },
283 { "prod_requires_admin", opt_bool, &prod_requires_admin },
284 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
285 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
286 { "queue_domains", opt_stringptr, &queue_domains },
287 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
288 { "queue_only", opt_bool, &queue_only },
289 { "queue_only_file", opt_stringptr, &queue_only_file },
290 { "queue_only_load", opt_fixed, &queue_only_load },
291 { "queue_only_override", opt_bool, &queue_only_override },
292 { "queue_run_in_order", opt_bool, &queue_run_in_order },
293 { "queue_run_max", opt_int, &queue_run_max },
294 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
295 { "receive_timeout", opt_time, &receive_timeout },
296 { "received_header_text", opt_stringptr, &received_header_text },
297 { "received_headers_max", opt_int, &received_headers_max },
298 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
299 { "recipients_max", opt_int, &recipients_max },
300 { "recipients_max_reject", opt_bool, &recipients_max_reject },
301 { "remote_max_parallel", opt_int, &remote_max_parallel },
302 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
303 { "retry_data_expire", opt_time, &retry_data_expire },
304 { "retry_interval_max", opt_time, &retry_interval_max },
305 { "return_path_remove", opt_bool, &return_path_remove },
306 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
307 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
308 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
309 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
310 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
311 { "smtp_accept_max", opt_int, &smtp_accept_max },
312 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
313 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
314 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
315 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
316 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
317 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
318 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
319 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
320 { "smtp_banner", opt_stringptr, &smtp_banner },
321 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
322 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
323 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
324 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
325 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
326 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
327 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
328 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
329 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
330 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
331 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
332 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
333 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
334 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
335 #ifdef WITH_CONTENT_SCAN
336 { "spamd_address", opt_stringptr, &spamd_address },
338 { "split_spool_directory", opt_bool, &split_spool_directory },
339 { "spool_directory", opt_stringptr, &spool_directory },
340 #ifdef EXPERIMENTAL_SRS
341 { "srs_config", opt_stringptr, &srs_config },
343 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
344 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
345 { "syslog_duplication", opt_bool, &syslog_duplication },
346 { "syslog_facility", opt_stringptr, &syslog_facility_str },
347 { "syslog_processname", opt_stringptr, &syslog_processname },
348 { "syslog_timestamp", opt_bool, &syslog_timestamp },
349 { "system_filter", opt_stringptr, &system_filter },
350 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
351 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
352 { "system_filter_group", opt_gid, &system_filter_gid },
353 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
354 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
355 { "system_filter_user", opt_uid, &system_filter_uid },
356 { "tcp_nodelay", opt_bool, &tcp_nodelay },
357 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
358 { "timezone", opt_stringptr, &timezone_string },
360 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
361 { "tls_certificate", opt_stringptr, &tls_certificate },
362 { "tls_crl", opt_stringptr, &tls_crl },
363 { "tls_dhparam", opt_stringptr, &tls_dhparam },
364 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
365 { "tls_privatekey", opt_stringptr, &tls_privatekey },
366 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
367 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
368 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
369 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
370 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
372 { "trusted_groups", opt_gidlist, &trusted_groups },
373 { "trusted_users", opt_uidlist, &trusted_users },
374 { "unknown_login", opt_stringptr, &unknown_login },
375 { "unknown_username", opt_stringptr, &unknown_username },
376 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
377 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
378 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
379 { "warn_message_file", opt_stringptr, &warn_message_file },
380 { "write_rejectlog", opt_bool, &write_rejectlog }
383 static int optionlist_config_size =
384 sizeof(optionlist_config)/sizeof(optionlist);
388 /*************************************************
389 * Find the name of an option *
390 *************************************************/
392 /* This function is to aid debugging. Various functions take arguments that are
393 pointer variables in the options table or in option tables for various drivers.
394 For debugging output, it is useful to be able to find the name of the option
395 which is currently being processed. This function finds it, if it exists, by
396 searching the table(s).
398 Arguments: a value that is presumed to be in the table above
399 Returns: the option name, or an empty string
403 readconf_find_option(void *p)
407 transport_instance *t;
409 for (i = 0; i < optionlist_config_size; i++)
410 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
412 for (r = routers; r != NULL; r = r->next)
414 router_info *ri = r->info;
415 for (i = 0; i < ri->options_count[0]; i++)
417 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
418 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
419 return US ri->options[i].name;
423 for (t = transports; t != NULL; t = t->next)
425 transport_info *ti = t->info;
426 for (i = 0; i < ti->options_count[0]; i++)
428 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
429 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
430 return US ti->options[i].name;
440 /*************************************************
441 * Deal with an assignment to a macro *
442 *************************************************/
444 /* This function is called when a line that starts with an upper case letter is
445 encountered. The argument "line" should contain a complete logical line, and
446 start with the first letter of the macro name. The macro name and the
447 replacement text are extracted and stored. Redefinition of existing,
448 non-command line, macros is permitted using '==' instead of '='.
451 s points to the start of the logical line
457 read_macro_assignment(uschar *s)
463 macro_item *mlast = NULL;
465 while (isalnum(*s) || *s == '_')
467 if (namelen >= sizeof(name) - 1)
468 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
469 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
470 name[namelen++] = *s++;
474 while (isspace(*s)) s++;
476 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
483 while (isspace(*s)) s++;
485 /* If an existing macro of the same name was defined on the command line, we
486 just skip this definition. It's an error to attempt to redefine a macro without
487 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
488 It is also an error to define a macro whose name begins with the name of a
489 previously defined macro. Note: it is documented that the other way round
492 for (m = macros; m != NULL; m = m->next)
494 int len = Ustrlen(m->name);
496 if (Ustrcmp(m->name, name) == 0)
498 if (!m->command_line && !redef)
499 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
500 "defined (use \"==\" if you want to redefine it", name);
504 if (len < namelen && Ustrstr(name, m->name) != NULL)
505 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
506 "a macro because previously defined macro \"%s\" is a substring",
509 /* We cannot have this test, because it is documented that a substring
510 macro is permitted (there is even an example).
512 * if (len > namelen && Ustrstr(m->name, name) != NULL)
513 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
514 * "a macro because it is a substring of previously defined macro \"%s\"",
521 /* Check for an overriding command-line definition. */
523 if (m != NULL && m->command_line) return;
525 /* Redefinition must refer to an existing macro. */
530 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
534 /* We have a new definition. The macro_item structure includes a final vector
535 called "name" which is one byte long. Thus, adding "namelen" gives us enough
536 room to store the "name" string. */
540 m = store_get(sizeof(macro_item) + namelen);
541 if (macros == NULL) macros = m; else mlast->next = m;
542 Ustrncpy(m->name, name, namelen);
543 m->name[namelen] = 0;
545 m->command_line = FALSE;
548 /* Set the value of the new or redefined macro */
550 m->replacement = string_copy(s);
557 /*************************************************
558 * Read configuration line *
559 *************************************************/
561 /* A logical line of text is read from the configuration file into the big
562 buffer, taking account of macros, .includes, and continuations. The size of
563 big_buffer is increased if necessary. The count of configuration lines is
564 maintained. Physical input lines starting with # (ignoring leading white space,
565 and after macro replacement) and empty logical lines are always ignored.
566 Leading and trailing spaces are removed.
568 If we hit a line of the form "begin xxxx", the xxxx is placed in the
569 next_section vector, and the function returns NULL, indicating the end of a
570 configuration section. On end-of-file, NULL is returned with next_section
575 Returns: a pointer to the first non-blank in the line,
576 or NULL if eof or end of section is reached
580 get_config_line(void)
582 int startoffset = 0; /* To first non-blank char in logical line */
583 int len = 0; /* Of logical line so far */
589 /* Loop for handling continuation lines, skipping comments, and dealing with
594 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
596 if (config_file_stack != NULL) /* EOF inside .include */
599 config_file = config_file_stack->file;
600 config_filename = config_file_stack->filename;
601 config_lineno = config_file_stack->lineno;
602 config_file_stack = config_file_stack->next;
606 /* EOF at top level */
608 if (cstate_stack_ptr >= 0)
609 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
610 "Unexpected end of configuration file: .endif missing");
612 if (len != 0) break; /* EOF after continuation */
613 next_section[0] = 0; /* EOF at start of logical line */
618 newlen = len + Ustrlen(big_buffer + len);
620 /* Handle pathologically long physical lines - yes, it did happen - by
621 extending big_buffer at this point. The code also copes with very long
624 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
627 big_buffer_size += BIG_BUFFER_SIZE;
628 newbuffer = store_malloc(big_buffer_size);
630 /* This use of strcpy is OK because we know that the string in the old
631 buffer is shorter than the new buffer. */
633 Ustrcpy(newbuffer, big_buffer);
634 store_free(big_buffer);
635 big_buffer = newbuffer;
636 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
638 newlen += Ustrlen(big_buffer + newlen);
641 /* Find the true start of the physical line - leading spaces are always
644 ss = big_buffer + len;
645 while (isspace(*ss)) ss++;
647 /* Process the physical line for macros. If this is the start of the logical
648 line, skip over initial text at the start of the line if it starts with an
649 upper case character followed by a sequence of name characters and an equals
650 sign, because that is the definition of a new macro, and we don't do
651 replacement therein. */
654 if (len == 0 && isupper(*s))
656 while (isalnum(*s) || *s == '_') s++;
657 while (isspace(*s)) s++;
658 if (*s != '=') s = ss; /* Not a macro definition */
661 /* For each defined macro, scan the line (from after XXX= if present),
662 replacing all occurrences of the macro. */
665 for (m = macros; m != NULL; m = m->next)
670 while ((p = Ustrstr(t, m->name)) != NULL)
673 int namelen = Ustrlen(m->name);
674 int replen = Ustrlen(m->replacement);
676 /* Expand the buffer if necessary */
678 while (newlen - namelen + replen + 1 > big_buffer_size)
680 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
681 uschar *newbuffer = store_malloc(newsize);
682 memcpy(newbuffer, big_buffer, newlen + 1);
683 p = newbuffer + (p - big_buffer);
684 s = newbuffer + (s - big_buffer);
685 ss = newbuffer + (ss - big_buffer);
686 t = newbuffer + (t - big_buffer);
687 big_buffer_size = newsize;
688 store_free(big_buffer);
689 big_buffer = newbuffer;
692 /* Shuffle the remaining characters up or down in the buffer before
693 copying in the replacement text. Don't rescan the replacement for this
697 moveby = replen - namelen;
700 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
703 Ustrncpy(p, m->replacement, replen);
709 /* An empty macro replacement at the start of a line could mean that ss no
710 longer points to the first non-blank character. */
712 while (isspace(*ss)) ss++;
714 /* Check for comment lines - these are physical lines. */
716 if (*ss == '#') continue;
718 /* Handle conditionals, which are also applied to physical lines. Conditions
719 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
720 expansion occured on the rest of the line. A preliminary test for the leading
721 '.' saves effort on most lines. */
727 /* Search the list of conditional directives */
729 for (i = 0; i < cond_list_size; i++)
732 cond_item *c = cond_list+i;
733 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
735 /* The following character must be white space or end of string */
737 n = ss[1 + c->namelen];
738 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
740 /* .ifdef and .ifndef push the current state onto the stack, then set
741 a new one from the table. Stack overflow is an error */
745 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
746 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
747 ".%s nested too deeply", c->name);
748 cstate_stack[++cstate_stack_ptr] = cstate;
749 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
752 /* For any of the others, stack underflow is an error. The next state
753 comes either from the stack (.endif) or from the table. */
757 if (cstate_stack_ptr < 0)
758 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
759 ".%s without matching .ifdef", c->name);
760 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
761 next_cstate[cstate][macro_found? c->action1 : c->action2];
764 /* Having dealt with a directive, break the loop */
769 /* If we have handled a conditional directive, continue with the next
770 physical line. Otherwise, fall through. */
772 if (i < cond_list_size) continue;
775 /* If the conditional state is not 0 (actively using these lines), ignore
778 if (cstate != 0) continue; /* Conditional skip */
780 /* Handle .include lines - these are also physical lines. */
782 if (Ustrncmp(ss, ".include", 8) == 0 &&
784 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
787 int include_if_exists = isspace(ss[8])? 0 : 10;
788 config_file_item *save;
791 ss += 9 + include_if_exists;
792 while (isspace(*ss)) ss++;
793 t = ss + Ustrlen(ss);
794 while (t > ss && isspace(t[-1])) t--;
795 if (*ss == '\"' && t[-1] == '\"')
802 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
804 save = store_get(sizeof(config_file_item));
805 save->next = config_file_stack;
806 config_file_stack = save;
807 save->file = config_file;
808 save->filename = config_filename;
809 save->lineno = config_lineno;
811 config_file = Ufopen(ss, "rb");
812 if (config_file == NULL)
813 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
814 "configuration file %s", ss);
815 config_filename = string_copy(ss);
820 /* If this is the start of the logical line, remember where the non-blank
821 data starts. Otherwise shuffle down continuation lines to remove leading
825 startoffset = ss - big_buffer;
828 s = big_buffer + len;
831 memmove(s, ss, (newlen - len) - (ss - s) + 1);
836 /* Accept the new addition to the line. Remove trailing white space. */
839 while (len > 0 && isspace(big_buffer[len-1])) len--;
842 /* We are done if the line does not end in backslash and contains some data.
843 Empty logical lines are ignored. For continuations, remove the backslash and
844 go round the loop to read the continuation line. */
848 if (big_buffer[len-1] != '\\') break; /* End of logical line */
849 big_buffer[--len] = 0; /* Remove backslash */
851 } /* Loop for reading multiple physical lines */
853 /* We now have a logical line. Test for the end of a configuration section (or,
854 more accurately, for the start of the next section). Place the name of the next
855 section in next_section, and return NULL. If the name given is longer than
856 next_section, truncate it. It will be unrecognized later, because all the known
857 section names do fit. Leave space for pluralizing. */
859 s = big_buffer + startoffset; /* First non-space character */
860 if (strncmpic(s, US"begin ", 6) == 0)
863 while (isspace(*s)) s++;
864 if (big_buffer + len - s > sizeof(next_section) - 2)
865 s[sizeof(next_section) - 2] = 0;
866 Ustrcpy(next_section, s);
870 /* Return the first non-blank character. */
877 /*************************************************
879 *************************************************/
881 /* The yield is the pointer to the next uschar. Names longer than the
882 output space are silently truncated. This function is also used from acl.c when
886 name where to put the name
890 Returns: new input pointer
894 readconf_readname(uschar *name, int len, uschar *s)
897 while (isspace(*s)) s++;
900 while (isalnum(*s) || *s == '_')
902 if (p < len-1) name[p++] = *s;
907 while (isspace(*s)) s++;
914 /*************************************************
915 * Read a time value *
916 *************************************************/
918 /* This function is also called from outside, to read argument
919 time values. The format of a time value is:
921 [<n>w][<n>d][<n>h][<n>m][<n>s]
923 as long as at least one is present. If a format error is encountered,
924 return a negative value. The value must be terminated by the given
929 terminator required terminating character
930 return_msec if TRUE, allow fractional seconds and return milliseconds
932 Returns: the time value, or -1 on syntax error
933 value is seconds if return_msec is FALSE
934 value is milliseconds if return_msec is TRUE
938 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
946 if (!isdigit(*s)) return -1;
947 (void)sscanf(CS s, "%d%n", &value, &count);
952 case 'w': value *= 7;
953 case 'd': value *= 24;
954 case 'h': value *= 60;
955 case 'm': value *= 60;
960 if (!return_msec) return -1;
961 (void)sscanf(CS s, "%lf%n", &fraction, &count);
963 if (*s++ != 's') return -1;
964 yield += (int)(fraction * 1000.0);
970 if (return_msec) value *= 1000;
972 if (*s == terminator) return yield;
974 /* Control never reaches here. */
979 /*************************************************
980 * Read a fixed point value *
981 *************************************************/
983 /* The value is returned *1000
987 terminator required terminator
989 Returns: the value, or -1 on error
993 readconf_readfixed(uschar *s, int terminator)
997 if (!isdigit(*s)) return -1;
998 (void)sscanf(CS s, "%d%n", &value, &count);
1000 yield = value * 1000;
1004 while (isdigit((*(++s))))
1006 yield += (*s - '0') * m;
1011 return (*s == terminator)? yield : (-1);
1016 /*************************************************
1017 * Find option in list *
1018 *************************************************/
1020 /* The lists are always in order, so binary chop can be used.
1023 name the option name to search for
1024 ol the first entry in the option list
1025 last one more than the offset of the last entry in the option list
1027 Returns: pointer to an option entry, or NULL if not found
1031 find_option(uschar *name, optionlist *ol, int last)
1034 while (last > first)
1036 int middle = (first + last)/2;
1037 int c = Ustrcmp(name, ol[middle].name);
1038 if (c == 0) return ol + middle;
1039 else if (c > 0) first = middle + 1;
1047 /*************************************************
1048 * Find a set flag in option list *
1049 *************************************************/
1051 /* Because some versions of Unix make no restrictions on the values of uids and
1052 gids (even negative ones), we cannot represent "unset" by a special value.
1053 There is therefore a separate boolean variable for each one indicating whether
1054 a value is set or not. This function returns a pointer to the boolean, given
1055 the original option name. It is a major disaster if the flag cannot be found.
1058 name the name of the uid or gid option
1059 oltop points to the start of the relevant option list
1060 last one more than the offset of the last item in the option list
1061 data_block NULL when reading main options => data values in the option
1062 list are absolute addresses; otherwise they are byte offsets
1063 in data_block (used for driver options)
1065 Returns: a pointer to the boolean flag.
1069 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1073 sprintf(CS name2, "*set_%.50s", name);
1074 ol = find_option(name2, oltop, last);
1075 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1076 "Exim internal error: missing set flag for %s", name);
1077 return (data_block == NULL)? (BOOL *)(ol->value) :
1078 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1084 /*************************************************
1085 * Output extra characters message and die *
1086 *************************************************/
1088 /* Called when an option line has junk on the end. Sometimes this is because
1089 the sysadmin thinks comments are permitted.
1092 s points to the extra characters
1093 t1..t3 strings to insert in the log message
1095 Returns: doesn't return; dies
1099 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1101 uschar *comment = US"";
1102 if (*s == '#') comment = US" (# is comment only at line start)";
1103 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1104 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1109 /*************************************************
1110 * Read rewrite information *
1111 *************************************************/
1113 /* Each line of rewrite information contains:
1115 . A complete address in the form user@domain, possibly with
1116 leading * for each part; or alternatively, a regex.
1118 . A replacement string (which will be expanded).
1120 . An optional sequence of one-letter flags, indicating which
1121 headers etc. to apply this rule to.
1123 All this is decoded and placed into a control block. The OR of the flags is
1124 maintained in a common word.
1127 p points to the string that makes up the rule
1128 existflags points to the overall flag word
1129 isglobal TRUE if reading global rewrite rules
1131 Returns: the control block for the parsed rule.
1134 static rewrite_rule *
1135 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1137 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1140 next->key = string_dequote(&p);
1142 while (isspace(*p)) p++;
1144 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1145 "missing rewrite replacement string");
1148 next->replacement = string_dequote(&p);
1150 while (*p != 0) switch (*p++)
1152 case ' ': case '\t': break;
1154 case 'q': next->flags |= rewrite_quit; break;
1155 case 'w': next->flags |= rewrite_whole; break;
1157 case 'h': next->flags |= rewrite_all_headers; break;
1158 case 's': next->flags |= rewrite_sender; break;
1159 case 'f': next->flags |= rewrite_from; break;
1160 case 't': next->flags |= rewrite_to; break;
1161 case 'c': next->flags |= rewrite_cc; break;
1162 case 'b': next->flags |= rewrite_bcc; break;
1163 case 'r': next->flags |= rewrite_replyto; break;
1165 case 'E': next->flags |= rewrite_all_envelope; break;
1166 case 'F': next->flags |= rewrite_envfrom; break;
1167 case 'T': next->flags |= rewrite_envto; break;
1169 case 'Q': next->flags |= rewrite_qualify; break;
1170 case 'R': next->flags |= rewrite_repeat; break;
1173 next->flags |= rewrite_smtp;
1174 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1176 "rewrite rule has the S flag but is not a regular expression");
1180 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1181 "unknown rewrite flag character '%c' "
1182 "(could be missing quotes round replacement item)", p[-1]);
1186 /* If no action flags are set, set all the "normal" rewrites. */
1188 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1189 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1191 /* Remember which exist, for optimization, and return the rule */
1193 *existflags |= next->flags;
1200 /*************************************************
1201 * Read global rewrite information *
1202 *************************************************/
1204 /* Each line is a single rewrite rule; it is parsed into a control block
1205 by readconf_one_rewrite(), and its flags are ORed into the global flag
1206 word rewrite_existflags. */
1209 readconf_rewrites(void)
1211 rewrite_rule **chain = &global_rewrite_rules;
1214 while ((p = get_config_line()) != NULL)
1216 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1218 chain = &(next->next);
1224 /*************************************************
1226 *************************************************/
1228 /* Strings are read into the normal store pool. As long we aren't too
1229 near the end of the current block, the string will just use what is necessary
1230 on the top of the stacking pool, because string_cat() uses the extension
1234 s the rest of the input line
1235 name the option name (for errors)
1237 Returns: pointer to the string
1241 read_string(uschar *s, uschar *name)
1246 if (*s != '\"') return string_copy(s);
1249 yield = string_dequote(&s);
1251 if (s == ss+1 || s[-1] != '\"')
1252 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1253 "missing quote at end of string value for %s", name);
1255 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1261 /*************************************************
1262 * Handle option line *
1263 *************************************************/
1265 /* This function is called from several places to process a line containing the
1266 setting of an option. The first argument is the line to be decoded; it has been
1267 checked not to be empty and not to start with '#'. Trailing newlines and white
1268 space have been removed. The second argument is a pointer to the list of
1269 variable names that are to be recognized, together with their types and
1270 locations, and the third argument gives the number of entries in the list.
1272 The fourth argument is a pointer to a data block. If it is NULL, then the data
1273 values in the options list are absolute addresses. Otherwise, they are byte
1274 offsets in the data block.
1276 String option data may continue onto several lines; this function reads further
1277 data from config_file if necessary.
1279 The yield of this function is normally zero. If a string continues onto
1280 multiple lines, then the data value is permitted to be followed by a comma
1281 or a semicolon (for use in drivers) and the yield is that character.
1284 buffer contains the configuration line to be handled
1285 oltop points to the start of the relevant option list
1286 last one more than the offset of the last item in the option list
1287 data_block NULL when reading main options => data values in the option
1288 list are absolute addresses; otherwise they are byte offsets
1289 in data_block when they have opt_public set; otherwise
1290 they are byte offsets in data_block->options_block.
1291 unknown_txt format string to use in panic message for unknown option;
1292 must contain %s for option name
1293 if given as NULL, don't panic on unknown option
1295 Returns: TRUE if an option was read successfully,
1296 FALSE false for an unknown option if unknown_txt == NULL,
1297 otherwise panic and die on an unknown option
1301 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1302 void *data_block, uschar *unknown_txt)
1306 int n, count, type, value;
1310 BOOL boolvalue = TRUE;
1311 BOOL freesptr = TRUE;
1312 optionlist *ol, *ol2;
1316 uschar *inttype = US"";
1322 /* There may be leading spaces; thereafter, we expect an option name starting
1325 while (isspace(*s)) s++;
1327 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1329 /* Read the name of the option, and skip any subsequent white space. If
1330 it turns out that what we read was "hide", set the flag indicating that
1331 this is a secure option, and loop to read the next word. */
1333 for (n = 0; n < 2; n++)
1335 while (isalnum(*s) || *s == '_')
1337 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1341 while (isspace(*s)) s++;
1342 if (Ustrcmp(name, "hide") != 0) break;
1343 issecure = opt_secure;
1347 /* Deal with "no_" or "not_" here for booleans */
1349 if (Ustrncmp(name, "no_", 3) == 0)
1355 if (Ustrncmp(name, "not_", 4) == 0)
1361 /* Search the list for the given name. A non-existent name, or an option that
1362 is set twice, is a disaster. */
1364 ol = find_option(name + offset, oltop, last);
1368 if (unknown_txt == NULL) return FALSE;
1369 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1372 if ((ol->type & opt_set) != 0)
1374 uschar *mname = name;
1375 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1376 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1377 "\"%s\" option set for the second time", mname);
1380 ol->type |= opt_set | issecure;
1381 type = ol->type & opt_mask;
1383 /* Types with data values must be followed by '='; the "no[t]_" prefix
1384 applies only to boolean values. */
1386 if (type < opt_bool || type > opt_bool_last)
1389 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1390 "negation prefix applied to a non-boolean option");
1392 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1393 "unexpected end of line (data missing) after %s", name);
1395 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1398 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1399 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1400 ultimately expands to one of those values. */
1402 else if (*s != 0 && (offset != 0 || *s != '='))
1403 extra_chars_error(s, US"boolean option ", name, US"");
1405 /* Skip white space after = */
1407 if (*s == '=') while (isspace((*(++s))));
1409 /* If there is a data block and the opt_public flag is not set, change
1410 the data block pointer to the private options block. */
1412 if (data_block != NULL && (ol->type & opt_public) == 0)
1413 data_block = (void *)(((driver_instance *)data_block)->options_block);
1415 /* Now get the data according to the type. */
1419 /* If a string value is not enclosed in quotes, it consists of
1420 the rest of the current line, verbatim. Otherwise, string escapes
1423 A transport is specified as a string, which is then looked up in the
1424 list of transports. A search type is specified as one of a number of
1427 A set or rewrite rules for a driver is specified as a string, which is
1428 then parsed into a suitable chain of control blocks.
1430 Uids and gids are specified as strings which are then looked up in the
1431 passwd file. Lists of uids and gids are similarly specified as colon-
1432 separated strings. */
1437 case opt_expand_uid:
1438 case opt_expand_gid:
1443 reset_point = sptr = read_string(s, name);
1445 /* Having read a string, we now have several different ways of using it,
1446 depending on the data type, so do another switch. If keeping the actual
1447 string is not required (because it is interpreted), freesptr is set TRUE,
1448 and at the end we reset the pool. */
1452 /* If this was a string, set the variable to point to the new string,
1453 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1454 rules, we still keep the string (for printing), and parse the rules into a
1455 control block and flags word. */
1459 if (data_block == NULL)
1460 *((uschar **)(ol->value)) = sptr;
1462 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1464 if (type == opt_rewrite)
1469 rewrite_rule **chain;
1472 sprintf(CS name2, "*%.50s_rules", name);
1473 ol2 = find_option(name2, oltop, last);
1474 sprintf(CS name2, "*%.50s_flags", name);
1475 ol3 = find_option(name2, oltop, last);
1477 if (ol2 == NULL || ol3 == NULL)
1478 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1479 "rewrite rules not available for driver");
1481 if (data_block == NULL)
1483 chain = (rewrite_rule **)(ol2->value);
1484 flagptr = (int *)(ol3->value);
1488 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1489 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1492 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1495 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1497 chain = &(next->next);
1500 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1501 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1502 "non-header rewrite - not allowed at transport time -");
1506 /* If it was an expanded uid, see if there is any expansion to be
1507 done by checking for the presence of a $ character. If there is, save it
1508 in the corresponding *expand_user option field. Otherwise, fall through
1509 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1512 case opt_expand_uid:
1513 sprintf(CS name2, "*expand_%.50s", name);
1514 ol2 = find_option(name2, oltop, last);
1517 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1519 if (data_block == NULL)
1520 *((uschar **)(ol2->value)) = ss;
1522 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1526 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1532 /* Look up a fixed uid, and also make use of the corresponding gid
1533 if a passwd entry is returned and the gid has not been set. */
1536 if (!route_finduser(sptr, &pw, &uid))
1537 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1538 if (data_block == NULL)
1539 *((uid_t *)(ol->value)) = uid;
1541 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1543 /* Set the flag indicating a fixed value is set */
1545 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1547 /* Handle matching gid if we have a passwd entry: done by finding the
1548 same name with terminating "user" changed to "group"; if not found,
1549 ignore. Also ignore if the value is already set. */
1551 if (pw == NULL) break;
1552 Ustrcpy(name+Ustrlen(name)-4, "group");
1553 ol2 = find_option(name, oltop, last);
1554 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1555 (ol2->type & opt_mask) == opt_expand_gid))
1557 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1560 if (data_block == NULL)
1561 *((gid_t *)(ol2->value)) = pw->pw_gid;
1563 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1569 /* If it was an expanded gid, see if there is any expansion to be
1570 done by checking for the presence of a $ character. If there is, save it
1571 in the corresponding *expand_user option field. Otherwise, fall through
1572 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1575 case opt_expand_gid:
1576 sprintf(CS name2, "*expand_%.50s", name);
1577 ol2 = find_option(name2, oltop, last);
1580 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1582 if (data_block == NULL)
1583 *((uschar **)(ol2->value)) = ss;
1585 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1589 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1595 /* Handle freestanding gid */
1598 if (!route_findgroup(sptr, &gid))
1599 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1600 if (data_block == NULL)
1601 *((gid_t *)(ol->value)) = gid;
1603 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1604 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1607 /* If it was a uid list, look up each individual entry, and build
1608 a vector of uids, with a count in the first element. Put the vector
1609 in malloc store so we can free the string. (We are reading into
1610 permanent store already.) */
1619 if (*p != 0) count++;
1620 while (*p != 0) if (*p++ == ':') count++;
1621 list = store_malloc(count*sizeof(uid_t));
1622 list[ptr++] = (uid_t)(count - 1);
1624 if (data_block == NULL)
1625 *((uid_t **)(ol->value)) = list;
1627 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1633 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1634 if (!route_finduser(big_buffer, NULL, &uid))
1635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1642 /* If it was a gid list, look up each individual entry, and build
1643 a vector of gids, with a count in the first element. Put the vector
1644 in malloc store so we can free the string. (We are reading into permanent
1654 if (*p != 0) count++;
1655 while (*p != 0) if (*p++ == ':') count++;
1656 list = store_malloc(count*sizeof(gid_t));
1657 list[ptr++] = (gid_t)(count - 1);
1659 if (data_block == NULL)
1660 *((gid_t **)(ol->value)) = list;
1662 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1668 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1669 if (!route_findgroup(big_buffer, &gid))
1670 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1678 /* Release store if the value of the string doesn't need to be kept. */
1680 if (freesptr) store_reset(reset_point);
1683 /* Expanded boolean: if no characters follow, or if there are no dollar
1684 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1685 save the string for later expansion in the alternate place. */
1687 case opt_expand_bool:
1688 if (*s != 0 && Ustrchr(s, '$') != 0)
1690 sprintf(CS name2, "*expand_%.50s", name);
1691 ol2 = find_option(name2, oltop, last);
1694 reset_point = sptr = read_string(s, name);
1695 if (data_block == NULL)
1696 *((uschar **)(ol2->value)) = sptr;
1698 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1705 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1706 look for yes/not/true/false. Some booleans are stored in a single bit in
1707 a single int. There's a special fudge for verify settings; without a suffix
1708 they set both xx_sender and xx_recipient. The table points to the sender
1709 value; search subsequently for the recipient. There's another special case:
1710 opt_bool_set also notes when a boolean has been set. */
1714 case opt_bool_verify:
1718 s = readconf_readname(name2, 64, s);
1719 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1721 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1723 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1724 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1725 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1726 US"for boolean option ", name);
1729 /* Handle single-bit type. */
1731 if (type == opt_bit)
1733 int bit = 1 << ((ol->type >> 16) & 31);
1734 int *ptr = (data_block == NULL)?
1735 (int *)(ol->value) :
1736 (int *)((uschar *)data_block + (long int)ol->value);
1737 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1741 /* Handle full BOOL types */
1743 if (data_block == NULL)
1744 *((BOOL *)(ol->value)) = boolvalue;
1746 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1750 if (type == opt_bool_verify)
1752 sprintf(CS name2, "%.50s_recipient", name + offset);
1753 ol2 = find_option(name2, oltop, last);
1756 if (data_block == NULL)
1757 *((BOOL *)(ol2->value)) = boolvalue;
1759 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1763 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1765 else if (type == opt_bool_set)
1767 sprintf(CS name2, "*set_%.50s", name + offset);
1768 ol2 = find_option(name2, oltop, last);
1771 if (data_block == NULL)
1772 *((BOOL *)(ol2->value)) = TRUE;
1774 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1783 inttype = US"octal ";
1785 /* Integer: a simple(ish) case; allow octal and hex formats, and
1786 suffixes K and M. The different types affect output, not input. */
1793 value = strtol(CS s, CSS &endptr, intbase);
1796 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1799 if (errno != ERANGE)
1801 if (tolower(*endptr) == 'k')
1803 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1807 else if (tolower(*endptr) == 'm')
1809 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1811 else value *= 1024*1024;
1816 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1817 "absolute value of integer \"%s\" is too large (overflow)", s);
1819 while (isspace(*endptr)) endptr++;
1821 extra_chars_error(endptr, inttype, US"integer value for ", name);
1824 if (data_block == NULL)
1825 *((int *)(ol->value)) = value;
1827 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1830 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1837 value = strtol(CS s, CSS &endptr, intbase);
1840 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1843 if (errno != ERANGE)
1845 if (tolower(*endptr) == 'm')
1847 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1851 else if (tolower(*endptr) == 'k')
1857 value = (value + 512)/1024;
1861 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1862 "absolute value of integer \"%s\" is too large (overflow)", s);
1864 while (isspace(*endptr)) endptr++;
1866 extra_chars_error(endptr, inttype, US"integer value for ", name);
1869 if (data_block == NULL)
1870 *((int *)(ol->value)) = value;
1872 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1875 /* Fixed-point number: held to 3 decimal places. */
1878 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1879 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1880 "fixed-point number expected for %s", name);
1882 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1883 "integer \"%s\" is too large (overflow)", s);
1887 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1888 "integer \"%s\" is too large (overflow)", s);
1890 if (s[count] == '.')
1893 while (isdigit(s[++count]))
1895 value += (s[count] - '0') * d;
1900 while (isspace(s[count])) count++;
1903 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1905 if (data_block == NULL)
1906 *((int *)(ol->value)) = value;
1908 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1911 /* There's a special routine to read time values. */
1914 value = readconf_readtime(s, 0, FALSE);
1916 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1918 if (data_block == NULL)
1919 *((int *)(ol->value)) = value;
1921 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1924 /* A time list is a list of colon-separated times, with the first
1925 element holding the size of the list and the second the number of
1931 int *list = (data_block == NULL)?
1932 (int *)(ol->value) :
1933 (int *)((uschar *)data_block + (long int)(ol->value));
1935 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1938 uschar *snext = Ustrchr(s, ':');
1942 while (ss > s && isspace(ss[-1])) ss--;
1945 value = readconf_readtime(s, terminator, FALSE);
1947 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1949 if (count > 1 && value <= list[count])
1950 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1951 "time value out of order for %s", name);
1952 list[count+1] = value;
1953 if (snext == NULL) break;
1955 while (isspace(*s)) s++;
1958 if (count > list[0] - 2)
1959 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1961 if (count > 0 && list[2] == 0) count = 0;
1973 /*************************************************
1974 * Print a time value *
1975 *************************************************/
1978 Argument: a time value in seconds
1979 Returns: pointer to a fixed buffer containing the time as a string,
1980 in readconf_readtime() format
1984 readconf_printtime(int t)
1987 uschar *p = time_buffer;
1998 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
1999 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2000 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2001 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2002 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2009 /*************************************************
2010 * Print an individual option value *
2011 *************************************************/
2013 /* This is used by the -bP option, so prints to the standard output.
2014 The entire options list is passed in as an argument, because some options come
2015 in pairs - typically uid/gid settings, which can either be explicit numerical
2016 values, or strings to be expanded later. If the numerical value is unset,
2017 search for "*expand_<name>" to see if there is a string equivalent.
2020 ol option entry, or NULL for an unknown option
2022 options_block NULL for main configuration options; otherwise points to
2023 a driver block; if the option doesn't have opt_public
2024 set, then options_block->options_block is where the item
2026 oltop points to the option list in which ol exists
2027 last one more than the offset of the last entry in optop
2033 print_ol(optionlist *ol, uschar *name, void *options_block,
2034 optionlist *oltop, int last)
2047 printf("%s is not a known option\n", name);
2051 /* Non-admin callers cannot see options that have been flagged secure by the
2054 if (!admin_user && (ol->type & opt_secure) != 0)
2056 printf("%s = <value not displayable>\n", name);
2060 /* Else show the value of the option */
2063 if (options_block != NULL)
2065 if ((ol->type & opt_public) == 0)
2066 options_block = (void *)(((driver_instance *)options_block)->options_block);
2067 value = (void *)((uschar *)options_block + (long int)value);
2070 switch(ol->type & opt_mask)
2073 case opt_rewrite: /* Show the text value */
2074 s = *((uschar **)value);
2075 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2079 printf("%s = %d\n", name, *((int *)value));
2084 int x = *((int *)value);
2085 if (x != 0 && (x & 1023) == 0)
2089 if ((x & 1023) == 0)
2094 printf("%s = %d%c\n", name, x, c);
2096 else printf("%s = %d\n", name, x);
2102 int x = *((int *)value);
2103 if (x == 0) printf("%s = 0\n", name);
2104 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2105 else printf("%s = %dK\n", name, x);
2110 printf("%s = %#o\n", name, *((int *)value));
2113 /* Can be negative only when "unset", in which case integer */
2117 int x = *((int *)value);
2120 if (x < 0) printf("%s =\n", name); else
2122 printf("%s = %d.", name, x/1000);
2135 /* If the numerical value is unset, try for the string value */
2137 case opt_expand_uid:
2138 if (! *get_set_flag(name, oltop, last, options_block))
2140 sprintf(CS name2, "*expand_%.50s", name);
2141 ol2 = find_option(name2, oltop, last);
2144 void *value2 = ol2->value;
2145 if (options_block != NULL)
2146 value2 = (void *)((uschar *)options_block + (long int)value2);
2147 s = *((uschar **)value2);
2148 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2153 /* Else fall through */
2156 if (! *get_set_flag(name, oltop, last, options_block))
2157 printf("%s =\n", name);
2160 pw = getpwuid(*((uid_t *)value));
2162 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2163 else printf("%s = %s\n", name, pw->pw_name);
2167 /* If the numerical value is unset, try for the string value */
2169 case opt_expand_gid:
2170 if (! *get_set_flag(name, oltop, last, options_block))
2172 sprintf(CS name2, "*expand_%.50s", name);
2173 ol2 = find_option(name2, oltop, last);
2174 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2176 void *value2 = ol2->value;
2177 if (options_block != NULL)
2178 value2 = (void *)((uschar *)options_block + (long int)value2);
2179 s = *((uschar **)value2);
2180 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2185 /* Else fall through */
2188 if (! *get_set_flag(name, oltop, last, options_block))
2189 printf("%s =\n", name);
2192 gr = getgrgid(*((int *)value));
2194 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2195 else printf("%s = %s\n", name, gr->gr_name);
2200 uidlist = *((uid_t **)value);
2201 printf("%s =", name);
2202 if (uidlist != NULL)
2206 for (i = 1; i <= (int)(uidlist[0]); i++)
2208 uschar *name = NULL;
2209 pw = getpwuid(uidlist[i]);
2210 if (pw != NULL) name = US pw->pw_name;
2211 if (name != NULL) printf("%c%s", sep, name);
2212 else printf("%c%ld", sep, (long int)(uidlist[i]));
2220 gidlist = *((gid_t **)value);
2221 printf("%s =", name);
2222 if (gidlist != NULL)
2226 for (i = 1; i <= (int)(gidlist[0]); i++)
2228 uschar *name = NULL;
2229 gr = getgrgid(gidlist[i]);
2230 if (gr != NULL) name = US gr->gr_name;
2231 if (name != NULL) printf("%c%s", sep, name);
2232 else printf("%c%ld", sep, (long int)(gidlist[i]));
2240 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2246 int *list = (int *)value;
2247 printf("%s = ", name);
2248 for (i = 0; i < list[1]; i++)
2249 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2255 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2259 case opt_expand_bool:
2260 sprintf(CS name2, "*expand_%.50s", name);
2261 ol2 = find_option(name2, oltop, last);
2262 if (ol2 != NULL && ol2->value != NULL)
2264 void *value2 = ol2->value;
2265 if (options_block != NULL)
2266 value2 = (void *)((uschar *)options_block + (long int)value2);
2267 s = *((uschar **)value2);
2270 printf("%s = %s\n", name, string_printing(s));
2273 /* s == NULL => string not set; fall through */
2279 case opt_bool_verify:
2281 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2288 /*************************************************
2289 * Print value from main configuration *
2290 *************************************************/
2292 /* This function, called as a result of encountering the -bP option,
2293 causes the value of any main configuration variable to be output if the
2294 second argument is NULL. There are some special values:
2296 all print all main configuration options
2297 configure_file print the name of the configuration file
2298 routers print the routers' configurations
2299 transports print the transports' configuration
2300 authenticators print the authenticators' configuration
2301 router_list print a list of router names
2302 transport_list print a list of transport names
2303 authenticator_list print a list of authentication mechanism names
2304 +name print a named list item
2305 local_scan print the local_scan options
2307 If the second argument is not NULL, it must be one of "router", "transport", or
2308 "authenticator" in which case the first argument identifies the driver whose
2309 options are to be printed.
2312 name option name if type == NULL; else driver name
2313 type NULL or driver type name, as described above
2319 readconf_print(uschar *name, uschar *type)
2321 BOOL names_only = FALSE;
2323 optionlist *ol2 = NULL;
2324 driver_instance *d = NULL;
2334 static uschar *types[] = { US"address", US"domain", US"host",
2336 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2337 &hostlist_anchor, &localpartlist_anchor };
2339 for (i = 0; i < 4; i++)
2341 t = tree_search(*(anchors[i]), name+1);
2345 printf("%slist %s = %s\n", types[i], name+1,
2346 ((namedlist_block *)(t->data.ptr))->string);
2351 printf("no address, domain, host, or local part list called \"%s\" "
2352 "exists\n", name+1);
2357 if (Ustrcmp(name, "configure_file") == 0)
2359 printf("%s\n", CS config_main_filename);
2363 if (Ustrcmp(name, "all") == 0)
2365 for (ol = optionlist_config;
2366 ol < optionlist_config + optionlist_config_size; ol++)
2368 if ((ol->type & opt_hidden) == 0)
2369 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2374 if (Ustrcmp(name, "local_scan") == 0)
2376 #ifndef LOCAL_SCAN_HAS_OPTIONS
2377 printf("local_scan() options are not supported\n");
2379 for (ol = local_scan_options;
2380 ol < local_scan_options + local_scan_options_count; ol++)
2382 print_ol(ol, US ol->name, NULL, local_scan_options,
2383 local_scan_options_count);
2389 if (Ustrcmp(name, "routers") == 0)
2394 else if (Ustrcmp(name, "transports") == 0)
2396 type = US"transport";
2400 else if (Ustrcmp(name, "authenticators") == 0)
2402 type = US"authenticator";
2406 else if (Ustrcmp(name, "authenticator_list") == 0)
2408 type = US"authenticator";
2413 else if (Ustrcmp(name, "router_list") == 0)
2419 else if (Ustrcmp(name, "transport_list") == 0)
2421 type = US"transport";
2427 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2428 name, NULL, optionlist_config, optionlist_config_size);
2433 /* Handle the options for a router or transport. Skip options that are flagged
2434 as hidden. Some of these are options with names starting with '*', used for
2435 internal alternative representations of other options (which the printing
2436 function will sort out). Others are synonyms kept for backward compatibility.
2439 if (Ustrcmp(type, "router") == 0)
2441 d = (driver_instance *)routers;
2442 ol2 = optionlist_routers;
2443 size = optionlist_routers_size;
2445 else if (Ustrcmp(type, "transport") == 0)
2447 d = (driver_instance *)transports;
2448 ol2 = optionlist_transports;
2449 size = optionlist_transports_size;
2451 else if (Ustrcmp(type, "authenticator") == 0)
2453 d = (driver_instance *)auths;
2454 ol2 = optionlist_auths;
2455 size = optionlist_auths_size;
2460 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2464 /* Either search for a given driver, or print all of them */
2466 for (; d != NULL; d = d->next)
2469 printf("\n%s %s:\n", d->name, type);
2470 else if (Ustrcmp(d->name, name) != 0) continue;
2472 for (ol = ol2; ol < ol2 + size; ol++)
2474 if ((ol->type & opt_hidden) == 0)
2475 print_ol(ol, US ol->name, d, ol2, size);
2478 for (ol = d->info->options;
2479 ol < d->info->options + *(d->info->options_count); ol++)
2481 if ((ol->type & opt_hidden) == 0)
2482 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2484 if (name != NULL) return;
2486 if (name != NULL) printf("%s %s not found\n", type, name);
2491 /*************************************************
2492 * Read a named list item *
2493 *************************************************/
2495 /* This function reads a name and a list (i.e. string). The name is used to
2496 save the list in a tree, sorted by its name. Each entry also has a number,
2497 which can be used for caching tests, but if the string contains any expansion
2498 items other than $key, the number is set negative to inhibit caching. This
2499 mechanism is used for domain, host, and address lists that are referenced by
2503 anchorp points to the tree anchor
2504 numberp points to the current number for this tree
2505 max the maximum number permitted
2506 s the text of the option line, starting immediately after the name
2508 tname the name of the list type, for messages
2514 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2517 BOOL forcecache = FALSE;
2520 namedlist_block *nb = store_get(sizeof(namedlist_block));
2522 if (Ustrncmp(s, "_cache", 6) == 0)
2529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2531 if (*numberp >= max)
2532 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2535 while (isspace(*s)) s++;
2537 while (isalnum(*s) || *s == '_') s++;
2538 t = store_get(sizeof(tree_node) + s-ss);
2539 Ustrncpy(t->name, ss, s-ss);
2541 while (isspace(*s)) s++;
2543 if (!tree_insertnode(anchorp, t))
2544 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2545 "duplicate name \"%s\" for a named %s", t->name, tname);
2548 nb->number = *numberp;
2551 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2552 "missing '=' after \"%s\"", t->name);
2553 while (isspace(*s)) s++;
2554 nb->string = read_string(s, t->name);
2555 nb->cache_data = NULL;
2557 /* Check the string for any expansions; if any are found, mark this list
2558 uncacheable unless the user has explicited forced caching. */
2560 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2566 /*************************************************
2567 * Unpick data for a rate limit *
2568 *************************************************/
2570 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2574 s string, in the form t,b,f,l
2575 where t is the threshold (integer)
2576 b is the initial delay (time)
2577 f is the multiplicative factor (fixed point)
2578 k is the maximum time (time)
2579 threshold where to store threshold
2580 base where to store base in milliseconds
2581 factor where to store factor in milliseconds
2582 limit where to store limit
2584 Returns: nothing (panics on error)
2588 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2591 uschar bstring[16], lstring[16];
2593 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2594 factor, lstring) == 4)
2596 *base = readconf_readtime(bstring, 0, TRUE);
2597 *limit = readconf_readtime(lstring, 0, TRUE);
2598 if (*base >= 0 && *limit >= 0) return;
2600 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2606 /*************************************************
2607 * Read main configuration options *
2608 *************************************************/
2610 /* This function is the first to be called for configuration reading. It
2611 opens the configuration file and reads general configuration settings until
2612 it reaches the end of the configuration section. The file is then left open so
2613 that the remaining configuration data can subsequently be read if needed for
2616 The configuration file must be owned either by root or exim, and be writeable
2617 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2618 in the config file, so the test is done on the compiled in values. A slight
2619 anomaly, to be carefully documented.
2621 The name of the configuration file is taken from a list that is included in the
2622 binary of Exim. It can be altered from the command line, but if that is done,
2623 root privilege is immediately withdrawn unless the caller is root or exim.
2624 The first file on the list that exists is used.
2626 For use on multiple systems that share file systems, first look for a
2627 configuration file whose name has the current node name on the end. If that is
2628 not found, try the generic name. For really contorted configurations, that run
2629 multiple Exims with different uid settings, first try adding the effective uid
2630 before the node name. These complications are going to waste resources on most
2631 systems. Therefore they are available only when requested by compile-time
2638 struct stat statbuf;
2639 uschar *s, *filename;
2640 uschar *list = config_main_filelist;
2642 /* Loop through the possible file names */
2644 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2647 /* Cut out all the fancy processing unless specifically wanted */
2649 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2650 uschar *suffix = filename + Ustrlen(filename);
2652 /* Try for the node-specific file if a node name exists */
2654 #ifdef CONFIGURE_FILE_USE_NODE
2656 if (uname(&uts) >= 0)
2658 #ifdef CONFIGURE_FILE_USE_EUID
2659 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2660 config_file = Ufopen(filename, "rb");
2661 if (config_file == NULL)
2662 #endif /* CONFIGURE_FILE_USE_EUID */
2664 sprintf(CS suffix, ".%.256s", uts.nodename);
2665 config_file = Ufopen(filename, "rb");
2668 #endif /* CONFIGURE_FILE_USE_NODE */
2670 /* Otherwise, try the generic name, possibly with the euid added */
2672 #ifdef CONFIGURE_FILE_USE_EUID
2673 if (config_file == NULL)
2675 sprintf(CS suffix, ".%ld", (long int)original_euid);
2676 config_file = Ufopen(filename, "rb");
2678 #endif /* CONFIGURE_FILE_USE_EUID */
2680 /* Finally, try the unadorned name */
2682 if (config_file == NULL)
2685 config_file = Ufopen(filename, "rb");
2687 #else /* if neither defined */
2689 /* This is the common case when the fancy processing is not included. */
2691 config_file = Ufopen(filename, "rb");
2694 /* If the file does not exist, continue to try any others. For any other
2695 error, break out (and die). */
2697 if (config_file != NULL || errno != ENOENT) break;
2700 /* On success, save the name for verification; config_filename is used when
2701 logging configuration errors (it changes for .included files) whereas
2702 config_main_filename is the name shown by -bP. Failure to open a configuration
2703 file is a serious disaster. */
2705 if (config_file != NULL)
2707 config_filename = config_main_filename = string_copy(filename);
2711 if (filename == NULL)
2712 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2713 "%s", config_main_filelist);
2715 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2716 "configuration file %s", filename));
2719 /* Check the status of the file we have opened, unless it was specified on
2720 the command line, in which case privilege was given away at the start. */
2722 if (!config_changed)
2724 if (fstat(fileno(config_file), &statbuf) != 0)
2725 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2728 if ((statbuf.st_uid != root_uid && /* owner not root */
2729 statbuf.st_uid != exim_uid /* owner not exim */
2730 #ifdef CONFIGURE_OWNER
2731 && statbuf.st_uid != config_uid /* owner not the special one */
2734 (statbuf.st_gid != exim_gid /* group not exim & */
2735 #ifdef CONFIGURE_GROUP
2736 && statbuf.st_gid != config_gid /* group not the special one */
2738 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2740 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2742 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2743 "wrong owner, group, or mode", big_buffer);
2746 /* Process the main configuration settings. They all begin with a lower case
2747 letter. If we see something starting with an upper case letter, it is taken as
2748 a macro definition. */
2750 while ((s = get_config_line()) != NULL)
2752 if (isupper(s[0])) read_macro_assignment(s);
2754 else if (Ustrncmp(s, "domainlist", 10) == 0)
2755 read_named_list(&domainlist_anchor, &domainlist_count,
2756 MAX_NAMED_LIST, s+10, US"domain list");
2758 else if (Ustrncmp(s, "hostlist", 8) == 0)
2759 read_named_list(&hostlist_anchor, &hostlist_count,
2760 MAX_NAMED_LIST, s+8, US"host list");
2762 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2763 read_named_list(&addresslist_anchor, &addresslist_count,
2764 MAX_NAMED_LIST, s+11, US"address list");
2766 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2767 read_named_list(&localpartlist_anchor, &localpartlist_count,
2768 MAX_NAMED_LIST, s+13, US"local part list");
2771 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2772 NULL, US"main option \"%s\" unknown");
2776 /* If local_sender_retain is set, local_from_check must be unset. */
2778 if (local_sender_retain && local_from_check)
2779 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2780 "local_sender_retain are set; this combination is not allowed");
2782 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2785 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2787 /* remote_max_parallel must be > 0 */
2789 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2791 /* The primary host name may be required for expansion of spool_directory
2792 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2793 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2794 canonize it. Some people like upper case letters in their host names, so we
2795 don't force the case. */
2797 if (primary_hostname == NULL)
2801 if (uname(&uts) < 0)
2802 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2803 hostname = US uts.nodename;
2805 if (Ustrchr(hostname, '.') == NULL)
2808 struct hostent *hostdata;
2811 if (dns_ipv4_lookup == NULL ||
2812 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2822 #if HAVE_GETIPNODEBYNAME
2824 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2826 hostdata = gethostbyname2(CS hostname, af);
2829 hostdata = gethostbyname(CS hostname);
2832 if (hostdata != NULL)
2834 hostname = US hostdata->h_name;
2838 if (af == AF_INET) break;
2843 primary_hostname = string_copy(hostname);
2846 /* Set up default value for smtp_active_hostname */
2848 smtp_active_hostname = primary_hostname;
2850 /* If spool_directory wasn't set in the build-time configuration, it must have
2851 got set above. Of course, writing to the log may not work if log_file_path is
2852 not set, but it will at least get to syslog or somewhere, with any luck. */
2854 if (*spool_directory == 0)
2855 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2858 /* Expand the spool directory name; it may, for example, contain the primary
2859 host name. Same comment about failure. */
2861 s = expand_string(spool_directory);
2863 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2864 "\"%s\": %s", spool_directory, expand_string_message);
2865 spool_directory = s;
2867 /* Expand log_file_path, which must contain "%s" in any component that isn't
2868 the null string or "syslog". It is also allowed to contain one instance of %D.
2869 However, it must NOT contain % followed by anything else. */
2871 if (*log_file_path != 0)
2874 int sep = ':'; /* Fixed for log file path */
2875 s = expand_string(log_file_path);
2877 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2878 "\"%s\": %s", log_file_path, expand_string_message);
2881 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2884 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2885 t = Ustrstr(sss, "%s");
2887 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2888 "contain \"%%s\"", sss);
2890 t = Ustrchr(sss, '%');
2893 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2894 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2895 "unexpected \"%%\" character", s);
2902 /* Interpret syslog_facility into an integer argument for 'ident' param to
2903 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2906 if (syslog_facility_str != NULL)
2909 uschar *s = syslog_facility_str;
2911 if ((Ustrlen(syslog_facility_str) >= 4) &&
2912 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2915 for (i = 0; i < syslog_list_size; i++)
2917 if (strcmpic(s, syslog_list[i].name) == 0)
2919 syslog_facility = syslog_list[i].value;
2924 if (i >= syslog_list_size)
2926 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2927 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2931 /* Expand pid_file_path */
2933 if (*pid_file_path != 0)
2935 s = expand_string(pid_file_path);
2937 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2938 "\"%s\": %s", pid_file_path, expand_string_message);
2942 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2945 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2947 /* Unpick the SMTP rate limiting options, if set */
2949 if (smtp_ratelimit_mail != NULL)
2951 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2952 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
2955 if (smtp_ratelimit_rcpt != NULL)
2957 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
2958 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
2961 /* The qualify domains default to the primary host name */
2963 if (qualify_domain_sender == NULL)
2964 qualify_domain_sender = primary_hostname;
2965 if (qualify_domain_recipient == NULL)
2966 qualify_domain_recipient = qualify_domain_sender;
2968 /* Setting system_filter_user in the configuration sets the gid as well if a
2969 name is given, but a numerical value does not. */
2971 if (system_filter_uid_set && !system_filter_gid_set)
2973 struct passwd *pw = getpwuid(system_filter_uid);
2975 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
2976 (long int)system_filter_uid);
2977 system_filter_gid = pw->pw_gid;
2978 system_filter_gid_set = TRUE;
2981 /* If the errors_reply_to field is set, check that it is syntactically valid
2982 and ensure it contains a domain. */
2984 if (errors_reply_to != NULL)
2987 int start, end, domain;
2988 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
2989 &start, &end, &domain, FALSE);
2991 if (recipient == NULL)
2992 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2993 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
2996 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2997 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3000 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3001 smtp_accept_max must also be set. */
3003 if (smtp_accept_max == 0 &&
3004 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3005 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3006 "smtp_accept_max must be set if smtp_accept_queue or "
3007 "smtp_accept_max_per_host is set");
3009 /* Set up the host number if anything is specified. It is an expanded string
3010 so that it can be computed from the host name, for example. We do this last
3011 so as to ensure that everything else is set up before the expansion. */
3013 if (host_number_string != NULL)
3016 uschar *s = expand_string(host_number_string);
3017 long int n = Ustrtol(s, &end, 0);
3018 while (isspace(*end)) end++;
3020 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3021 "localhost_number value is not a number: %s", s);
3022 if (n > LOCALHOST_MAX)
3023 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3024 "localhost_number is greater than the maximum allowed value (%d)",
3030 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3032 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3033 tls_verify_certificates == NULL)
3034 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3035 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3036 (tls_verify_hosts != NULL)? "" : "try_");
3042 /*************************************************
3043 * Initialize one driver *
3044 *************************************************/
3046 /* This is called once the driver's generic options, if any, have been read.
3047 We can now find the driver, set up defaults for the private options, and
3048 unset any "set" bits in the private options table (which might have been
3049 set by another incarnation of the same driver).
3052 d pointer to driver instance block, with generic
3054 drivers_available vector of available drivers
3055 size_of_info size of each block in drivers_available
3056 class class of driver, for error message
3058 Returns: pointer to the driver info block
3061 static driver_info *
3062 init_driver(driver_instance *d, driver_info *drivers_available,
3063 int size_of_info, uschar *class)
3067 for (dd = drivers_available; dd->driver_name[0] != 0;
3068 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3070 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3073 int len = dd->options_len;
3075 d->options_block = store_get(len);
3076 memcpy(d->options_block, dd->options_block, len);
3077 for (i = 0; i < *(dd->options_count); i++)
3078 dd->options[i].type &= ~opt_set;
3083 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3084 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3086 return NULL; /* never obeyed */
3092 /*************************************************
3093 * Initialize driver list *
3094 *************************************************/
3096 /* This function is called for routers, transports, and authentication
3097 mechanisms. It reads the data from the current point in the configuration file
3098 up to the end of the section, and sets up a chain of instance blocks according
3099 to the file's contents. The file will already have been opened by a call to
3100 readconf_main, and must be left open for subsequent reading of further data.
3102 Any errors cause a panic crash. Note that the blocks with names driver_info and
3103 driver_instance must map the first portions of all the _info and _instance
3104 blocks for this shared code to work.
3107 class "router", "transport", or "authenticator"
3108 anchor &routers, &transports, &auths
3109 drivers_available available drivers
3110 size_of_info size of each info block
3111 instance_default points to default data for an instance
3112 instance_size size of instance block
3113 driver_optionlist generic option list
3114 driver_optionlist_count count of generic option list
3120 readconf_driver_init(
3122 driver_instance **anchor,
3123 driver_info *drivers_available,
3125 void *instance_default,
3127 optionlist *driver_optionlist,
3128 int driver_optionlist_count)
3130 driver_instance **p = anchor;
3131 driver_instance *d = NULL;
3134 while ((buffer = get_config_line()) != NULL)
3139 /* Read the first name on the line and test for the start of a new driver. A
3140 macro definition indicates the end of the previous driver. If this isn't the
3141 start of a new driver, the line will be re-read. */
3143 s = readconf_readname(name, sizeof(name), buffer);
3145 /* Handle macro definition, first finishing off the initialization of the
3146 previous driver, if any. */
3148 if (isupper(*name) && *s == '=')
3152 if (d->driver_name == NULL)
3153 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3154 "no driver defined for %s \"%s\"", class, d->name);
3158 read_macro_assignment(buffer);
3162 /* If the line starts with a name terminated by a colon, we are at the
3163 start of the definition of a new driver. The rest of the line must be
3170 /* Finish off initializing the previous driver. */
3174 if (d->driver_name == NULL)
3175 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3176 "no driver defined for %s \"%s\"", class, d->name);
3180 /* Check that we haven't already got a driver of this name */
3182 for (d = *anchor; d != NULL; d = d->next)
3183 if (Ustrcmp(name, d->name) == 0)
3184 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3185 "there are two %ss called \"%s\"", class, name);
3187 /* Set up a new driver instance data block on the chain, with
3188 its default values installed. */
3190 d = store_get(instance_size);
3191 memcpy(d, instance_default, instance_size);
3194 d->name = string_copy(name);
3196 /* Clear out the "set" bits in the generic options */
3198 for (i = 0; i < driver_optionlist_count; i++)
3199 driver_optionlist[i].type &= ~opt_set;
3201 /* Check nothing more on this line, then do the next loop iteration. */
3203 while (isspace(*s)) s++;
3204 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3208 /* Not the start of a new driver. Give an error if we have not set up a
3209 current driver yet. */
3211 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3212 "%s name missing", class);
3214 /* First look to see if this is a generic option; if it is "driver",
3215 initialize the driver. If is it not a generic option, we can look for a
3216 private option provided that the driver has been previously set up. */
3218 if (readconf_handle_option(buffer, driver_optionlist,
3219 driver_optionlist_count, d, NULL))
3221 if (d->info == NULL && d->driver_name != NULL)
3222 init_driver(d, drivers_available, size_of_info, class);
3225 /* Handle private options - pass the generic block because some may
3226 live therein. A flag with each option indicates if it is in the public
3229 else if (d->info != NULL)
3231 readconf_handle_option(buffer, d->info->options,
3232 *(d->info->options_count), d, US"option \"%s\" unknown");
3235 /* The option is not generic and the driver name has not yet been given. */
3237 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3238 "(\"driver\" must be specified before any private options)", name);
3241 /* Run the initialization function for the final driver. */
3245 if (d->driver_name == NULL)
3246 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3247 "no driver defined for %s \"%s\"", class, d->name);
3254 /*************************************************
3255 * Check driver dependency *
3256 *************************************************/
3258 /* This function is passed a driver instance and a string. It checks whether
3259 any of the string options for the driver contains the given string as an
3263 d points to a driver instance block
3264 s the string to search for
3266 Returns: TRUE if a dependency is found
3270 readconf_depends(driver_instance *d, uschar *s)
3272 int count = *(d->info->options_count);
3276 for (ol = d->info->options; ol < d->info->options + count; ol++)
3278 void *options_block;
3280 int type = ol->type & opt_mask;
3281 if (type != opt_stringptr) continue;
3282 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3283 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3284 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3286 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3287 isalnum(ss[Ustrlen(s)])) continue;
3288 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3289 d->name, ol->name, s);
3294 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3301 /*************************************************
3302 * Decode an error type for retries *
3303 *************************************************/
3305 /* This function is global because it is also called from the main
3306 program when testing retry information. It decodes strings such as "quota_7d"
3307 into numerical error codes.
3310 pp points to start of text
3311 p points past end of text
3312 basic_errno points to an int to receive the main error number
3313 more_errno points to an int to receive the secondary error data
3315 Returns: NULL if decoded correctly; else points to error text
3319 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3323 while (q < p && *q != '_') q++;
3326 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3328 *basic_errno = ERRNO_EXIMQUOTA;
3329 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3330 return US"bad time value";
3333 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3335 *basic_errno = ECONNREFUSED;
3338 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3339 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3340 else return US"A or MX expected after \"refused\"";
3344 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3346 *basic_errno = ETIMEDOUT;
3350 int xlen = p - q - 1;
3353 static uschar *extras[] =
3354 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3355 static int values[] =
3356 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3358 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3360 if (strncmpic(x, extras[i], xlen) == 0)
3362 *more_errno = values[i];
3367 if (i >= sizeof(extras)/sizeof(uschar *))
3369 if (strncmpic(x, US"DNS", xlen) == 0)
3371 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3372 "available in retry rules (it has never worked) - treated as "
3375 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3380 else if (strncmpic(pp, US"rcpt_4", 6) == 0)
3383 int x = 255; /* means "any 4xx code" */
3384 if (p != pp + 8) bad = TRUE; else
3386 int a = pp[6], b = pp[7];
3390 if (isdigit(b)) x += b - '0';
3391 else if (b == 'x') x += 100;
3394 else if (a != 'x' || b != 'x') bad = TRUE;
3397 if (bad) return US"rcpt_4 must be followed by xx, dx, or dd, where "
3398 "x is literal and d is any digit";
3400 *basic_errno = ERRNO_RCPT4XX;
3401 *more_errno = x << 8;
3404 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3405 strncmpic(q+1, US"failed", p-q-1) == 0)
3407 *basic_errno = ERRNO_AUTHFAIL;
3410 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3411 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3419 /*************************************************
3420 * Read retry information *
3421 *************************************************/
3423 /* Each line of retry information contains:
3425 . A domain name pattern or an address pattern;
3427 . An error name, possibly with additional data, or *;
3429 . An optional sequence of retry items, each consisting of an identifying
3430 letter, a cutoff time, and optional parameters.
3432 All this is decoded and placed into a control block. */
3435 /* Subroutine to read an argument, preceded by a comma and terminated
3436 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3437 1 = fixed point number (returned *1000).
3440 paddr pointer to pointer to current character; updated
3441 type 0 => read a time; 1 => read a fixed point number
3443 Returns: time in seconds or fixed point number * 1000
3447 retry_arg(uschar **paddr, int type)
3452 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3454 while (isspace(*p)) p++;
3456 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3458 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3459 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3465 return readconf_readtime(pp, *p, FALSE);
3467 return readconf_readfixed(pp, *p);
3469 return 0; /* Keep picky compilers happy */
3472 /* The function proper */
3475 readconf_retries(void)
3477 retry_config **chain = &retries;
3481 while ((p = get_config_line()) != NULL)
3483 retry_rule **rchain;
3486 next = store_get(sizeof(retry_config));
3489 chain = &(next->next);
3490 next->basic_errno = next->more_errno = 0;
3491 next->senders = NULL;
3493 rchain = &(next->rules);
3495 next->pattern = string_dequote(&p);
3496 while (isspace(*p)) p++;
3498 while (mac_isgraph(*p)) p++;
3499 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3500 "missing error type");
3502 /* Test error names for things we understand. */
3504 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3505 &(next->more_errno))) != NULL)
3506 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3508 /* There may be an optional address list of senders to be used as another
3509 constraint on the rule. This was added later, so the syntax is a bit of a
3510 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3513 while (isspace(*p)) p++;
3514 if (Ustrncmp(p, "senders", 7) == 0)
3517 while (isspace(*p)) p++;
3518 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3519 "\"=\" expected after \"senders\" in retry rule");
3520 while (isspace(*p)) p++;
3521 next->senders = string_dequote(&p);
3524 /* Now the retry rules. Keep the maximum timeout encountered. */
3526 while (isspace(*p)) p++;
3530 retry_rule *rule = store_get(sizeof(retry_rule));
3532 rchain = &(rule->next);
3534 rule->rule = toupper(*p++);
3535 rule->timeout = retry_arg(&p, 0);
3536 if (rule->timeout > retry_maximum_timeout)
3537 retry_maximum_timeout = rule->timeout;
3541 case 'F': /* Fixed interval */
3542 rule->p1 = retry_arg(&p, 0);
3545 case 'G': /* Geometrically increasing intervals */
3546 rule->p1 = retry_arg(&p, 0);
3547 rule->p2 = retry_arg(&p, 1);
3551 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3555 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3556 (rule->rule == 'G' && rule->p2 < 1000))
3557 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3558 "bad parameters for retry rule");
3560 while (isspace(*p)) p++;
3564 while (isspace(*p)) p++;
3567 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3574 /*************************************************
3575 * Initialize authenticators *
3576 *************************************************/
3578 /* Read the authenticators section of the configuration file.
3587 auth_instance *au, *bu;
3588 readconf_driver_init(US"authenticator",
3589 (driver_instance **)(&auths), /* chain anchor */
3590 (driver_info *)auths_available, /* available drivers */
3591 sizeof(auth_info), /* size of info block */
3592 &auth_defaults, /* default values for generic options */
3593 sizeof(auth_instance), /* size of instance block */
3594 optionlist_auths, /* generic options */
3595 optionlist_auths_size);
3597 for (au = auths; au != NULL; au = au->next)
3599 if (au->public_name == NULL)
3600 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3601 "the %s authenticator", au->name);
3602 for (bu = au->next; bu != NULL; bu = bu->next)
3604 if (strcmpic(au->public_name, bu->public_name) == 0)
3606 if ((au->client && bu->client) || (au->server && bu->server))
3607 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3608 "(%s and %s) have the same public name (%s)",
3609 (au->client)? US"client" : US"server", au->name, bu->name,
3619 /*************************************************
3620 * Read ACL information *
3621 *************************************************/
3623 /* If this run of Exim is not doing something that involves receiving a
3624 message, we can just skip over the ACL information. No need to parse it.
3626 First, we have a function for acl_read() to call back to get the next line. We
3627 need to remember the line we passed, because at the end it will contain the
3628 name of the next ACL. */
3630 static uschar *acl_line;
3635 acl_line = get_config_line();
3640 /* Now the main function:
3643 skip TRUE when this Exim process is doing something that will
3644 not need the ACL data
3650 readconf_acl(BOOL skip)
3654 /* Not receiving messages, don't need to parse the ACL data */
3658 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3659 while ((p = get_config_line()) != NULL);
3663 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3666 acl_line = get_config_line();
3668 while(acl_line != NULL)
3674 p = readconf_readname(name, sizeof(name), acl_line);
3675 if (isupper(*name) && *p == '=')
3677 read_macro_assignment(acl_line);
3678 acl_line = get_config_line();
3682 if (*p != ':' || name[0] == 0)
3683 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3685 node = store_get(sizeof(tree_node) + Ustrlen(name));
3686 Ustrcpy(node->name, name);
3687 if (!tree_insertnode(&acl_anchor, node))
3688 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3689 "there are two ACLs called \"%s\"", name);
3691 node->data.ptr = acl_read(acl_callback, &error);
3693 if (node->data.ptr == NULL && error != NULL)
3694 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3700 /*************************************************
3701 * Read configuration for local_scan() *
3702 *************************************************/
3704 /* This function is called after "begin local_scan" is encountered in the
3705 configuration file. If the local_scan() function allows for configuration
3706 options, we can process them. Otherwise, we expire in a panic.
3713 local_scan_init(void)
3715 #ifndef LOCAL_SCAN_HAS_OPTIONS
3716 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3717 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3721 while ((p = get_config_line()) != NULL)
3723 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3724 NULL, US"local_scan option \"%s\" unknown");
3731 /*************************************************
3732 * Read rest of configuration (after main) *
3733 *************************************************/
3735 /* This function reads the rest of the runtime configuration, after the main
3736 configuration. It is called only when actually needed. Each subsequent section
3737 of the configuration starts with a line of the form
3741 where the name is "routers", "transports", etc. A section is terminated by
3742 hitting the next "begin" line, and the next name is left in next_section.
3743 Because it may confuse people as to whether the names are singular or plural,
3744 we add "s" if it's missing. There is always enough room in next_section for
3745 this. This function is basically just a switch.
3748 skip_acl TRUE if ACL information is not needed
3753 static uschar *section_list[] = {
3763 readconf_rest(BOOL skip_acl)
3767 while(next_section[0] != 0)
3771 int last = sizeof(section_list) / sizeof(uschar *);
3773 int n = Ustrlen(next_section);
3775 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3779 int c = strcmpic(next_section, section_list[mid]);
3781 if (c > 0) first = mid + 1; else last = mid;
3783 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3784 "\"%.*s\" is not a known configuration section name", n, next_section);
3785 mid = (last + first)/2;
3789 if (((had ^= bit) & bit) == 0)
3790 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3791 "\"%.*s\" section is repeated in the configuration file", n,
3796 case 0: readconf_acl(skip_acl); break;
3797 case 1: auths_init(); break;
3798 case 2: local_scan_init(); break;
3799 case 3: readconf_retries(); break;
3800 case 4: readconf_rewrites(); break;
3801 case 5: route_init(); break;
3802 case 6: transport_init(); break;
3806 fclose(config_file);
3809 /* End of readconf.c */