1 /* $Cambridge: exim/src/src/readconf.c,v 1.6 2005/04/04 10:33:49 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_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
197 { "dns_retrans", opt_time, &dns_retrans },
198 { "dns_retry", opt_int, &dns_retry },
199 /* This option is now a no-op, retained for compability */
200 { "drop_cr", opt_bool, &drop_cr },
201 /*********************************************************/
202 { "envelope_to_remove", opt_bool, &envelope_to_remove },
203 { "errors_copy", opt_stringptr, &errors_copy },
204 { "errors_reply_to", opt_stringptr, &errors_reply_to },
205 { "exim_group", opt_gid, &exim_gid },
206 { "exim_path", opt_stringptr, &exim_path },
207 { "exim_user", opt_uid, &exim_uid },
208 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
209 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
210 { "finduser_retries", opt_int, &finduser_retries },
211 { "freeze_tell", opt_stringptr, &freeze_tell },
212 { "gecos_name", opt_stringptr, &gecos_name },
213 { "gecos_pattern", opt_stringptr, &gecos_pattern },
214 { "header_line_maxsize", opt_int, &header_line_maxsize },
215 { "header_maxsize", opt_int, &header_maxsize },
216 { "headers_charset", opt_stringptr, &headers_charset },
217 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
218 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
219 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
220 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
221 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
222 { "hold_domains", opt_stringptr, &hold_domains },
223 { "host_lookup", opt_stringptr, &host_lookup },
224 { "host_lookup_order", opt_stringptr, &host_lookup_order },
225 { "host_reject_connection", opt_stringptr, &host_reject_connection },
226 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
227 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
229 { "ibase_servers", opt_stringptr, &ibase_servers },
231 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
232 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
233 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
234 { "keep_malformed", opt_time, &keep_malformed },
236 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
237 { "ldap_version", opt_int, &eldap_version },
239 { "local_from_check", opt_bool, &local_from_check },
240 { "local_from_prefix", opt_stringptr, &local_from_prefix },
241 { "local_from_suffix", opt_stringptr, &local_from_suffix },
242 { "local_interfaces", opt_stringptr, &local_interfaces },
243 { "local_scan_timeout", opt_time, &local_scan_timeout },
244 { "local_sender_retain", opt_bool, &local_sender_retain },
245 { "localhost_number", opt_stringptr, &host_number_string },
246 { "log_file_path", opt_stringptr, &log_file_path },
247 { "log_selector", opt_stringptr, &log_selector_string },
248 { "log_timezone", opt_bool, &log_timezone },
249 { "lookup_open_max", opt_int, &lookup_open_max },
250 { "max_username_length", opt_int, &max_username_length },
251 { "message_body_visible", opt_mkint, &message_body_visible },
252 { "message_id_header_domain", opt_stringptr, &message_id_domain },
253 { "message_id_header_text", opt_stringptr, &message_id_text },
254 { "message_logs", opt_bool, &message_logs },
255 { "message_size_limit", opt_stringptr, &message_size_limit },
256 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
257 { "move_frozen_messages", opt_bool, &move_frozen_messages },
259 { "mua_wrapper", opt_bool, &mua_wrapper },
261 { "mysql_servers", opt_stringptr, &mysql_servers },
263 { "never_users", opt_uidlist, &never_users },
265 { "oracle_servers", opt_stringptr, &oracle_servers },
267 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
269 { "perl_at_start", opt_bool, &opt_perl_at_start },
270 { "perl_startup", opt_stringptr, &opt_perl_startup },
273 { "pgsql_servers", opt_stringptr, &pgsql_servers },
275 { "pid_file_path", opt_stringptr, &pid_file_path },
276 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
277 { "preserve_message_logs", opt_bool, &preserve_message_logs },
278 { "primary_hostname", opt_stringptr, &primary_hostname },
279 { "print_topbitchars", opt_bool, &print_topbitchars },
280 { "process_log_path", opt_stringptr, &process_log_path },
281 { "prod_requires_admin", opt_bool, &prod_requires_admin },
282 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
283 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
284 { "queue_domains", opt_stringptr, &queue_domains },
285 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
286 { "queue_only", opt_bool, &queue_only },
287 { "queue_only_file", opt_stringptr, &queue_only_file },
288 { "queue_only_load", opt_fixed, &queue_only_load },
289 { "queue_only_override", opt_bool, &queue_only_override },
290 { "queue_run_in_order", opt_bool, &queue_run_in_order },
291 { "queue_run_max", opt_int, &queue_run_max },
292 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
293 { "receive_timeout", opt_time, &receive_timeout },
294 { "received_header_text", opt_stringptr, &received_header_text },
295 { "received_headers_max", opt_int, &received_headers_max },
296 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
297 { "recipients_max", opt_int, &recipients_max },
298 { "recipients_max_reject", opt_bool, &recipients_max_reject },
299 { "remote_max_parallel", opt_int, &remote_max_parallel },
300 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
301 { "retry_data_expire", opt_time, &retry_data_expire },
302 { "retry_interval_max", opt_time, &retry_interval_max },
303 { "return_path_remove", opt_bool, &return_path_remove },
304 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
305 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
306 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
307 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
308 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
309 { "smtp_accept_max", opt_int, &smtp_accept_max },
310 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
311 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
312 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
313 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
314 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
315 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
316 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
317 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
318 { "smtp_banner", opt_stringptr, &smtp_banner },
319 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
320 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
321 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
322 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
323 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
324 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
325 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
326 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
327 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
328 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
329 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
330 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
331 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
332 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
333 #ifdef WITH_CONTENT_SCAN
334 { "spamd_address", opt_stringptr, &spamd_address },
336 { "split_spool_directory", opt_bool, &split_spool_directory },
337 { "spool_directory", opt_stringptr, &spool_directory },
338 #ifdef EXPERIMENTAL_SRS
339 { "srs_config", opt_stringptr, &srs_config },
341 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
342 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
343 { "syslog_duplication", opt_bool, &syslog_duplication },
344 { "syslog_facility", opt_stringptr, &syslog_facility_str },
345 { "syslog_processname", opt_stringptr, &syslog_processname },
346 { "syslog_timestamp", opt_bool, &syslog_timestamp },
347 { "system_filter", opt_stringptr, &system_filter },
348 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
349 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
350 { "system_filter_group", opt_gid, &system_filter_gid },
351 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
352 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
353 { "system_filter_user", opt_uid, &system_filter_uid },
354 { "tcp_nodelay", opt_bool, &tcp_nodelay },
355 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
356 { "timezone", opt_stringptr, &timezone_string },
358 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
359 { "tls_certificate", opt_stringptr, &tls_certificate },
360 { "tls_crl", opt_stringptr, &tls_crl },
361 { "tls_dhparam", opt_stringptr, &tls_dhparam },
362 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
363 { "tls_privatekey", opt_stringptr, &tls_privatekey },
364 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
365 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
366 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
367 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
368 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
370 { "trusted_groups", opt_gidlist, &trusted_groups },
371 { "trusted_users", opt_uidlist, &trusted_users },
372 { "unknown_login", opt_stringptr, &unknown_login },
373 { "unknown_username", opt_stringptr, &unknown_username },
374 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
375 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
376 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
377 { "warn_message_file", opt_stringptr, &warn_message_file },
378 { "write_rejectlog", opt_bool, &write_rejectlog }
381 static int optionlist_config_size =
382 sizeof(optionlist_config)/sizeof(optionlist);
386 /*************************************************
387 * Find the name of an option *
388 *************************************************/
390 /* This function is to aid debugging. Various functions take arguments that are
391 pointer variables in the options table or in option tables for various drivers.
392 For debugging output, it is useful to be able to find the name of the option
393 which is currently being processed. This function finds it, if it exists, by
394 searching the table(s).
396 Arguments: a value that is presumed to be in the table above
397 Returns: the option name, or an empty string
401 readconf_find_option(void *p)
405 transport_instance *t;
407 for (i = 0; i < optionlist_config_size; i++)
408 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
410 for (r = routers; r != NULL; r = r->next)
412 router_info *ri = r->info;
413 for (i = 0; i < ri->options_count[0]; i++)
415 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
416 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
417 return US ri->options[i].name;
421 for (t = transports; t != NULL; t = t->next)
423 transport_info *ti = t->info;
424 for (i = 0; i < ti->options_count[0]; i++)
426 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
427 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
428 return US ti->options[i].name;
439 /*************************************************
440 * Read configuration line *
441 *************************************************/
443 /* A logical line of text is read from the configuration file into the big
444 buffer, taking account of macros, .includes, and continuations. The size of
445 big_buffer is increased if necessary. The count of configuration lines is
446 maintained. Physical input lines starting with # (ignoring leading white space,
447 and after macro replacement) and empty logical lines are always ignored.
448 Leading and trailing spaces are removed.
450 If we hit a line of the form "begin xxxx", the xxxx is placed in the
451 next_section vector, and the function returns NULL, indicating the end of a
452 configuration section. On end-of-file, NULL is returned with next_section
457 Returns: a pointer to the first non-blank in the line,
458 or NULL if eof or end of section is reached
462 get_config_line(void)
464 int startoffset = 0; /* To first non-blank char in logical line */
465 int len = 0; /* Of logical line so far */
471 /* Loop for handling continuation lines, skipping comments, and dealing with
476 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
478 if (config_file_stack != NULL) /* EOF inside .include */
481 config_file = config_file_stack->file;
482 config_filename = config_file_stack->filename;
483 config_lineno = config_file_stack->lineno;
484 config_file_stack = config_file_stack->next;
488 /* EOF at top level */
490 if (cstate_stack_ptr >= 0)
491 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
492 "Unexpected end of configuration file: .endif missing");
494 if (len != 0) break; /* EOF after continuation */
495 next_section[0] = 0; /* EOF at start of logical line */
500 newlen = len + Ustrlen(big_buffer + len);
502 /* Handle pathologically long physical lines - yes, it did happen - by
503 extending big_buffer at this point. The code also copes with very long
506 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
509 big_buffer_size += BIG_BUFFER_SIZE;
510 newbuffer = store_malloc(big_buffer_size);
512 /* This use of strcpy is OK because we know that the string in the old
513 buffer is shorter than the new buffer. */
515 Ustrcpy(newbuffer, big_buffer);
516 store_free(big_buffer);
517 big_buffer = newbuffer;
518 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
520 newlen += Ustrlen(big_buffer + newlen);
523 /* Find the true start of the physical line - leading spaces are always
526 ss = big_buffer + len;
527 while (isspace(*ss)) ss++;
529 /* Process the physical line for macros. If this is the start of the logical
530 line, skip over initial text at the start of the line if it starts with an
531 upper case character followed by a sequence of name characters and an equals
532 sign, because that is the definition of a new macro, and we don't do
533 replacement therein. */
536 if (len == 0 && isupper(*s))
538 while (isalnum(*s) || *s == '_') s++;
539 while (isspace(*s)) s++;
540 if (*s != '=') s = ss; /* Not a macro definition */
543 /* For each defined macro, scan the line (from after XXX= if present),
544 replacing all occurrences of the macro. */
547 for (m = macros; m != NULL; m = m->next)
552 while ((p = Ustrstr(t, m->name)) != NULL)
555 int namelen = Ustrlen(m->name);
556 int replen = Ustrlen(m->replacement);
558 /* Expand the buffer if necessary */
560 while (newlen - namelen + replen + 1 > big_buffer_size)
562 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
563 uschar *newbuffer = store_malloc(newsize);
564 memcpy(newbuffer, big_buffer, newlen + 1);
565 p = newbuffer + (p - big_buffer);
566 s = newbuffer + (s - big_buffer);
567 ss = newbuffer + (ss - big_buffer);
568 t = newbuffer + (t - big_buffer);
569 big_buffer_size = newsize;
570 store_free(big_buffer);
571 big_buffer = newbuffer;
574 /* Shuffle the remaining characters up or down in the buffer before
575 copying in the replacement text. Don't rescan the replacement for this
579 moveby = replen - namelen;
582 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
585 Ustrncpy(p, m->replacement, replen);
591 /* An empty macro replacement at the start of a line could mean that ss no
592 longer points to the first non-blank character. */
594 while (isspace(*ss)) ss++;
596 /* Check for comment lines - these are physical lines. */
598 if (*ss == '#') continue;
600 /* Handle conditionals, which are also applied to physical lines. Conditions
601 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
602 expansion occured on the rest of the line. A preliminary test for the leading
603 '.' saves effort on most lines. */
609 /* Search the list of conditional directives */
611 for (i = 0; i < cond_list_size; i++)
614 cond_item *c = cond_list+i;
615 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
617 /* The following character must be white space or end of string */
619 n = ss[1 + c->namelen];
620 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
622 /* .ifdef and .ifndef push the current state onto the stack, then set
623 a new one from the table. Stack overflow is an error */
627 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
628 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
629 ".%s nested too deeply", c->name);
630 cstate_stack[++cstate_stack_ptr] = cstate;
631 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
634 /* For any of the others, stack underflow is an error. The next state
635 comes either from the stack (.endif) or from the table. */
639 if (cstate_stack_ptr < 0)
640 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
641 ".%s without matching .ifdef", c->name);
642 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
643 next_cstate[cstate][macro_found? c->action1 : c->action2];
646 /* Having dealt with a directive, break the loop */
651 /* If we have handled a conditional directive, continue with the next
652 physical line. Otherwise, fall through. */
654 if (i < cond_list_size) continue;
657 /* If the conditional state is not 0 (actively using these lines), ignore
660 if (cstate != 0) continue; /* Conditional skip */
662 /* Handle .include lines - these are also physical lines. */
664 if (Ustrncmp(ss, ".include", 8) == 0 &&
666 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
669 int include_if_exists = isspace(ss[8])? 0 : 10;
670 config_file_item *save;
673 ss += 9 + include_if_exists;
674 while (isspace(*ss)) ss++;
675 t = ss + Ustrlen(ss);
676 while (t > ss && isspace(t[-1])) t--;
677 if (*ss == '\"' && t[-1] == '\"')
684 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
686 save = store_get(sizeof(config_file_item));
687 save->next = config_file_stack;
688 config_file_stack = save;
689 save->file = config_file;
690 save->filename = config_filename;
691 save->lineno = config_lineno;
693 config_file = Ufopen(ss, "rb");
694 if (config_file == NULL)
695 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
696 "configuration file %s", ss);
697 config_filename = string_copy(ss);
702 /* If this is the start of the logical line, remember where the non-blank
703 data starts. Otherwise shuffle down continuation lines to remove leading
707 startoffset = ss - big_buffer;
710 s = big_buffer + len;
713 memmove(s, ss, (newlen - len) - (ss - s) + 1);
718 /* Accept the new addition to the line. Remove trailing white space. */
721 while (len > 0 && isspace(big_buffer[len-1])) len--;
724 /* We are done if the line does not end in backslash and contains some data.
725 Empty logical lines are ignored. For continuations, remove the backslash and
726 go round the loop to read the continuation line. */
730 if (big_buffer[len-1] != '\\') break; /* End of logical line */
731 big_buffer[--len] = 0; /* Remove backslash */
733 } /* Loop for reading multiple physical lines */
735 /* We now have a logical line. Test for the end of a configuration section (or,
736 more accurately, for the start of the next section). Place the name of the next
737 section in next_section, and return NULL. If the name given is longer than
738 next_section, truncate it. It will be unrecognized later, because all the known
739 section names do fit. Leave space for pluralizing. */
741 s = big_buffer + startoffset; /* First non-space character */
742 if (strncmpic(s, US"begin ", 6) == 0)
745 while (isspace(*s)) s++;
746 if (big_buffer + len - s > sizeof(next_section) - 2)
747 s[sizeof(next_section) - 2] = 0;
748 Ustrcpy(next_section, s);
752 /* Return the first non-blank character. */
759 /*************************************************
761 *************************************************/
763 /* The yield is the pointer to the next uschar. Names longer than the
764 output space are silently truncated. This function is also used from acl.c when
768 name where to put the name
772 Returns: new input pointer
776 readconf_readname(uschar *name, int len, uschar *s)
779 while (isspace(*s)) s++;
782 while (isalnum(*s) || *s == '_')
784 if (p < len-1) name[p++] = *s;
789 while (isspace(*s)) s++;
796 /*************************************************
797 * Read a time value *
798 *************************************************/
800 /* This function is also called from outside, to read argument
801 time values. The format of a time value is:
803 [<n>w][<n>d][<n>h][<n>m][<n>s]
805 as long as at least one is present. If a format error is encountered,
806 return a negative value. The value must be terminated by the given
811 terminator required terminating character
812 return_msec if TRUE, allow fractional seconds and return milliseconds
814 Returns: the time value, or -1 on syntax error
815 value is seconds if return_msec is FALSE
816 value is milliseconds if return_msec is TRUE
820 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
828 if (!isdigit(*s)) return -1;
829 (void)sscanf(CS s, "%d%n", &value, &count);
834 case 'w': value *= 7;
835 case 'd': value *= 24;
836 case 'h': value *= 60;
837 case 'm': value *= 60;
842 if (!return_msec) return -1;
843 (void)sscanf(CS s, "%lf%n", &fraction, &count);
845 if (*s++ != 's') return -1;
846 yield += (int)(fraction * 1000.0);
852 if (return_msec) value *= 1000;
854 if (*s == terminator) return yield;
856 /* Control never reaches here. */
861 /*************************************************
862 * Read a fixed point value *
863 *************************************************/
865 /* The value is returned *1000
869 terminator required terminator
871 Returns: the value, or -1 on error
875 readconf_readfixed(uschar *s, int terminator)
879 if (!isdigit(*s)) return -1;
880 (void)sscanf(CS s, "%d%n", &value, &count);
882 yield = value * 1000;
886 while (isdigit((*(++s))))
888 yield += (*s - '0') * m;
893 return (*s == terminator)? yield : (-1);
898 /*************************************************
899 * Find option in list *
900 *************************************************/
902 /* The lists are always in order, so binary chop can be used.
905 name the option name to search for
906 ol the first entry in the option list
907 last one more than the offset of the last entry in the option list
909 Returns: pointer to an option entry, or NULL if not found
913 find_option(uschar *name, optionlist *ol, int last)
918 int middle = (first + last)/2;
919 int c = Ustrcmp(name, ol[middle].name);
920 if (c == 0) return ol + middle;
921 else if (c > 0) first = middle + 1;
929 /*************************************************
930 * Find a set flag in option list *
931 *************************************************/
933 /* Because some versions of Unix make no restrictions on the values of uids and
934 gids (even negative ones), we cannot represent "unset" by a special value.
935 There is therefore a separate boolean variable for each one indicating whether
936 a value is set or not. This function returns a pointer to the boolean, given
937 the original option name. It is a major disaster if the flag cannot be found.
940 name the name of the uid or gid option
941 oltop points to the start of the relevant option list
942 last one more than the offset of the last item in the option list
943 data_block NULL when reading main options => data values in the option
944 list are absolute addresses; otherwise they are byte offsets
945 in data_block (used for driver options)
947 Returns: a pointer to the boolean flag.
951 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
955 sprintf(CS name2, "*set_%.50s", name);
956 ol = find_option(name2, oltop, last);
957 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
958 "Exim internal error: missing set flag for %s", name);
959 return (data_block == NULL)? (BOOL *)(ol->value) :
960 (BOOL *)((uschar *)data_block + (long int)(ol->value));
966 /*************************************************
967 * Output extra characters message and die *
968 *************************************************/
970 /* Called when an option line has junk on the end. Sometimes this is because
971 the sysadmin thinks comments are permitted.
974 s points to the extra characters
975 t1..t3 strings to insert in the log message
977 Returns: doesn't return; dies
981 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
983 uschar *comment = US"";
984 if (*s == '#') comment = US" (# is comment only at line start)";
985 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
986 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
991 /*************************************************
992 * Read rewrite information *
993 *************************************************/
995 /* Each line of rewrite information contains:
997 . A complete address in the form user@domain, possibly with
998 leading * for each part; or alternatively, a regex.
1000 . A replacement string (which will be expanded).
1002 . An optional sequence of one-letter flags, indicating which
1003 headers etc. to apply this rule to.
1005 All this is decoded and placed into a control block. The OR of the flags is
1006 maintained in a common word.
1009 p points to the string that makes up the rule
1010 existflags points to the overall flag word
1011 isglobal TRUE if reading global rewrite rules
1013 Returns: the control block for the parsed rule.
1016 static rewrite_rule *
1017 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1019 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1022 next->key = string_dequote(&p);
1024 while (isspace(*p)) p++;
1026 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1027 "missing rewrite replacement string");
1030 next->replacement = string_dequote(&p);
1032 while (*p != 0) switch (*p++)
1034 case ' ': case '\t': break;
1036 case 'q': next->flags |= rewrite_quit; break;
1037 case 'w': next->flags |= rewrite_whole; break;
1039 case 'h': next->flags |= rewrite_all_headers; break;
1040 case 's': next->flags |= rewrite_sender; break;
1041 case 'f': next->flags |= rewrite_from; break;
1042 case 't': next->flags |= rewrite_to; break;
1043 case 'c': next->flags |= rewrite_cc; break;
1044 case 'b': next->flags |= rewrite_bcc; break;
1045 case 'r': next->flags |= rewrite_replyto; break;
1047 case 'E': next->flags |= rewrite_all_envelope; break;
1048 case 'F': next->flags |= rewrite_envfrom; break;
1049 case 'T': next->flags |= rewrite_envto; break;
1051 case 'Q': next->flags |= rewrite_qualify; break;
1052 case 'R': next->flags |= rewrite_repeat; break;
1055 next->flags |= rewrite_smtp;
1056 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1057 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1058 "rewrite rule has the S flag but is not a regular expression");
1062 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1063 "unknown rewrite flag character '%c' "
1064 "(could be missing quotes round replacement item)", p[-1]);
1068 /* If no action flags are set, set all the "normal" rewrites. */
1070 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1071 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1073 /* Remember which exist, for optimization, and return the rule */
1075 *existflags |= next->flags;
1082 /*************************************************
1083 * Read global rewrite information *
1084 *************************************************/
1086 /* Each line is a single rewrite rule; it is parsed into a control block
1087 by readconf_one_rewrite(), and its flags are ORed into the global flag
1088 word rewrite_existflags. */
1091 readconf_rewrites(void)
1093 rewrite_rule **chain = &global_rewrite_rules;
1096 while ((p = get_config_line()) != NULL)
1098 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1100 chain = &(next->next);
1106 /*************************************************
1108 *************************************************/
1110 /* Strings are read into the normal store pool. As long we aren't too
1111 near the end of the current block, the string will just use what is necessary
1112 on the top of the stacking pool, because string_cat() uses the extension
1116 s the rest of the input line
1117 name the option name (for errors)
1119 Returns: pointer to the string
1123 read_string(uschar *s, uschar *name)
1128 if (*s != '\"') return string_copy(s);
1131 yield = string_dequote(&s);
1133 if (s == ss+1 || s[-1] != '\"')
1134 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1135 "missing quote at end of string value for %s", name);
1137 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1143 /*************************************************
1144 * Handle option line *
1145 *************************************************/
1147 /* This function is called from several places to process a line containing the
1148 setting of an option. The first argument is the line to be decoded; it has been
1149 checked not to be empty and not to start with '#'. Trailing newlines and white
1150 space have been removed. The second argument is a pointer to the list of
1151 variable names that are to be recognized, together with their types and
1152 locations, and the third argument gives the number of entries in the list.
1154 The fourth argument is a pointer to a data block. If it is NULL, then the data
1155 values in the options list are absolute addresses. Otherwise, they are byte
1156 offsets in the data block.
1158 String option data may continue onto several lines; this function reads further
1159 data from config_file if necessary.
1161 The yield of this function is normally zero. If a string continues onto
1162 multiple lines, then the data value is permitted to be followed by a comma
1163 or a semicolon (for use in drivers) and the yield is that character.
1166 buffer contains the configuration line to be handled
1167 oltop points to the start of the relevant option list
1168 last one more than the offset of the last item in the option list
1169 data_block NULL when reading main options => data values in the option
1170 list are absolute addresses; otherwise they are byte offsets
1171 in data_block when they have opt_public set; otherwise
1172 they are byte offsets in data_block->options_block.
1173 unknown_txt format string to use in panic message for unknown option;
1174 must contain %s for option name
1175 if given as NULL, don't panic on unknown option
1177 Returns: TRUE if an option was read successfully,
1178 FALSE false for an unknown option if unknown_txt == NULL,
1179 otherwise panic and die on an unknown option
1183 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1184 void *data_block, uschar *unknown_txt)
1188 int n, count, type, value;
1192 BOOL boolvalue = TRUE;
1193 BOOL freesptr = TRUE;
1194 optionlist *ol, *ol2;
1198 uschar *inttype = US"";
1204 /* There may be leading spaces; thereafter, we expect an option name starting
1207 while (isspace(*s)) s++;
1209 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1211 /* Read the name of the option, and skip any subsequent white space. If
1212 it turns out that what we read was "hide", set the flag indicating that
1213 this is a secure option, and loop to read the next word. */
1215 for (n = 0; n < 2; n++)
1217 while (isalnum(*s) || *s == '_')
1219 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1223 while (isspace(*s)) s++;
1224 if (Ustrcmp(name, "hide") != 0) break;
1225 issecure = opt_secure;
1229 /* Deal with "no_" or "not_" here for booleans */
1231 if (Ustrncmp(name, "no_", 3) == 0)
1237 if (Ustrncmp(name, "not_", 4) == 0)
1243 /* Search the list for the given name. A non-existent name, or an option that
1244 is set twice, is a disaster. */
1246 ol = find_option(name + offset, oltop, last);
1250 if (unknown_txt == NULL) return FALSE;
1251 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1254 if ((ol->type & opt_set) != 0)
1256 uschar *mname = name;
1257 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1258 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1259 "\"%s\" option set for the second time", mname);
1262 ol->type |= opt_set | issecure;
1263 type = ol->type & opt_mask;
1265 /* Types with data values must be followed by '='; the "no[t]_" prefix
1266 applies only to boolean values. */
1268 if (type < opt_bool || type > opt_bool_last)
1271 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1272 "negation prefix applied to a non-boolean option");
1274 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1275 "unexpected end of line (data missing) after %s", name);
1277 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1280 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1281 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1282 ultimately expands to one of those values. */
1284 else if (*s != 0 && (offset != 0 || *s != '='))
1285 extra_chars_error(s, US"boolean option ", name, US"");
1287 /* Skip white space after = */
1289 if (*s == '=') while (isspace((*(++s))));
1291 /* If there is a data block and the opt_public flag is not set, change
1292 the data block pointer to the private options block. */
1294 if (data_block != NULL && (ol->type & opt_public) == 0)
1295 data_block = (void *)(((driver_instance *)data_block)->options_block);
1297 /* Now get the data according to the type. */
1301 /* If a string value is not enclosed in quotes, it consists of
1302 the rest of the current line, verbatim. Otherwise, string escapes
1305 A transport is specified as a string, which is then looked up in the
1306 list of transports. A search type is specified as one of a number of
1309 A set or rewrite rules for a driver is specified as a string, which is
1310 then parsed into a suitable chain of control blocks.
1312 Uids and gids are specified as strings which are then looked up in the
1313 passwd file. Lists of uids and gids are similarly specified as colon-
1314 separated strings. */
1319 case opt_expand_uid:
1320 case opt_expand_gid:
1325 reset_point = sptr = read_string(s, name);
1327 /* Having read a string, we now have several different ways of using it,
1328 depending on the data type, so do another switch. If keeping the actual
1329 string is not required (because it is interpreted), freesptr is set TRUE,
1330 and at the end we reset the pool. */
1334 /* If this was a string, set the variable to point to the new string,
1335 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1336 rules, we still keep the string (for printing), and parse the rules into a
1337 control block and flags word. */
1341 if (data_block == NULL)
1342 *((uschar **)(ol->value)) = sptr;
1344 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1346 if (type == opt_rewrite)
1351 rewrite_rule **chain;
1354 sprintf(CS name2, "*%.50s_rules", name);
1355 ol2 = find_option(name2, oltop, last);
1356 sprintf(CS name2, "*%.50s_flags", name);
1357 ol3 = find_option(name2, oltop, last);
1359 if (ol2 == NULL || ol3 == NULL)
1360 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1361 "rewrite rules not available for driver");
1363 if (data_block == NULL)
1365 chain = (rewrite_rule **)(ol2->value);
1366 flagptr = (int *)(ol3->value);
1370 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1371 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1374 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1377 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1379 chain = &(next->next);
1382 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1383 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1384 "non-header rewrite - not allowed at transport time -");
1388 /* If it was an expanded uid, see if there is any expansion to be
1389 done by checking for the presence of a $ character. If there is, save it
1390 in the corresponding *expand_user option field. Otherwise, fall through
1391 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1394 case opt_expand_uid:
1395 sprintf(CS name2, "*expand_%.50s", name);
1396 ol2 = find_option(name2, oltop, last);
1399 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1401 if (data_block == NULL)
1402 *((uschar **)(ol2->value)) = ss;
1404 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1408 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1414 /* Look up a fixed uid, and also make use of the corresponding gid
1415 if a passwd entry is returned and the gid has not been set. */
1418 if (!route_finduser(sptr, &pw, &uid))
1419 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1420 if (data_block == NULL)
1421 *((uid_t *)(ol->value)) = uid;
1423 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1425 /* Set the flag indicating a fixed value is set */
1427 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1429 /* Handle matching gid if we have a passwd entry: done by finding the
1430 same name with terminating "user" changed to "group"; if not found,
1431 ignore. Also ignore if the value is already set. */
1433 if (pw == NULL) break;
1434 Ustrcpy(name+Ustrlen(name)-4, "group");
1435 ol2 = find_option(name, oltop, last);
1436 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1437 (ol2->type & opt_mask) == opt_expand_gid))
1439 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1442 if (data_block == NULL)
1443 *((gid_t *)(ol2->value)) = pw->pw_gid;
1445 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1451 /* If it was an expanded gid, see if there is any expansion to be
1452 done by checking for the presence of a $ character. If there is, save it
1453 in the corresponding *expand_user option field. Otherwise, fall through
1454 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1457 case opt_expand_gid:
1458 sprintf(CS name2, "*expand_%.50s", name);
1459 ol2 = find_option(name2, oltop, last);
1462 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1464 if (data_block == NULL)
1465 *((uschar **)(ol2->value)) = ss;
1467 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1471 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1477 /* Handle freestanding gid */
1480 if (!route_findgroup(sptr, &gid))
1481 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1482 if (data_block == NULL)
1483 *((gid_t *)(ol->value)) = gid;
1485 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1486 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1489 /* If it was a uid list, look up each individual entry, and build
1490 a vector of uids, with a count in the first element. Put the vector
1491 in malloc store so we can free the string. (We are reading into
1492 permanent store already.) */
1501 if (*p != 0) count++;
1502 while (*p != 0) if (*p++ == ':') count++;
1503 list = store_malloc(count*sizeof(uid_t));
1504 list[ptr++] = (uid_t)(count - 1);
1506 if (data_block == NULL)
1507 *((uid_t **)(ol->value)) = list;
1509 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1515 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1516 if (!route_finduser(big_buffer, NULL, &uid))
1517 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1524 /* If it was a gid list, look up each individual entry, and build
1525 a vector of gids, with a count in the first element. Put the vector
1526 in malloc store so we can free the string. (We are reading into permanent
1536 if (*p != 0) count++;
1537 while (*p != 0) if (*p++ == ':') count++;
1538 list = store_malloc(count*sizeof(gid_t));
1539 list[ptr++] = (gid_t)(count - 1);
1541 if (data_block == NULL)
1542 *((gid_t **)(ol->value)) = list;
1544 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1550 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1551 if (!route_findgroup(big_buffer, &gid))
1552 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1560 /* Release store if the value of the string doesn't need to be kept. */
1562 if (freesptr) store_reset(reset_point);
1565 /* Expanded boolean: if no characters follow, or if there are no dollar
1566 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1567 save the string for later expansion in the alternate place. */
1569 case opt_expand_bool:
1570 if (*s != 0 && Ustrchr(s, '$') != 0)
1572 sprintf(CS name2, "*expand_%.50s", name);
1573 ol2 = find_option(name2, oltop, last);
1576 reset_point = sptr = read_string(s, name);
1577 if (data_block == NULL)
1578 *((uschar **)(ol2->value)) = sptr;
1580 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1587 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1588 look for yes/not/true/false. Some booleans are stored in a single bit in
1589 a single int. There's a special fudge for verify settings; without a suffix
1590 they set both xx_sender and xx_recipient. The table points to the sender
1591 value; search subsequently for the recipient. There's another special case:
1592 opt_bool_set also notes when a boolean has been set. */
1596 case opt_bool_verify:
1600 s = readconf_readname(name2, 64, s);
1601 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1603 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1605 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1606 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1607 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1608 US"for boolean option ", name);
1611 /* Handle single-bit type. */
1613 if (type == opt_bit)
1615 int bit = 1 << ((ol->type >> 16) & 31);
1616 int *ptr = (data_block == NULL)?
1617 (int *)(ol->value) :
1618 (int *)((uschar *)data_block + (long int)ol->value);
1619 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1623 /* Handle full BOOL types */
1625 if (data_block == NULL)
1626 *((BOOL *)(ol->value)) = boolvalue;
1628 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1632 if (type == opt_bool_verify)
1634 sprintf(CS name2, "%.50s_recipient", name + offset);
1635 ol2 = find_option(name2, oltop, last);
1638 if (data_block == NULL)
1639 *((BOOL *)(ol2->value)) = boolvalue;
1641 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1645 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1647 else if (type == opt_bool_set)
1649 sprintf(CS name2, "*set_%.50s", name + offset);
1650 ol2 = find_option(name2, oltop, last);
1653 if (data_block == NULL)
1654 *((BOOL *)(ol2->value)) = TRUE;
1656 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1665 inttype = US"octal ";
1667 /* Integer: a simple(ish) case; allow octal and hex formats, and
1668 suffixes K and M. The different types affect output, not input. */
1675 value = strtol(CS s, CSS &endptr, intbase);
1678 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1681 if (errno != ERANGE)
1683 if (tolower(*endptr) == 'k')
1685 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1689 else if (tolower(*endptr) == 'm')
1691 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1693 else value *= 1024*1024;
1698 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1699 "absolute value of integer \"%s\" is too large (overflow)", s);
1701 while (isspace(*endptr)) endptr++;
1703 extra_chars_error(endptr, inttype, US"integer value for ", name);
1706 if (data_block == NULL)
1707 *((int *)(ol->value)) = value;
1709 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1712 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1719 value = strtol(CS s, CSS &endptr, intbase);
1722 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1725 if (errno != ERANGE)
1727 if (tolower(*endptr) == 'm')
1729 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1733 else if (tolower(*endptr) == 'k')
1739 value = (value + 512)/1024;
1743 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1744 "absolute value of integer \"%s\" is too large (overflow)", s);
1746 while (isspace(*endptr)) endptr++;
1748 extra_chars_error(endptr, inttype, US"integer value for ", name);
1751 if (data_block == NULL)
1752 *((int *)(ol->value)) = value;
1754 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1757 /* Fixed-point number: held to 3 decimal places. */
1760 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1762 "fixed-point number expected for %s", name);
1764 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1765 "integer \"%s\" is too large (overflow)", s);
1769 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1770 "integer \"%s\" is too large (overflow)", s);
1772 if (s[count] == '.')
1775 while (isdigit(s[++count]))
1777 value += (s[count] - '0') * d;
1782 while (isspace(s[count])) count++;
1785 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1787 if (data_block == NULL)
1788 *((int *)(ol->value)) = value;
1790 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1793 /* There's a special routine to read time values. */
1796 value = readconf_readtime(s, 0, FALSE);
1798 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1800 if (data_block == NULL)
1801 *((int *)(ol->value)) = value;
1803 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1806 /* A time list is a list of colon-separated times, with the first
1807 element holding the size of the list and the second the number of
1813 int *list = (data_block == NULL)?
1814 (int *)(ol->value) :
1815 (int *)((uschar *)data_block + (long int)(ol->value));
1817 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1820 uschar *snext = Ustrchr(s, ':');
1824 while (ss > s && isspace(ss[-1])) ss--;
1827 value = readconf_readtime(s, terminator, FALSE);
1829 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1831 if (count > 1 && value <= list[count])
1832 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1833 "time value out of order for %s", name);
1834 list[count+1] = value;
1835 if (snext == NULL) break;
1837 while (isspace(*s)) s++;
1840 if (count > list[0] - 2)
1841 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1843 if (count > 0 && list[2] == 0) count = 0;
1855 /*************************************************
1856 * Print a time value *
1857 *************************************************/
1860 Argument: a time value in seconds
1861 Returns: pointer to a fixed buffer containing the time as a string,
1862 in readconf_readtime() format
1866 readconf_printtime(int t)
1869 uschar *p = time_buffer;
1880 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
1881 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
1882 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
1883 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
1884 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
1891 /*************************************************
1892 * Print an individual option value *
1893 *************************************************/
1895 /* This is used by the -bP option, so prints to the standard output.
1896 The entire options list is passed in as an argument, because some options come
1897 in pairs - typically uid/gid settings, which can either be explicit numerical
1898 values, or strings to be expanded later. If the numerical value is unset,
1899 search for "*expand_<name>" to see if there is a string equivalent.
1902 ol option entry, or NULL for an unknown option
1904 options_block NULL for main configuration options; otherwise points to
1905 a driver block; if the option doesn't have opt_public
1906 set, then options_block->options_block is where the item
1908 oltop points to the option list in which ol exists
1909 last one more than the offset of the last entry in optop
1915 print_ol(optionlist *ol, uschar *name, void *options_block,
1916 optionlist *oltop, int last)
1929 printf("%s is not a known option\n", name);
1933 /* Non-admin callers cannot see options that have been flagged secure by the
1936 if (!admin_user && (ol->type & opt_secure) != 0)
1938 printf("%s = <value not displayable>\n", name);
1942 /* Else show the value of the option */
1945 if (options_block != NULL)
1947 if ((ol->type & opt_public) == 0)
1948 options_block = (void *)(((driver_instance *)options_block)->options_block);
1949 value = (void *)((uschar *)options_block + (long int)value);
1952 switch(ol->type & opt_mask)
1955 case opt_rewrite: /* Show the text value */
1956 s = *((uschar **)value);
1957 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
1961 printf("%s = %d\n", name, *((int *)value));
1966 int x = *((int *)value);
1967 if (x != 0 && (x & 1023) == 0)
1971 if ((x & 1023) == 0)
1976 printf("%s = %d%c\n", name, x, c);
1978 else printf("%s = %d\n", name, x);
1984 int x = *((int *)value);
1985 if (x == 0) printf("%s = 0\n", name);
1986 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
1987 else printf("%s = %dK\n", name, x);
1992 printf("%s = %#o\n", name, *((int *)value));
1995 /* Can be negative only when "unset", in which case integer */
1999 int x = *((int *)value);
2002 if (x < 0) printf("%s =\n", name); else
2004 printf("%s = %d.", name, x/1000);
2017 /* If the numerical value is unset, try for the string value */
2019 case opt_expand_uid:
2020 if (! *get_set_flag(name, oltop, last, options_block))
2022 sprintf(CS name2, "*expand_%.50s", name);
2023 ol2 = find_option(name2, oltop, last);
2026 void *value2 = ol2->value;
2027 if (options_block != NULL)
2028 value2 = (void *)((uschar *)options_block + (long int)value2);
2029 s = *((uschar **)value2);
2030 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2035 /* Else fall through */
2038 if (! *get_set_flag(name, oltop, last, options_block))
2039 printf("%s =\n", name);
2042 pw = getpwuid(*((uid_t *)value));
2044 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2045 else printf("%s = %s\n", name, pw->pw_name);
2049 /* If the numerical value is unset, try for the string value */
2051 case opt_expand_gid:
2052 if (! *get_set_flag(name, oltop, last, options_block))
2054 sprintf(CS name2, "*expand_%.50s", name);
2055 ol2 = find_option(name2, oltop, last);
2056 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2058 void *value2 = ol2->value;
2059 if (options_block != NULL)
2060 value2 = (void *)((uschar *)options_block + (long int)value2);
2061 s = *((uschar **)value2);
2062 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2067 /* Else fall through */
2070 if (! *get_set_flag(name, oltop, last, options_block))
2071 printf("%s =\n", name);
2074 gr = getgrgid(*((int *)value));
2076 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2077 else printf("%s = %s\n", name, gr->gr_name);
2082 uidlist = *((uid_t **)value);
2083 printf("%s =", name);
2084 if (uidlist != NULL)
2088 for (i = 1; i <= (int)(uidlist[0]); i++)
2090 uschar *name = NULL;
2091 pw = getpwuid(uidlist[i]);
2092 if (pw != NULL) name = US pw->pw_name;
2093 if (name != NULL) printf("%c%s", sep, name);
2094 else printf("%c%ld", sep, (long int)(uidlist[i]));
2102 gidlist = *((gid_t **)value);
2103 printf("%s =", name);
2104 if (gidlist != NULL)
2108 for (i = 1; i <= (int)(gidlist[0]); i++)
2110 uschar *name = NULL;
2111 gr = getgrgid(gidlist[i]);
2112 if (gr != NULL) name = US gr->gr_name;
2113 if (name != NULL) printf("%c%s", sep, name);
2114 else printf("%c%ld", sep, (long int)(gidlist[i]));
2122 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2128 int *list = (int *)value;
2129 printf("%s = ", name);
2130 for (i = 0; i < list[1]; i++)
2131 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2137 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2141 case opt_expand_bool:
2142 sprintf(CS name2, "*expand_%.50s", name);
2143 ol2 = find_option(name2, oltop, last);
2144 if (ol2 != NULL && ol2->value != NULL)
2146 void *value2 = ol2->value;
2147 if (options_block != NULL)
2148 value2 = (void *)((uschar *)options_block + (long int)value2);
2149 s = *((uschar **)value2);
2152 printf("%s = %s\n", name, string_printing(s));
2155 /* s == NULL => string not set; fall through */
2161 case opt_bool_verify:
2163 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2170 /*************************************************
2171 * Print value from main configuration *
2172 *************************************************/
2174 /* This function, called as a result of encountering the -bP option,
2175 causes the value of any main configuration variable to be output if the
2176 second argument is NULL. There are some special values:
2178 all print all main configuration options
2179 configure_file print the name of the configuration file
2180 routers print the routers' configurations
2181 transports print the transports' configuration
2182 authenticators print the authenticators' configuration
2183 router_list print a list of router names
2184 transport_list print a list of transport names
2185 authenticator_list print a list of authentication mechanism names
2186 +name print a named list item
2187 local_scan print the local_scan options
2189 If the second argument is not NULL, it must be one of "router", "transport", or
2190 "authenticator" in which case the first argument identifies the driver whose
2191 options are to be printed.
2194 name option name if type == NULL; else driver name
2195 type NULL or driver type name, as described above
2201 readconf_print(uschar *name, uschar *type)
2203 BOOL names_only = FALSE;
2205 optionlist *ol2 = NULL;
2206 driver_instance *d = NULL;
2216 static uschar *types[] = { US"address", US"domain", US"host",
2218 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2219 &hostlist_anchor, &localpartlist_anchor };
2221 for (i = 0; i < 4; i++)
2223 t = tree_search(*(anchors[i]), name+1);
2227 printf("%slist %s = %s\n", types[i], name+1,
2228 ((namedlist_block *)(t->data.ptr))->string);
2233 printf("no address, domain, host, or local part list called \"%s\" "
2234 "exists\n", name+1);
2239 if (Ustrcmp(name, "configure_file") == 0)
2241 printf("%s\n", CS config_main_filename);
2245 if (Ustrcmp(name, "all") == 0)
2247 for (ol = optionlist_config;
2248 ol < optionlist_config + optionlist_config_size; ol++)
2250 if ((ol->type & opt_hidden) == 0)
2251 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2256 if (Ustrcmp(name, "local_scan") == 0)
2258 #ifndef LOCAL_SCAN_HAS_OPTIONS
2259 printf("local_scan() options are not supported\n");
2261 for (ol = local_scan_options;
2262 ol < local_scan_options + local_scan_options_count; ol++)
2264 print_ol(ol, US ol->name, NULL, local_scan_options,
2265 local_scan_options_count);
2271 if (Ustrcmp(name, "routers") == 0)
2276 else if (Ustrcmp(name, "transports") == 0)
2278 type = US"transport";
2282 else if (Ustrcmp(name, "authenticators") == 0)
2284 type = US"authenticator";
2288 else if (Ustrcmp(name, "authenticator_list") == 0)
2290 type = US"authenticator";
2295 else if (Ustrcmp(name, "router_list") == 0)
2301 else if (Ustrcmp(name, "transport_list") == 0)
2303 type = US"transport";
2309 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2310 name, NULL, optionlist_config, optionlist_config_size);
2315 /* Handle the options for a router or transport. Skip options that are flagged
2316 as hidden. Some of these are options with names starting with '*', used for
2317 internal alternative representations of other options (which the printing
2318 function will sort out). Others are synonyms kept for backward compatibility.
2321 if (Ustrcmp(type, "router") == 0)
2323 d = (driver_instance *)routers;
2324 ol2 = optionlist_routers;
2325 size = optionlist_routers_size;
2327 else if (Ustrcmp(type, "transport") == 0)
2329 d = (driver_instance *)transports;
2330 ol2 = optionlist_transports;
2331 size = optionlist_transports_size;
2333 else if (Ustrcmp(type, "authenticator") == 0)
2335 d = (driver_instance *)auths;
2336 ol2 = optionlist_auths;
2337 size = optionlist_auths_size;
2342 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2346 /* Either search for a given driver, or print all of them */
2348 for (; d != NULL; d = d->next)
2351 printf("\n%s %s:\n", d->name, type);
2352 else if (Ustrcmp(d->name, name) != 0) continue;
2354 for (ol = ol2; ol < ol2 + size; ol++)
2356 if ((ol->type & opt_hidden) == 0)
2357 print_ol(ol, US ol->name, d, ol2, size);
2360 for (ol = d->info->options;
2361 ol < d->info->options + *(d->info->options_count); ol++)
2363 if ((ol->type & opt_hidden) == 0)
2364 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2366 if (name != NULL) return;
2368 if (name != NULL) printf("%s %s not found\n", type, name);
2373 /*************************************************
2374 * Read a named list item *
2375 *************************************************/
2377 /* This function reads a name and a list (i.e. string). The name is used to
2378 save the list in a tree, sorted by its name. Each entry also has a number,
2379 which can be used for caching tests, but if the string contains any expansion
2380 items other than $key, the number is set negative to inhibit caching. This
2381 mechanism is used for domain, host, and address lists that are referenced by
2385 anchorp points to the tree anchor
2386 numberp points to the current number for this tree
2387 max the maximum number permitted
2388 s the text of the option line, starting immediately after the name
2390 tname the name of the list type, for messages
2396 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2399 BOOL forcecache = FALSE;
2402 namedlist_block *nb = store_get(sizeof(namedlist_block));
2404 if (Ustrncmp(s, "_cache", 6) == 0)
2411 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2413 if (*numberp >= max)
2414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2417 while (isspace(*s)) s++;
2419 while (isalnum(*s) || *s == '_') s++;
2420 t = store_get(sizeof(tree_node) + s-ss);
2421 Ustrncpy(t->name, ss, s-ss);
2423 while (isspace(*s)) s++;
2425 if (!tree_insertnode(anchorp, t))
2426 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2427 "duplicate name \"%s\" for a named %s", t->name, tname);
2430 nb->number = *numberp;
2433 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2434 "missing '=' after \"%s\"", t->name);
2435 while (isspace(*s)) s++;
2436 nb->string = read_string(s, t->name);
2437 nb->cache_data = NULL;
2439 /* Check the string for any expansions; if any are found, mark this list
2440 uncacheable unless the user has explicited forced caching. */
2442 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2448 /*************************************************
2449 * Unpick data for a rate limit *
2450 *************************************************/
2452 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2456 s string, in the form t,b,f,l
2457 where t is the threshold (integer)
2458 b is the initial delay (time)
2459 f is the multiplicative factor (fixed point)
2460 k is the maximum time (time)
2461 threshold where to store threshold
2462 base where to store base in milliseconds
2463 factor where to store factor in milliseconds
2464 limit where to store limit
2466 Returns: nothing (panics on error)
2470 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2473 uschar bstring[16], lstring[16];
2475 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2476 factor, lstring) == 4)
2478 *base = readconf_readtime(bstring, 0, TRUE);
2479 *limit = readconf_readtime(lstring, 0, TRUE);
2480 if (*base >= 0 && *limit >= 0) return;
2482 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2488 /*************************************************
2489 * Read main configuration options *
2490 *************************************************/
2492 /* This function is the first to be called for configuration reading. It
2493 opens the configuration file and reads general configuration settings until
2494 it reaches the end of the configuration section. The file is then left open so
2495 that the remaining configuration data can subsequently be read if needed for
2498 The configuration file must be owned either by root or exim, and be writeable
2499 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2500 in the config file, so the test is done on the compiled in values. A slight
2501 anomaly, to be carefully documented.
2503 The name of the configuration file is taken from a list that is included in the
2504 binary of Exim. It can be altered from the command line, but if that is done,
2505 root privilege is immediately withdrawn unless the caller is root or exim.
2506 The first file on the list that exists is used.
2508 For use on multiple systems that share file systems, first look for a
2509 configuration file whose name has the current node name on the end. If that is
2510 not found, try the generic name. For really contorted configurations, that run
2511 multiple Exims with different uid settings, first try adding the effective uid
2512 before the node name. These complications are going to waste resources on most
2513 systems. Therefore they are available only when requested by compile-time
2520 struct stat statbuf;
2521 uschar *s, *filename;
2522 uschar *list = config_main_filelist;
2524 /* Loop through the possible file names */
2526 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2529 /* Cut out all the fancy processing unless specifically wanted */
2531 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2532 uschar *suffix = filename + Ustrlen(filename);
2534 /* Try for the node-specific file if a node name exists */
2536 #ifdef CONFIGURE_FILE_USE_NODE
2538 if (uname(&uts) >= 0)
2540 #ifdef CONFIGURE_FILE_USE_EUID
2541 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2542 config_file = Ufopen(filename, "rb");
2543 if (config_file == NULL)
2544 #endif /* CONFIGURE_FILE_USE_EUID */
2546 sprintf(CS suffix, ".%.256s", uts.nodename);
2547 config_file = Ufopen(filename, "rb");
2550 #endif /* CONFIGURE_FILE_USE_NODE */
2552 /* Otherwise, try the generic name, possibly with the euid added */
2554 #ifdef CONFIGURE_FILE_USE_EUID
2555 if (config_file == NULL)
2557 sprintf(CS suffix, ".%ld", (long int)original_euid);
2558 config_file = Ufopen(filename, "rb");
2560 #endif /* CONFIGURE_FILE_USE_EUID */
2562 /* Finally, try the unadorned name */
2564 if (config_file == NULL)
2567 config_file = Ufopen(filename, "rb");
2569 #else /* if neither defined */
2571 /* This is the common case when the fancy processing is not included. */
2573 config_file = Ufopen(filename, "rb");
2576 /* If the file does not exist, continue to try any others. For any other
2577 error, break out (and die). */
2579 if (config_file != NULL || errno != ENOENT) break;
2582 /* On success, save the name for verification; config_filename is used when
2583 logging configuration errors (it changes for .included files) whereas
2584 config_main_filename is the name shown by -bP. Failure to open a configuration
2585 file is a serious disaster. */
2587 if (config_file != NULL)
2589 config_filename = config_main_filename = string_copy(filename);
2593 if (filename == NULL)
2594 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2595 "%s", config_main_filelist);
2597 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2598 "configuration file %s", filename));
2601 /* Check the status of the file we have opened, unless it was specified on
2602 the command line, in which case privilege was given away at the start. */
2604 if (!config_changed)
2606 if (fstat(fileno(config_file), &statbuf) != 0)
2607 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2610 if ((statbuf.st_uid != root_uid && /* owner not root */
2611 statbuf.st_uid != exim_uid /* owner not exim */
2612 #ifdef CONFIGURE_OWNER
2613 && statbuf.st_uid != config_uid /* owner not the special one */
2616 (statbuf.st_gid != exim_gid /* group not exim & */
2617 #ifdef CONFIGURE_GROUP
2618 && statbuf.st_gid != config_gid /* group not the special one */
2620 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2622 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2624 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2625 "wrong owner, group, or mode", big_buffer);
2628 /* Process the main configuration settings. They all begin with a lower case
2629 letter. If we see something starting with an upper case letter, it is taken as
2630 a macro definition. */
2632 while ((s = get_config_line()) != NULL)
2637 macro_item *mlast = NULL;
2641 while (isalnum(*s) || *s == '_')
2643 if (namelen >= sizeof(name) - 1)
2644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2645 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
2646 name[namelen++] = *s++;
2649 while (isspace(*s)) s++;
2650 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2651 "malformed macro definition");
2652 while (isspace(*s)) s++;
2654 /* If an existing macro of the same name was defined on the command line,
2655 we just skip this definition. Otherwise it's an error to attempt to
2656 redefine a macro. It is also an error to define a macro whose name begins
2657 with the name of a previously-defined macro. */
2659 for (m = macros; m != NULL; m = m->next)
2661 int len = Ustrlen(m->name);
2663 if (Ustrcmp(m->name, name) == 0)
2665 if (m->command_line) break;
2666 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
2670 if (len < namelen && Ustrstr(name, m->name) != NULL)
2671 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
2672 "a macro because previously defined macro \"%s\" is a substring",
2677 if (m != NULL) continue; /* Found an overriding command-line definition */
2679 m = store_get(sizeof(macro_item) + namelen);
2681 m->command_line = FALSE;
2682 if (mlast == NULL) macros = m; else mlast->next = m;
2684 /* This use of strcpy() is OK because we have obtained a block of store
2685 whose size is based on the length of "name". The definition of the
2686 macro_item structure includes a final vector called "name" which is one
2687 byte long. Thus, adding "namelen" gives us enough room to store the "name"
2690 Ustrcpy(m->name, name);
2691 m->replacement = string_copy(s);
2694 else if (Ustrncmp(s, "domainlist", 10) == 0)
2695 read_named_list(&domainlist_anchor, &domainlist_count,
2696 MAX_NAMED_LIST, s+10, US"domain list");
2698 else if (Ustrncmp(s, "hostlist", 8) == 0)
2699 read_named_list(&hostlist_anchor, &hostlist_count,
2700 MAX_NAMED_LIST, s+8, US"host list");
2702 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2703 read_named_list(&addresslist_anchor, &addresslist_count,
2704 MAX_NAMED_LIST, s+11, US"address list");
2706 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2707 read_named_list(&localpartlist_anchor, &localpartlist_count,
2708 MAX_NAMED_LIST, s+13, US"local part list");
2711 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2712 NULL, US"main option \"%s\" unknown");
2716 /* If local_sender_retain is set, local_from_check must be unset. */
2718 if (local_sender_retain && local_from_check)
2719 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2720 "local_sender_retain are set; this combination is not allowed");
2722 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2725 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2727 /* remote_max_parallel must be > 0 */
2729 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2731 /* The primary host name may be required for expansion of spool_directory
2732 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2733 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2734 canonize it. Some people like upper case letters in their host names, so we
2735 don't force the case. */
2737 if (primary_hostname == NULL)
2741 if (uname(&uts) < 0)
2742 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2743 hostname = US uts.nodename;
2745 if (Ustrchr(hostname, '.') == NULL)
2748 struct hostent *hostdata;
2751 if (dns_ipv4_lookup == NULL ||
2752 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2762 #if HAVE_GETIPNODEBYNAME
2764 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2766 hostdata = gethostbyname2(CS hostname, af);
2769 hostdata = gethostbyname(CS hostname);
2772 if (hostdata != NULL)
2774 hostname = US hostdata->h_name;
2778 if (af == AF_INET) break;
2783 primary_hostname = string_copy(hostname);
2786 /* Set up default value for smtp_active_hostname */
2788 smtp_active_hostname = primary_hostname;
2790 /* If spool_directory wasn't set in the build-time configuration, it must have
2791 got set above. Of course, writing to the log may not work if log_file_path is
2792 not set, but it will at least get to syslog or somewhere, with any luck. */
2794 if (*spool_directory == 0)
2795 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2798 /* Expand the spool directory name; it may, for example, contain the primary
2799 host name. Same comment about failure. */
2801 s = expand_string(spool_directory);
2803 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2804 "\"%s\": %s", spool_directory, expand_string_message);
2805 spool_directory = s;
2807 /* Expand log_file_path, which must contain "%s" in any component that isn't
2808 the null string or "syslog". It is also allowed to contain one instance of %D.
2809 However, it must NOT contain % followed by anything else. */
2811 if (*log_file_path != 0)
2814 int sep = ':'; /* Fixed for log file path */
2815 s = expand_string(log_file_path);
2817 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2818 "\"%s\": %s", log_file_path, expand_string_message);
2821 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2824 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2825 t = Ustrstr(sss, "%s");
2827 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2828 "contain \"%%s\"", sss);
2830 t = Ustrchr(sss, '%');
2833 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2834 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2835 "unexpected \"%%\" character", s);
2842 /* Interpret syslog_facility into an integer argument for 'ident' param to
2843 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2846 if (syslog_facility_str != NULL)
2849 uschar *s = syslog_facility_str;
2851 if ((Ustrlen(syslog_facility_str) >= 4) &&
2852 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2855 for (i = 0; i < syslog_list_size; i++)
2857 if (strcmpic(s, syslog_list[i].name) == 0)
2859 syslog_facility = syslog_list[i].value;
2864 if (i >= syslog_list_size)
2866 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2867 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2871 /* Expand pid_file_path */
2873 if (*pid_file_path != 0)
2875 s = expand_string(pid_file_path);
2877 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2878 "\"%s\": %s", pid_file_path, expand_string_message);
2882 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2885 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2887 /* Unpick the SMTP rate limiting options, if set */
2889 if (smtp_ratelimit_mail != NULL)
2891 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2892 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
2895 if (smtp_ratelimit_rcpt != NULL)
2897 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
2898 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
2901 /* The qualify domains default to the primary host name */
2903 if (qualify_domain_sender == NULL)
2904 qualify_domain_sender = primary_hostname;
2905 if (qualify_domain_recipient == NULL)
2906 qualify_domain_recipient = qualify_domain_sender;
2908 /* Setting system_filter_user in the configuration sets the gid as well if a
2909 name is given, but a numerical value does not. */
2911 if (system_filter_uid_set && !system_filter_gid_set)
2913 struct passwd *pw = getpwuid(system_filter_uid);
2915 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
2916 (long int)system_filter_uid);
2917 system_filter_gid = pw->pw_gid;
2918 system_filter_gid_set = TRUE;
2921 /* If the errors_reply_to field is set, check that it is syntactically valid
2922 and ensure it contains a domain. */
2924 if (errors_reply_to != NULL)
2927 int start, end, domain;
2928 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
2929 &start, &end, &domain, FALSE);
2931 if (recipient == NULL)
2932 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2933 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
2936 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2937 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
2940 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
2941 smtp_accept_max must also be set. */
2943 if (smtp_accept_max == 0 &&
2944 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
2945 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2946 "smtp_accept_max must be set if smtp_accept_queue or "
2947 "smtp_accept_max_per_host is set");
2949 /* Set up the host number if anything is specified. It is an expanded string
2950 so that it can be computed from the host name, for example. We do this last
2951 so as to ensure that everything else is set up before the expansion. */
2953 if (host_number_string != NULL)
2956 uschar *s = expand_string(host_number_string);
2957 long int n = Ustrtol(s, &end, 0);
2958 while (isspace(*end)) end++;
2960 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2961 "localhost_number value is not a number: %s", s);
2962 if (n > LOCALHOST_MAX)
2963 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2964 "localhost_number is greater than the maximum allowed value (%d)",
2970 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
2972 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
2973 tls_verify_certificates == NULL)
2974 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2975 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
2976 (tls_verify_hosts != NULL)? "" : "try_");
2982 /*************************************************
2983 * Initialize one driver *
2984 *************************************************/
2986 /* This is called once the driver's generic options, if any, have been read.
2987 We can now find the driver, set up defaults for the private options, and
2988 unset any "set" bits in the private options table (which might have been
2989 set by another incarnation of the same driver).
2992 d pointer to driver instance block, with generic
2994 drivers_available vector of available drivers
2995 size_of_info size of each block in drivers_available
2996 class class of driver, for error message
2998 Returns: pointer to the driver info block
3001 static driver_info *
3002 init_driver(driver_instance *d, driver_info *drivers_available,
3003 int size_of_info, uschar *class)
3007 for (dd = drivers_available; dd->driver_name[0] != 0;
3008 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3010 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3013 int len = dd->options_len;
3015 d->options_block = store_get(len);
3016 memcpy(d->options_block, dd->options_block, len);
3017 for (i = 0; i < *(dd->options_count); i++)
3018 dd->options[i].type &= ~opt_set;
3023 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3024 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3026 return NULL; /* never obeyed */
3032 /*************************************************
3033 * Initialize driver list *
3034 *************************************************/
3036 /* This function is called for routers, transports, and authentication
3037 mechanisms. It reads the data from the current point in the configuration file
3038 up to the end of the section, and sets up a chain of instance blocks according
3039 to the file's contents. The file will already have been opened by a call to
3040 readconf_main, and must be left open for subsequent reading of further data.
3042 Any errors cause a panic crash. Note that the blocks with names driver_info and
3043 driver_instance must map the first portions of all the _info and _instance
3044 blocks for this shared code to work.
3047 class "router", "transport", or "authenticator"
3048 anchor &routers, &transports, &auths
3049 drivers_available available drivers
3050 size_of_info size of each info block
3051 instance_default points to default data for an instance
3052 instance_size size of instance block
3053 driver_optionlist generic option list
3054 driver_optionlist_count count of generic option list
3060 readconf_driver_init(
3062 driver_instance **anchor,
3063 driver_info *drivers_available,
3065 void *instance_default,
3067 optionlist *driver_optionlist,
3068 int driver_optionlist_count)
3070 driver_instance **p = anchor;
3071 driver_instance *d = NULL;
3074 /* Now process the configuration lines */
3076 while ((buffer = get_config_line()) != NULL)
3080 /* Read the first name on the line and test for the start of a new driver.
3081 If this isn't the start of a new driver, the line will be re-read. */
3083 uschar *s = readconf_readname(name, sizeof(name), buffer);
3085 /* If the line starts with a name terminated by a colon, we are at the
3086 start of the definition of a new driver. The rest of the line must be
3093 /* Finish off initializing the previous driver. */
3097 if (d->driver_name == NULL)
3098 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3099 "no driver defined for %s \"%s\"", class, d->name);
3103 /* Check that we haven't already got a driver of this name */
3105 for (d = *anchor; d != NULL; d = d->next)
3106 if (Ustrcmp(name, d->name) == 0)
3107 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3108 "there are two %ss called \"%s\"", class, name);
3110 /* Set up a new driver instance data block on the chain, with
3111 its default values installed. */
3113 d = store_get(instance_size);
3114 memcpy(d, instance_default, instance_size);
3117 d->name = string_copy(name);
3119 /* Clear out the "set" bits in the generic options */
3121 for (i = 0; i < driver_optionlist_count; i++)
3122 driver_optionlist[i].type &= ~opt_set;
3124 /* Check nothing more on this line, then do the next loop iteration. */
3126 while (isspace(*s)) s++;
3127 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3131 /* Give an error if we have not set up a current driver yet. */
3133 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3134 "%s name missing", class);
3136 /* First look to see if this is a generic option; if it is "driver",
3137 initialize the driver. If is it not a generic option, we can look for a
3138 private option provided that the driver has been previously set up. */
3140 if (readconf_handle_option(buffer, driver_optionlist,
3141 driver_optionlist_count, d, NULL))
3143 if (d->info == NULL && d->driver_name != NULL)
3144 init_driver(d, drivers_available, size_of_info, class);
3147 /* Handle private options - pass the generic block because some may
3148 live therein. A flag with each option indicates if it is in the public
3151 else if (d->info != NULL)
3153 readconf_handle_option(buffer, d->info->options,
3154 *(d->info->options_count), d, US"option \"%s\" unknown");
3157 /* The option is not generic and the driver name has not yet been given. */
3159 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3160 "(\"driver\" must be specified before any private options)", name);
3163 /* Run the initialization function for the final driver. */
3167 if (d->driver_name == NULL)
3168 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3169 "no driver defined for %s \"%s\"", class, d->name);
3176 /*************************************************
3177 * Check driver dependency *
3178 *************************************************/
3180 /* This function is passed a driver instance and a string. It checks whether
3181 any of the string options for the driver contains the given string as an
3185 d points to a driver instance block
3186 s the string to search for
3188 Returns: TRUE if a dependency is found
3192 readconf_depends(driver_instance *d, uschar *s)
3194 int count = *(d->info->options_count);
3198 for (ol = d->info->options; ol < d->info->options + count; ol++)
3200 void *options_block;
3202 int type = ol->type & opt_mask;
3203 if (type != opt_stringptr) continue;
3204 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3205 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3206 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3208 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3209 isalnum(ss[Ustrlen(s)])) continue;
3210 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3211 d->name, ol->name, s);
3216 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3223 /*************************************************
3224 * Decode an error type for retries *
3225 *************************************************/
3227 /* This function is global because it is also called from the main
3228 program when testing retry information. It decodes strings such as "quota_7d"
3229 into numerical error codes.
3232 pp points to start of text
3233 p points past end of text
3234 basic_errno points to an int to receive the main error number
3235 more_errno points to an int to receive the secondary error data
3237 Returns: NULL if decoded correctly; else points to error text
3241 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3245 while (q < p && *q != '_') q++;
3248 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3250 *basic_errno = ERRNO_EXIMQUOTA;
3251 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3252 return US"bad time value";
3255 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3257 *basic_errno = ECONNREFUSED;
3260 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3261 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3262 else return US"A or MX expected after \"refused\"";
3266 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3268 *basic_errno = ETIMEDOUT;
3272 int xlen = p - q - 1;
3275 static uschar *extras[] =
3276 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3277 static int values[] =
3278 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3280 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3282 if (strncmpic(x, extras[i], xlen) == 0)
3284 *more_errno = values[i];
3289 if (i >= sizeof(extras)/sizeof(uschar *))
3291 if (strncmpic(x, US"DNS", xlen) == 0)
3293 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3294 "available in retry rules (it has never worked) - treated as "
3297 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3302 else if (strncmpic(pp, US"rcpt_4", 6) == 0)
3305 int x = 255; /* means "any 4xx code" */
3306 if (p != pp + 8) bad = TRUE; else
3308 int a = pp[6], b = pp[7];
3312 if (isdigit(b)) x += b - '0';
3313 else if (b == 'x') x += 100;
3316 else if (a != 'x' || b != 'x') bad = TRUE;
3319 if (bad) return US"rcpt_4 must be followed by xx, dx, or dd, where "
3320 "x is literal and d is any digit";
3322 *basic_errno = ERRNO_RCPT4XX;
3323 *more_errno = x << 8;
3326 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3327 strncmpic(q+1, US"failed", p-q-1) == 0)
3329 *basic_errno = ERRNO_AUTHFAIL;
3332 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3333 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3341 /*************************************************
3342 * Read retry information *
3343 *************************************************/
3345 /* Each line of retry information contains:
3347 . A domain name pattern or an address pattern;
3349 . An error name, possibly with additional data, or *;
3351 . An optional sequence of retry items, each consisting of an identifying
3352 letter, a cutoff time, and optional parameters.
3354 All this is decoded and placed into a control block. */
3357 /* Subroutine to read an argument, preceded by a comma and terminated
3358 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3359 1 = fixed point number (returned *1000).
3362 paddr pointer to pointer to current character; updated
3363 type 0 => read a time; 1 => read a fixed point number
3365 Returns: time in seconds or fixed point number * 1000
3369 retry_arg(uschar **paddr, int type)
3374 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3376 while (isspace(*p)) p++;
3378 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3380 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3381 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3387 return readconf_readtime(pp, *p, FALSE);
3389 return readconf_readfixed(pp, *p);
3391 return 0; /* Keep picky compilers happy */
3394 /* The function proper */
3397 readconf_retries(void)
3399 retry_config **chain = &retries;
3403 while ((p = get_config_line()) != NULL)
3405 retry_rule **rchain;
3408 next = store_get(sizeof(retry_config));
3411 chain = &(next->next);
3412 next->basic_errno = next->more_errno = 0;
3413 next->senders = NULL;
3415 rchain = &(next->rules);
3417 next->pattern = string_dequote(&p);
3418 while (isspace(*p)) p++;
3420 while (mac_isgraph(*p)) p++;
3421 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3422 "missing error type");
3424 /* Test error names for things we understand. */
3426 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3427 &(next->more_errno))) != NULL)
3428 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3430 /* There may be an optional address list of senders to be used as another
3431 constraint on the rule. This was added later, so the syntax is a bit of a
3432 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3435 while (isspace(*p)) p++;
3436 if (Ustrncmp(p, "senders", 7) == 0)
3439 while (isspace(*p)) p++;
3440 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3441 "\"=\" expected after \"senders\" in retry rule");
3442 while (isspace(*p)) p++;
3443 next->senders = string_dequote(&p);
3446 /* Now the retry rules. Keep the maximum timeout encountered. */
3448 while (isspace(*p)) p++;
3452 retry_rule *rule = store_get(sizeof(retry_rule));
3454 rchain = &(rule->next);
3456 rule->rule = toupper(*p++);
3457 rule->timeout = retry_arg(&p, 0);
3458 if (rule->timeout > retry_maximum_timeout)
3459 retry_maximum_timeout = rule->timeout;
3463 case 'F': /* Fixed interval */
3464 rule->p1 = retry_arg(&p, 0);
3467 case 'G': /* Geometrically increasing intervals */
3468 rule->p1 = retry_arg(&p, 0);
3469 rule->p2 = retry_arg(&p, 1);
3473 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3477 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3478 (rule->rule == 'G' && rule->p2 < 1000))
3479 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3480 "bad parameters for retry rule");
3482 while (isspace(*p)) p++;
3486 while (isspace(*p)) p++;
3489 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3496 /*************************************************
3497 * Initialize authenticators *
3498 *************************************************/
3500 /* Read the authenticators section of the configuration file.
3509 auth_instance *au, *bu;
3510 readconf_driver_init(US"authenticator",
3511 (driver_instance **)(&auths), /* chain anchor */
3512 (driver_info *)auths_available, /* available drivers */
3513 sizeof(auth_info), /* size of info block */
3514 &auth_defaults, /* default values for generic options */
3515 sizeof(auth_instance), /* size of instance block */
3516 optionlist_auths, /* generic options */
3517 optionlist_auths_size);
3519 for (au = auths; au != NULL; au = au->next)
3521 if (au->public_name == NULL)
3522 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3523 "the %s authenticator", au->name);
3524 for (bu = au->next; bu != NULL; bu = bu->next)
3526 if (strcmpic(au->public_name, bu->public_name) == 0)
3528 if ((au->client && bu->client) || (au->server && bu->server))
3529 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3530 "(%s and %s) have the same public name (%s)",
3531 (au->client)? US"client" : US"server", au->name, bu->name,
3541 /*************************************************
3542 * Read ACL information *
3543 *************************************************/
3545 /* If this run of Exim is not doing something that involves receiving a
3546 message, we can just skip over the ACL information. No need to parse it.
3548 First, we have a function for acl_read() to call back to get the next line. We
3549 need to remember the line we passed, because at the end it will contain the
3550 name of the next ACL. */
3552 static uschar *acl_line;
3557 acl_line = get_config_line();
3562 /* Now the main function:
3565 skip TRUE when this Exim process is doing something that will
3566 not need the ACL data
3572 readconf_acl(BOOL skip)
3576 /* Not receiving messages, don't need to parse the ACL data */
3580 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3581 while ((p = get_config_line()) != NULL);
3585 /* Read each ACL and add it into the tree */
3587 acl_line = get_config_line();
3589 while(acl_line != NULL)
3595 p = readconf_readname(name, sizeof(name), acl_line);
3597 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing ACL name");
3599 node = store_get(sizeof(tree_node) + Ustrlen(name));
3600 Ustrcpy(node->name, name);
3601 if (!tree_insertnode(&acl_anchor, node))
3602 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3603 "there are two ACLs called \"%s\"", name);
3605 node->data.ptr = acl_read(acl_callback, &error);
3607 if (node->data.ptr == NULL && error != NULL)
3608 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3614 /*************************************************
3615 * Read configuration for local_scan() *
3616 *************************************************/
3618 /* This function is called after "begin local_scan" is encountered in the
3619 configuration file. If the local_scan() function allows for configuration
3620 options, we can process them. Otherwise, we expire in a panic.
3627 local_scan_init(void)
3629 #ifndef LOCAL_SCAN_HAS_OPTIONS
3630 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3631 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3635 while ((p = get_config_line()) != NULL)
3637 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3638 NULL, US"local_scan option \"%s\" unknown");
3645 /*************************************************
3646 * Read rest of configuration (after main) *
3647 *************************************************/
3649 /* This function reads the rest of the runtime configuration, after the main
3650 configuration. It is called only when actually needed. Each subsequent section
3651 of the configuration starts with a line of the form
3655 where the name is "routers", "transports", etc. A section is terminated by
3656 hitting the next "begin" line, and the next name is left in next_section.
3657 Because it may confuse people as to whether the names are singular or plural,
3658 we add "s" if it's missing. There is always enough room in next_section for
3659 this. This function is basically just a switch.
3662 skip_acl TRUE if ACL information is not needed
3667 static uschar *section_list[] = {
3677 readconf_rest(BOOL skip_acl)
3681 while(next_section[0] != 0)
3685 int last = sizeof(section_list) / sizeof(uschar *);
3687 int n = Ustrlen(next_section);
3689 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3693 int c = strcmpic(next_section, section_list[mid]);
3695 if (c > 0) first = mid + 1; else last = mid;
3697 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3698 "\"%.*s\" is not a known configuration section name", n, next_section);
3699 mid = (last + first)/2;
3703 if (((had ^= bit) & bit) == 0)
3704 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3705 "\"%.*s\" section is repeated in the configuration file", n,
3710 case 0: readconf_acl(skip_acl); break;
3711 case 1: auths_init(); break;
3712 case 2: local_scan_init(); break;
3713 case 3: readconf_retries(); break;
3714 case 4: readconf_rewrites(); break;
3715 case 5: route_init(); break;
3716 case 6: transport_init(); break;
3720 fclose(config_file);
3723 /* End of readconf.c */