1 /* $Cambridge: exim/src/src/readconf.c,v 1.21 2006/02/22 15:08:20 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
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_rfc2047_length", opt_bool, &check_rfc2047_length },
186 { "check_spool_inodes", opt_int, &check_spool_inodes },
187 { "check_spool_space", opt_Kint, &check_spool_space },
188 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
189 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
190 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
191 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
192 { "delay_warning", opt_timelist, &delay_warning },
193 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
194 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
195 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
196 { "delivery_date_remove", opt_bool, &delivery_date_remove },
197 { "disable_ipv6", opt_bool, &disable_ipv6 },
198 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
199 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
200 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
201 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
202 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
203 { "dns_retrans", opt_time, &dns_retrans },
204 { "dns_retry", opt_int, &dns_retry },
205 /* This option is now a no-op, retained for compability */
206 { "drop_cr", opt_bool, &drop_cr },
207 /*********************************************************/
208 { "envelope_to_remove", opt_bool, &envelope_to_remove },
209 { "errors_copy", opt_stringptr, &errors_copy },
210 { "errors_reply_to", opt_stringptr, &errors_reply_to },
211 { "exim_group", opt_gid, &exim_gid },
212 { "exim_path", opt_stringptr, &exim_path },
213 { "exim_user", opt_uid, &exim_uid },
214 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
215 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
216 { "finduser_retries", opt_int, &finduser_retries },
217 { "freeze_tell", opt_stringptr, &freeze_tell },
218 { "gecos_name", opt_stringptr, &gecos_name },
219 { "gecos_pattern", opt_stringptr, &gecos_pattern },
220 { "header_line_maxsize", opt_int, &header_line_maxsize },
221 { "header_maxsize", opt_int, &header_maxsize },
222 { "headers_charset", opt_stringptr, &headers_charset },
223 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
224 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
225 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
226 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
227 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
228 { "hold_domains", opt_stringptr, &hold_domains },
229 { "host_lookup", opt_stringptr, &host_lookup },
230 { "host_lookup_order", opt_stringptr, &host_lookup_order },
231 { "host_reject_connection", opt_stringptr, &host_reject_connection },
232 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
233 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
235 { "ibase_servers", opt_stringptr, &ibase_servers },
237 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
238 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
239 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
240 { "keep_malformed", opt_time, &keep_malformed },
242 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
243 { "ldap_version", opt_int, &eldap_version },
245 { "local_from_check", opt_bool, &local_from_check },
246 { "local_from_prefix", opt_stringptr, &local_from_prefix },
247 { "local_from_suffix", opt_stringptr, &local_from_suffix },
248 { "local_interfaces", opt_stringptr, &local_interfaces },
249 { "local_scan_timeout", opt_time, &local_scan_timeout },
250 { "local_sender_retain", opt_bool, &local_sender_retain },
251 { "localhost_number", opt_stringptr, &host_number_string },
252 { "log_file_path", opt_stringptr, &log_file_path },
253 { "log_selector", opt_stringptr, &log_selector_string },
254 { "log_timezone", opt_bool, &log_timezone },
255 { "lookup_open_max", opt_int, &lookup_open_max },
256 { "max_username_length", opt_int, &max_username_length },
257 { "message_body_visible", opt_mkint, &message_body_visible },
258 { "message_id_header_domain", opt_stringptr, &message_id_domain },
259 { "message_id_header_text", opt_stringptr, &message_id_text },
260 { "message_logs", opt_bool, &message_logs },
261 { "message_size_limit", opt_stringptr, &message_size_limit },
262 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
263 { "move_frozen_messages", opt_bool, &move_frozen_messages },
265 { "mua_wrapper", opt_bool, &mua_wrapper },
267 { "mysql_servers", opt_stringptr, &mysql_servers },
269 { "never_users", opt_uidlist, &never_users },
271 { "oracle_servers", opt_stringptr, &oracle_servers },
273 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
275 { "perl_at_start", opt_bool, &opt_perl_at_start },
276 { "perl_startup", opt_stringptr, &opt_perl_startup },
279 { "pgsql_servers", opt_stringptr, &pgsql_servers },
281 { "pid_file_path", opt_stringptr, &pid_file_path },
282 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
283 { "preserve_message_logs", opt_bool, &preserve_message_logs },
284 { "primary_hostname", opt_stringptr, &primary_hostname },
285 { "print_topbitchars", opt_bool, &print_topbitchars },
286 { "process_log_path", opt_stringptr, &process_log_path },
287 { "prod_requires_admin", opt_bool, &prod_requires_admin },
288 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
289 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
290 { "queue_domains", opt_stringptr, &queue_domains },
291 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
292 { "queue_only", opt_bool, &queue_only },
293 { "queue_only_file", opt_stringptr, &queue_only_file },
294 { "queue_only_load", opt_fixed, &queue_only_load },
295 { "queue_only_override", opt_bool, &queue_only_override },
296 { "queue_run_in_order", opt_bool, &queue_run_in_order },
297 { "queue_run_max", opt_int, &queue_run_max },
298 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
299 { "receive_timeout", opt_time, &receive_timeout },
300 { "received_header_text", opt_stringptr, &received_header_text },
301 { "received_headers_max", opt_int, &received_headers_max },
302 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
303 { "recipients_max", opt_int, &recipients_max },
304 { "recipients_max_reject", opt_bool, &recipients_max_reject },
305 { "remote_max_parallel", opt_int, &remote_max_parallel },
306 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
307 { "retry_data_expire", opt_time, &retry_data_expire },
308 { "retry_interval_max", opt_time, &retry_interval_max },
309 { "return_path_remove", opt_bool, &return_path_remove },
310 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
311 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
312 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
313 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
314 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
315 { "smtp_accept_max", opt_int, &smtp_accept_max },
316 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
317 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
318 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
319 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
320 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
321 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
322 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
323 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
324 { "smtp_banner", opt_stringptr, &smtp_banner },
325 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
326 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
327 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
328 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
329 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
330 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
331 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
332 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
333 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
334 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
335 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
336 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
337 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
338 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
339 #ifdef WITH_CONTENT_SCAN
340 { "spamd_address", opt_stringptr, &spamd_address },
342 { "split_spool_directory", opt_bool, &split_spool_directory },
343 { "spool_directory", opt_stringptr, &spool_directory },
345 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
347 #ifdef EXPERIMENTAL_SRS
348 { "srs_config", opt_stringptr, &srs_config },
349 { "srs_hashlength", opt_int, &srs_hashlength },
350 { "srs_hashmin", opt_int, &srs_hashmin },
351 { "srs_maxage", opt_int, &srs_maxage },
352 { "srs_secrets", opt_stringptr, &srs_secrets },
353 { "srs_usehash", opt_bool, &srs_usehash },
354 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
356 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
357 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
358 { "syslog_duplication", opt_bool, &syslog_duplication },
359 { "syslog_facility", opt_stringptr, &syslog_facility_str },
360 { "syslog_processname", opt_stringptr, &syslog_processname },
361 { "syslog_timestamp", opt_bool, &syslog_timestamp },
362 { "system_filter", opt_stringptr, &system_filter },
363 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
364 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
365 { "system_filter_group", opt_gid, &system_filter_gid },
366 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
367 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
368 { "system_filter_user", opt_uid, &system_filter_uid },
369 { "tcp_nodelay", opt_bool, &tcp_nodelay },
370 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
371 { "timezone", opt_stringptr, &timezone_string },
373 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
374 { "tls_certificate", opt_stringptr, &tls_certificate },
375 { "tls_crl", opt_stringptr, &tls_crl },
376 { "tls_dhparam", opt_stringptr, &tls_dhparam },
377 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
378 { "tls_privatekey", opt_stringptr, &tls_privatekey },
379 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
380 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
381 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
382 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
383 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
385 { "trusted_groups", opt_gidlist, &trusted_groups },
386 { "trusted_users", opt_uidlist, &trusted_users },
387 { "unknown_login", opt_stringptr, &unknown_login },
388 { "unknown_username", opt_stringptr, &unknown_username },
389 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
390 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
391 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
392 { "warn_message_file", opt_stringptr, &warn_message_file },
393 { "write_rejectlog", opt_bool, &write_rejectlog }
396 static int optionlist_config_size =
397 sizeof(optionlist_config)/sizeof(optionlist);
401 /*************************************************
402 * Find the name of an option *
403 *************************************************/
405 /* This function is to aid debugging. Various functions take arguments that are
406 pointer variables in the options table or in option tables for various drivers.
407 For debugging output, it is useful to be able to find the name of the option
408 which is currently being processed. This function finds it, if it exists, by
409 searching the table(s).
411 Arguments: a value that is presumed to be in the table above
412 Returns: the option name, or an empty string
416 readconf_find_option(void *p)
420 transport_instance *t;
422 for (i = 0; i < optionlist_config_size; i++)
423 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
425 for (r = routers; r != NULL; r = r->next)
427 router_info *ri = r->info;
428 for (i = 0; i < ri->options_count[0]; i++)
430 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
431 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
432 return US ri->options[i].name;
436 for (t = transports; t != NULL; t = t->next)
438 transport_info *ti = t->info;
439 for (i = 0; i < ti->options_count[0]; i++)
441 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
442 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
443 return US ti->options[i].name;
453 /*************************************************
454 * Deal with an assignment to a macro *
455 *************************************************/
457 /* This function is called when a line that starts with an upper case letter is
458 encountered. The argument "line" should contain a complete logical line, and
459 start with the first letter of the macro name. The macro name and the
460 replacement text are extracted and stored. Redefinition of existing,
461 non-command line, macros is permitted using '==' instead of '='.
464 s points to the start of the logical line
470 read_macro_assignment(uschar *s)
476 macro_item *mlast = NULL;
478 while (isalnum(*s) || *s == '_')
480 if (namelen >= sizeof(name) - 1)
481 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
482 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
483 name[namelen++] = *s++;
487 while (isspace(*s)) s++;
489 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
496 while (isspace(*s)) s++;
498 /* If an existing macro of the same name was defined on the command line, we
499 just skip this definition. It's an error to attempt to redefine a macro without
500 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
501 It is also an error to define a macro whose name begins with the name of a
502 previously defined macro. Note: it is documented that the other way round
505 for (m = macros; m != NULL; m = m->next)
507 int len = Ustrlen(m->name);
509 if (Ustrcmp(m->name, name) == 0)
511 if (!m->command_line && !redef)
512 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
513 "defined (use \"==\" if you want to redefine it", name);
517 if (len < namelen && Ustrstr(name, m->name) != NULL)
518 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
519 "a macro because previously defined macro \"%s\" is a substring",
522 /* We cannot have this test, because it is documented that a substring
523 macro is permitted (there is even an example).
525 * if (len > namelen && Ustrstr(m->name, name) != NULL)
526 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
527 * "a macro because it is a substring of previously defined macro \"%s\"",
534 /* Check for an overriding command-line definition. */
536 if (m != NULL && m->command_line) return;
538 /* Redefinition must refer to an existing macro. */
543 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
547 /* We have a new definition. The macro_item structure includes a final vector
548 called "name" which is one byte long. Thus, adding "namelen" gives us enough
549 room to store the "name" string. */
553 m = store_get(sizeof(macro_item) + namelen);
554 if (macros == NULL) macros = m; else mlast->next = m;
555 Ustrncpy(m->name, name, namelen);
556 m->name[namelen] = 0;
558 m->command_line = FALSE;
561 /* Set the value of the new or redefined macro */
563 m->replacement = string_copy(s);
570 /*************************************************
571 * Read configuration line *
572 *************************************************/
574 /* A logical line of text is read from the configuration file into the big
575 buffer, taking account of macros, .includes, and continuations. The size of
576 big_buffer is increased if necessary. The count of configuration lines is
577 maintained. Physical input lines starting with # (ignoring leading white space,
578 and after macro replacement) and empty logical lines are always ignored.
579 Leading and trailing spaces are removed.
581 If we hit a line of the form "begin xxxx", the xxxx is placed in the
582 next_section vector, and the function returns NULL, indicating the end of a
583 configuration section. On end-of-file, NULL is returned with next_section
588 Returns: a pointer to the first non-blank in the line,
589 or NULL if eof or end of section is reached
593 get_config_line(void)
595 int startoffset = 0; /* To first non-blank char in logical line */
596 int len = 0; /* Of logical line so far */
602 /* Loop for handling continuation lines, skipping comments, and dealing with
607 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
609 if (config_file_stack != NULL) /* EOF inside .include */
611 (void)fclose(config_file);
612 config_file = config_file_stack->file;
613 config_filename = config_file_stack->filename;
614 config_lineno = config_file_stack->lineno;
615 config_file_stack = config_file_stack->next;
619 /* EOF at top level */
621 if (cstate_stack_ptr >= 0)
622 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
623 "Unexpected end of configuration file: .endif missing");
625 if (len != 0) break; /* EOF after continuation */
626 next_section[0] = 0; /* EOF at start of logical line */
631 newlen = len + Ustrlen(big_buffer + len);
633 /* Handle pathologically long physical lines - yes, it did happen - by
634 extending big_buffer at this point. The code also copes with very long
637 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
640 big_buffer_size += BIG_BUFFER_SIZE;
641 newbuffer = store_malloc(big_buffer_size);
643 /* This use of strcpy is OK because we know that the string in the old
644 buffer is shorter than the new buffer. */
646 Ustrcpy(newbuffer, big_buffer);
647 store_free(big_buffer);
648 big_buffer = newbuffer;
649 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
651 newlen += Ustrlen(big_buffer + newlen);
654 /* Find the true start of the physical line - leading spaces are always
657 ss = big_buffer + len;
658 while (isspace(*ss)) ss++;
660 /* Process the physical line for macros. If this is the start of the logical
661 line, skip over initial text at the start of the line if it starts with an
662 upper case character followed by a sequence of name characters and an equals
663 sign, because that is the definition of a new macro, and we don't do
664 replacement therein. */
667 if (len == 0 && isupper(*s))
669 while (isalnum(*s) || *s == '_') s++;
670 while (isspace(*s)) s++;
671 if (*s != '=') s = ss; /* Not a macro definition */
674 /* For each defined macro, scan the line (from after XXX= if present),
675 replacing all occurrences of the macro. */
678 for (m = macros; m != NULL; m = m->next)
683 while ((p = Ustrstr(t, m->name)) != NULL)
686 int namelen = Ustrlen(m->name);
687 int replen = Ustrlen(m->replacement);
689 /* Expand the buffer if necessary */
691 while (newlen - namelen + replen + 1 > big_buffer_size)
693 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
694 uschar *newbuffer = store_malloc(newsize);
695 memcpy(newbuffer, big_buffer, newlen + 1);
696 p = newbuffer + (p - big_buffer);
697 s = newbuffer + (s - big_buffer);
698 ss = newbuffer + (ss - big_buffer);
699 t = newbuffer + (t - big_buffer);
700 big_buffer_size = newsize;
701 store_free(big_buffer);
702 big_buffer = newbuffer;
705 /* Shuffle the remaining characters up or down in the buffer before
706 copying in the replacement text. Don't rescan the replacement for this
710 moveby = replen - namelen;
713 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
716 Ustrncpy(p, m->replacement, replen);
722 /* An empty macro replacement at the start of a line could mean that ss no
723 longer points to the first non-blank character. */
725 while (isspace(*ss)) ss++;
727 /* Check for comment lines - these are physical lines. */
729 if (*ss == '#') continue;
731 /* Handle conditionals, which are also applied to physical lines. Conditions
732 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
733 expansion occured on the rest of the line. A preliminary test for the leading
734 '.' saves effort on most lines. */
740 /* Search the list of conditional directives */
742 for (i = 0; i < cond_list_size; i++)
745 cond_item *c = cond_list+i;
746 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
748 /* The following character must be white space or end of string */
750 n = ss[1 + c->namelen];
751 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
753 /* .ifdef and .ifndef push the current state onto the stack, then set
754 a new one from the table. Stack overflow is an error */
758 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
759 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
760 ".%s nested too deeply", c->name);
761 cstate_stack[++cstate_stack_ptr] = cstate;
762 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
765 /* For any of the others, stack underflow is an error. The next state
766 comes either from the stack (.endif) or from the table. */
770 if (cstate_stack_ptr < 0)
771 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
772 ".%s without matching .ifdef", c->name);
773 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
774 next_cstate[cstate][macro_found? c->action1 : c->action2];
777 /* Having dealt with a directive, break the loop */
782 /* If we have handled a conditional directive, continue with the next
783 physical line. Otherwise, fall through. */
785 if (i < cond_list_size) continue;
788 /* If the conditional state is not 0 (actively using these lines), ignore
791 if (cstate != 0) continue; /* Conditional skip */
793 /* Handle .include lines - these are also physical lines. */
795 if (Ustrncmp(ss, ".include", 8) == 0 &&
797 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
800 int include_if_exists = isspace(ss[8])? 0 : 10;
801 config_file_item *save;
804 ss += 9 + include_if_exists;
805 while (isspace(*ss)) ss++;
806 t = ss + Ustrlen(ss);
807 while (t > ss && isspace(t[-1])) t--;
808 if (*ss == '\"' && t[-1] == '\"')
816 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
817 "absolute path \"%s\"", ss);
819 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
821 save = store_get(sizeof(config_file_item));
822 save->next = config_file_stack;
823 config_file_stack = save;
824 save->file = config_file;
825 save->filename = config_filename;
826 save->lineno = config_lineno;
828 config_file = Ufopen(ss, "rb");
829 if (config_file == NULL)
830 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
831 "configuration file %s", ss);
832 config_filename = string_copy(ss);
837 /* If this is the start of the logical line, remember where the non-blank
838 data starts. Otherwise shuffle down continuation lines to remove leading
842 startoffset = ss - big_buffer;
845 s = big_buffer + len;
848 memmove(s, ss, (newlen - len) - (ss - s) + 1);
853 /* Accept the new addition to the line. Remove trailing white space. */
856 while (len > 0 && isspace(big_buffer[len-1])) len--;
859 /* We are done if the line does not end in backslash and contains some data.
860 Empty logical lines are ignored. For continuations, remove the backslash and
861 go round the loop to read the continuation line. */
865 if (big_buffer[len-1] != '\\') break; /* End of logical line */
866 big_buffer[--len] = 0; /* Remove backslash */
868 } /* Loop for reading multiple physical lines */
870 /* We now have a logical line. Test for the end of a configuration section (or,
871 more accurately, for the start of the next section). Place the name of the next
872 section in next_section, and return NULL. If the name given is longer than
873 next_section, truncate it. It will be unrecognized later, because all the known
874 section names do fit. Leave space for pluralizing. */
876 s = big_buffer + startoffset; /* First non-space character */
877 if (strncmpic(s, US"begin ", 6) == 0)
880 while (isspace(*s)) s++;
881 if (big_buffer + len - s > sizeof(next_section) - 2)
882 s[sizeof(next_section) - 2] = 0;
883 Ustrcpy(next_section, s);
887 /* Return the first non-blank character. */
894 /*************************************************
896 *************************************************/
898 /* The yield is the pointer to the next uschar. Names longer than the
899 output space are silently truncated. This function is also used from acl.c when
903 name where to put the name
907 Returns: new input pointer
911 readconf_readname(uschar *name, int len, uschar *s)
914 while (isspace(*s)) s++;
917 while (isalnum(*s) || *s == '_')
919 if (p < len-1) name[p++] = *s;
924 while (isspace(*s)) s++;
931 /*************************************************
932 * Read a time value *
933 *************************************************/
935 /* This function is also called from outside, to read argument
936 time values. The format of a time value is:
938 [<n>w][<n>d][<n>h][<n>m][<n>s]
940 as long as at least one is present. If a format error is encountered,
941 return a negative value. The value must be terminated by the given
946 terminator required terminating character
947 return_msec if TRUE, allow fractional seconds and return milliseconds
949 Returns: the time value, or -1 on syntax error
950 value is seconds if return_msec is FALSE
951 value is milliseconds if return_msec is TRUE
955 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
963 if (!isdigit(*s)) return -1;
964 (void)sscanf(CS s, "%d%n", &value, &count);
969 case 'w': value *= 7;
970 case 'd': value *= 24;
971 case 'h': value *= 60;
972 case 'm': value *= 60;
977 if (!return_msec) return -1;
978 (void)sscanf(CS s, "%lf%n", &fraction, &count);
980 if (*s++ != 's') return -1;
981 yield += (int)(fraction * 1000.0);
987 if (return_msec) value *= 1000;
989 if (*s == terminator) return yield;
991 /* Control never reaches here. */
996 /*************************************************
997 * Read a fixed point value *
998 *************************************************/
1000 /* The value is returned *1000
1004 terminator required terminator
1006 Returns: the value, or -1 on error
1010 readconf_readfixed(uschar *s, int terminator)
1014 if (!isdigit(*s)) return -1;
1015 (void)sscanf(CS s, "%d%n", &value, &count);
1017 yield = value * 1000;
1021 while (isdigit((*(++s))))
1023 yield += (*s - '0') * m;
1028 return (*s == terminator)? yield : (-1);
1033 /*************************************************
1034 * Find option in list *
1035 *************************************************/
1037 /* The lists are always in order, so binary chop can be used.
1040 name the option name to search for
1041 ol the first entry in the option list
1042 last one more than the offset of the last entry in the option list
1044 Returns: pointer to an option entry, or NULL if not found
1048 find_option(uschar *name, optionlist *ol, int last)
1051 while (last > first)
1053 int middle = (first + last)/2;
1054 int c = Ustrcmp(name, ol[middle].name);
1055 if (c == 0) return ol + middle;
1056 else if (c > 0) first = middle + 1;
1064 /*************************************************
1065 * Find a set flag in option list *
1066 *************************************************/
1068 /* Because some versions of Unix make no restrictions on the values of uids and
1069 gids (even negative ones), we cannot represent "unset" by a special value.
1070 There is therefore a separate boolean variable for each one indicating whether
1071 a value is set or not. This function returns a pointer to the boolean, given
1072 the original option name. It is a major disaster if the flag cannot be found.
1075 name the name of the uid or gid option
1076 oltop points to the start of the relevant option list
1077 last one more than the offset of the last item in the option list
1078 data_block NULL when reading main options => data values in the option
1079 list are absolute addresses; otherwise they are byte offsets
1080 in data_block (used for driver options)
1082 Returns: a pointer to the boolean flag.
1086 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1090 sprintf(CS name2, "*set_%.50s", name);
1091 ol = find_option(name2, oltop, last);
1092 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1093 "Exim internal error: missing set flag for %s", name);
1094 return (data_block == NULL)? (BOOL *)(ol->value) :
1095 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1101 /*************************************************
1102 * Output extra characters message and die *
1103 *************************************************/
1105 /* Called when an option line has junk on the end. Sometimes this is because
1106 the sysadmin thinks comments are permitted.
1109 s points to the extra characters
1110 t1..t3 strings to insert in the log message
1112 Returns: doesn't return; dies
1116 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1118 uschar *comment = US"";
1119 if (*s == '#') comment = US" (# is comment only at line start)";
1120 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1121 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1126 /*************************************************
1127 * Read rewrite information *
1128 *************************************************/
1130 /* Each line of rewrite information contains:
1132 . A complete address in the form user@domain, possibly with
1133 leading * for each part; or alternatively, a regex.
1135 . A replacement string (which will be expanded).
1137 . An optional sequence of one-letter flags, indicating which
1138 headers etc. to apply this rule to.
1140 All this is decoded and placed into a control block. The OR of the flags is
1141 maintained in a common word.
1144 p points to the string that makes up the rule
1145 existflags points to the overall flag word
1146 isglobal TRUE if reading global rewrite rules
1148 Returns: the control block for the parsed rule.
1151 static rewrite_rule *
1152 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1154 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1157 next->key = string_dequote(&p);
1159 while (isspace(*p)) p++;
1161 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1162 "missing rewrite replacement string");
1165 next->replacement = string_dequote(&p);
1167 while (*p != 0) switch (*p++)
1169 case ' ': case '\t': break;
1171 case 'q': next->flags |= rewrite_quit; break;
1172 case 'w': next->flags |= rewrite_whole; break;
1174 case 'h': next->flags |= rewrite_all_headers; break;
1175 case 's': next->flags |= rewrite_sender; break;
1176 case 'f': next->flags |= rewrite_from; break;
1177 case 't': next->flags |= rewrite_to; break;
1178 case 'c': next->flags |= rewrite_cc; break;
1179 case 'b': next->flags |= rewrite_bcc; break;
1180 case 'r': next->flags |= rewrite_replyto; break;
1182 case 'E': next->flags |= rewrite_all_envelope; break;
1183 case 'F': next->flags |= rewrite_envfrom; break;
1184 case 'T': next->flags |= rewrite_envto; break;
1186 case 'Q': next->flags |= rewrite_qualify; break;
1187 case 'R': next->flags |= rewrite_repeat; break;
1190 next->flags |= rewrite_smtp;
1191 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1192 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1193 "rewrite rule has the S flag but is not a regular expression");
1197 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1198 "unknown rewrite flag character '%c' "
1199 "(could be missing quotes round replacement item)", p[-1]);
1203 /* If no action flags are set, set all the "normal" rewrites. */
1205 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1206 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1208 /* Remember which exist, for optimization, and return the rule */
1210 *existflags |= next->flags;
1217 /*************************************************
1218 * Read global rewrite information *
1219 *************************************************/
1221 /* Each line is a single rewrite rule; it is parsed into a control block
1222 by readconf_one_rewrite(), and its flags are ORed into the global flag
1223 word rewrite_existflags. */
1226 readconf_rewrites(void)
1228 rewrite_rule **chain = &global_rewrite_rules;
1231 while ((p = get_config_line()) != NULL)
1233 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1235 chain = &(next->next);
1241 /*************************************************
1243 *************************************************/
1245 /* Strings are read into the normal store pool. As long we aren't too
1246 near the end of the current block, the string will just use what is necessary
1247 on the top of the stacking pool, because string_cat() uses the extension
1251 s the rest of the input line
1252 name the option name (for errors)
1254 Returns: pointer to the string
1258 read_string(uschar *s, uschar *name)
1263 if (*s != '\"') return string_copy(s);
1266 yield = string_dequote(&s);
1268 if (s == ss+1 || s[-1] != '\"')
1269 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1270 "missing quote at end of string value for %s", name);
1272 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1278 /*************************************************
1279 * Handle option line *
1280 *************************************************/
1282 /* This function is called from several places to process a line containing the
1283 setting of an option. The first argument is the line to be decoded; it has been
1284 checked not to be empty and not to start with '#'. Trailing newlines and white
1285 space have been removed. The second argument is a pointer to the list of
1286 variable names that are to be recognized, together with their types and
1287 locations, and the third argument gives the number of entries in the list.
1289 The fourth argument is a pointer to a data block. If it is NULL, then the data
1290 values in the options list are absolute addresses. Otherwise, they are byte
1291 offsets in the data block.
1293 String option data may continue onto several lines; this function reads further
1294 data from config_file if necessary.
1296 The yield of this function is normally zero. If a string continues onto
1297 multiple lines, then the data value is permitted to be followed by a comma
1298 or a semicolon (for use in drivers) and the yield is that character.
1301 buffer contains the configuration line to be handled
1302 oltop points to the start of the relevant option list
1303 last one more than the offset of the last item in the option list
1304 data_block NULL when reading main options => data values in the option
1305 list are absolute addresses; otherwise they are byte offsets
1306 in data_block when they have opt_public set; otherwise
1307 they are byte offsets in data_block->options_block.
1308 unknown_txt format string to use in panic message for unknown option;
1309 must contain %s for option name
1310 if given as NULL, don't panic on unknown option
1312 Returns: TRUE if an option was read successfully,
1313 FALSE false for an unknown option if unknown_txt == NULL,
1314 otherwise panic and die on an unknown option
1318 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1319 void *data_block, uschar *unknown_txt)
1323 int n, count, type, value;
1327 BOOL boolvalue = TRUE;
1328 BOOL freesptr = TRUE;
1329 optionlist *ol, *ol2;
1333 uschar *inttype = US"";
1339 /* There may be leading spaces; thereafter, we expect an option name starting
1342 while (isspace(*s)) s++;
1344 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1346 /* Read the name of the option, and skip any subsequent white space. If
1347 it turns out that what we read was "hide", set the flag indicating that
1348 this is a secure option, and loop to read the next word. */
1350 for (n = 0; n < 2; n++)
1352 while (isalnum(*s) || *s == '_')
1354 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1358 while (isspace(*s)) s++;
1359 if (Ustrcmp(name, "hide") != 0) break;
1360 issecure = opt_secure;
1364 /* Deal with "no_" or "not_" here for booleans */
1366 if (Ustrncmp(name, "no_", 3) == 0)
1372 if (Ustrncmp(name, "not_", 4) == 0)
1378 /* Search the list for the given name. A non-existent name, or an option that
1379 is set twice, is a disaster. */
1381 ol = find_option(name + offset, oltop, last);
1385 if (unknown_txt == NULL) return FALSE;
1386 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1389 if ((ol->type & opt_set) != 0)
1391 uschar *mname = name;
1392 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1393 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1394 "\"%s\" option set for the second time", mname);
1397 ol->type |= opt_set | issecure;
1398 type = ol->type & opt_mask;
1400 /* Types with data values must be followed by '='; the "no[t]_" prefix
1401 applies only to boolean values. */
1403 if (type < opt_bool || type > opt_bool_last)
1406 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1407 "negation prefix applied to a non-boolean option");
1409 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1410 "unexpected end of line (data missing) after %s", name);
1412 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1415 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1416 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1417 ultimately expands to one of those values. */
1419 else if (*s != 0 && (offset != 0 || *s != '='))
1420 extra_chars_error(s, US"boolean option ", name, US"");
1422 /* Skip white space after = */
1424 if (*s == '=') while (isspace((*(++s))));
1426 /* If there is a data block and the opt_public flag is not set, change
1427 the data block pointer to the private options block. */
1429 if (data_block != NULL && (ol->type & opt_public) == 0)
1430 data_block = (void *)(((driver_instance *)data_block)->options_block);
1432 /* Now get the data according to the type. */
1436 /* If a string value is not enclosed in quotes, it consists of
1437 the rest of the current line, verbatim. Otherwise, string escapes
1440 A transport is specified as a string, which is then looked up in the
1441 list of transports. A search type is specified as one of a number of
1444 A set or rewrite rules for a driver is specified as a string, which is
1445 then parsed into a suitable chain of control blocks.
1447 Uids and gids are specified as strings which are then looked up in the
1448 passwd file. Lists of uids and gids are similarly specified as colon-
1449 separated strings. */
1454 case opt_expand_uid:
1455 case opt_expand_gid:
1460 reset_point = sptr = read_string(s, name);
1462 /* Having read a string, we now have several different ways of using it,
1463 depending on the data type, so do another switch. If keeping the actual
1464 string is not required (because it is interpreted), freesptr is set TRUE,
1465 and at the end we reset the pool. */
1469 /* If this was a string, set the variable to point to the new string,
1470 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1471 rules, we still keep the string (for printing), and parse the rules into a
1472 control block and flags word. */
1476 if (data_block == NULL)
1477 *((uschar **)(ol->value)) = sptr;
1479 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1481 if (type == opt_rewrite)
1486 rewrite_rule **chain;
1489 sprintf(CS name2, "*%.50s_rules", name);
1490 ol2 = find_option(name2, oltop, last);
1491 sprintf(CS name2, "*%.50s_flags", name);
1492 ol3 = find_option(name2, oltop, last);
1494 if (ol2 == NULL || ol3 == NULL)
1495 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1496 "rewrite rules not available for driver");
1498 if (data_block == NULL)
1500 chain = (rewrite_rule **)(ol2->value);
1501 flagptr = (int *)(ol3->value);
1505 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1506 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1509 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1512 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1514 chain = &(next->next);
1517 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1518 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1519 "non-header rewrite - not allowed at transport time -");
1523 /* If it was an expanded uid, see if there is any expansion to be
1524 done by checking for the presence of a $ character. If there is, save it
1525 in the corresponding *expand_user option field. Otherwise, fall through
1526 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1529 case opt_expand_uid:
1530 sprintf(CS name2, "*expand_%.50s", name);
1531 ol2 = find_option(name2, oltop, last);
1534 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1536 if (data_block == NULL)
1537 *((uschar **)(ol2->value)) = ss;
1539 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1543 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1549 /* Look up a fixed uid, and also make use of the corresponding gid
1550 if a passwd entry is returned and the gid has not been set. */
1553 if (!route_finduser(sptr, &pw, &uid))
1554 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1555 if (data_block == NULL)
1556 *((uid_t *)(ol->value)) = uid;
1558 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1560 /* Set the flag indicating a fixed value is set */
1562 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1564 /* Handle matching gid if we have a passwd entry: done by finding the
1565 same name with terminating "user" changed to "group"; if not found,
1566 ignore. Also ignore if the value is already set. */
1568 if (pw == NULL) break;
1569 Ustrcpy(name+Ustrlen(name)-4, "group");
1570 ol2 = find_option(name, oltop, last);
1571 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1572 (ol2->type & opt_mask) == opt_expand_gid))
1574 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1577 if (data_block == NULL)
1578 *((gid_t *)(ol2->value)) = pw->pw_gid;
1580 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1586 /* If it was an expanded gid, see if there is any expansion to be
1587 done by checking for the presence of a $ character. If there is, save it
1588 in the corresponding *expand_user option field. Otherwise, fall through
1589 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1592 case opt_expand_gid:
1593 sprintf(CS name2, "*expand_%.50s", name);
1594 ol2 = find_option(name2, oltop, last);
1597 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1599 if (data_block == NULL)
1600 *((uschar **)(ol2->value)) = ss;
1602 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1606 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1612 /* Handle freestanding gid */
1615 if (!route_findgroup(sptr, &gid))
1616 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1617 if (data_block == NULL)
1618 *((gid_t *)(ol->value)) = gid;
1620 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1621 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1624 /* If it was a uid list, look up each individual entry, and build
1625 a vector of uids, with a count in the first element. Put the vector
1626 in malloc store so we can free the string. (We are reading into
1627 permanent store already.) */
1635 uschar *op = expand_string (sptr);
1638 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1639 name, expand_string_message);
1642 if (*p != 0) count++;
1643 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1644 list = store_malloc(count*sizeof(uid_t));
1645 list[ptr++] = (uid_t)(count - 1);
1647 if (data_block == NULL)
1648 *((uid_t **)(ol->value)) = list;
1650 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1656 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1657 if (!route_finduser(big_buffer, NULL, &uid))
1658 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1665 /* If it was a gid list, look up each individual entry, and build
1666 a vector of gids, with a count in the first element. Put the vector
1667 in malloc store so we can free the string. (We are reading into permanent
1676 uschar *op = expand_string (sptr);
1679 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1680 name, expand_string_message);
1683 if (*p != 0) count++;
1684 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1685 list = store_malloc(count*sizeof(gid_t));
1686 list[ptr++] = (gid_t)(count - 1);
1688 if (data_block == NULL)
1689 *((gid_t **)(ol->value)) = list;
1691 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1697 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1698 if (!route_findgroup(big_buffer, &gid))
1699 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1707 /* Release store if the value of the string doesn't need to be kept. */
1709 if (freesptr) store_reset(reset_point);
1712 /* Expanded boolean: if no characters follow, or if there are no dollar
1713 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1714 save the string for later expansion in the alternate place. */
1716 case opt_expand_bool:
1717 if (*s != 0 && Ustrchr(s, '$') != 0)
1719 sprintf(CS name2, "*expand_%.50s", name);
1720 ol2 = find_option(name2, oltop, last);
1723 reset_point = sptr = read_string(s, name);
1724 if (data_block == NULL)
1725 *((uschar **)(ol2->value)) = sptr;
1727 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1734 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1735 look for yes/not/true/false. Some booleans are stored in a single bit in
1736 a single int. There's a special fudge for verify settings; without a suffix
1737 they set both xx_sender and xx_recipient. The table points to the sender
1738 value; search subsequently for the recipient. There's another special case:
1739 opt_bool_set also notes when a boolean has been set. */
1743 case opt_bool_verify:
1747 s = readconf_readname(name2, 64, s);
1748 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1750 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1752 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1753 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1754 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1755 US"for boolean option ", name);
1758 /* Handle single-bit type. */
1760 if (type == opt_bit)
1762 int bit = 1 << ((ol->type >> 16) & 31);
1763 int *ptr = (data_block == NULL)?
1764 (int *)(ol->value) :
1765 (int *)((uschar *)data_block + (long int)ol->value);
1766 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1770 /* Handle full BOOL types */
1772 if (data_block == NULL)
1773 *((BOOL *)(ol->value)) = boolvalue;
1775 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1779 if (type == opt_bool_verify)
1781 sprintf(CS name2, "%.50s_recipient", name + offset);
1782 ol2 = find_option(name2, oltop, last);
1785 if (data_block == NULL)
1786 *((BOOL *)(ol2->value)) = boolvalue;
1788 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1792 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1794 else if (type == opt_bool_set)
1796 sprintf(CS name2, "*set_%.50s", name + offset);
1797 ol2 = find_option(name2, oltop, last);
1800 if (data_block == NULL)
1801 *((BOOL *)(ol2->value)) = TRUE;
1803 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1812 inttype = US"octal ";
1814 /* Integer: a simple(ish) case; allow octal and hex formats, and
1815 suffixes K and M. The different types affect output, not input. */
1822 value = strtol(CS s, CSS &endptr, intbase);
1825 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1828 if (errno != ERANGE)
1830 if (tolower(*endptr) == 'k')
1832 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1836 else if (tolower(*endptr) == 'm')
1838 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1840 else value *= 1024*1024;
1845 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1846 "absolute value of integer \"%s\" is too large (overflow)", s);
1848 while (isspace(*endptr)) endptr++;
1850 extra_chars_error(endptr, inttype, US"integer value for ", name);
1853 if (data_block == NULL)
1854 *((int *)(ol->value)) = value;
1856 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1859 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1866 value = strtol(CS s, CSS &endptr, intbase);
1869 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1872 if (errno != ERANGE)
1874 if (tolower(*endptr) == 'm')
1876 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1880 else if (tolower(*endptr) == 'k')
1886 value = (value + 512)/1024;
1890 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1891 "absolute value of integer \"%s\" is too large (overflow)", s);
1893 while (isspace(*endptr)) endptr++;
1895 extra_chars_error(endptr, inttype, US"integer value for ", name);
1898 if (data_block == NULL)
1899 *((int *)(ol->value)) = value;
1901 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1904 /* Fixed-point number: held to 3 decimal places. */
1907 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1908 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1909 "fixed-point number expected for %s", name);
1911 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1912 "integer \"%s\" is too large (overflow)", s);
1916 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1917 "integer \"%s\" is too large (overflow)", s);
1919 if (s[count] == '.')
1922 while (isdigit(s[++count]))
1924 value += (s[count] - '0') * d;
1929 while (isspace(s[count])) count++;
1932 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1934 if (data_block == NULL)
1935 *((int *)(ol->value)) = value;
1937 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1940 /* There's a special routine to read time values. */
1943 value = readconf_readtime(s, 0, FALSE);
1945 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1947 if (data_block == NULL)
1948 *((int *)(ol->value)) = value;
1950 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1953 /* A time list is a list of colon-separated times, with the first
1954 element holding the size of the list and the second the number of
1960 int *list = (data_block == NULL)?
1961 (int *)(ol->value) :
1962 (int *)((uschar *)data_block + (long int)(ol->value));
1964 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1967 uschar *snext = Ustrchr(s, ':');
1971 while (ss > s && isspace(ss[-1])) ss--;
1974 value = readconf_readtime(s, terminator, FALSE);
1976 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1978 if (count > 1 && value <= list[count])
1979 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1980 "time value out of order for %s", name);
1981 list[count+1] = value;
1982 if (snext == NULL) break;
1984 while (isspace(*s)) s++;
1987 if (count > list[0] - 2)
1988 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1990 if (count > 0 && list[2] == 0) count = 0;
2002 /*************************************************
2003 * Print a time value *
2004 *************************************************/
2007 Argument: a time value in seconds
2008 Returns: pointer to a fixed buffer containing the time as a string,
2009 in readconf_readtime() format
2013 readconf_printtime(int t)
2016 uschar *p = time_buffer;
2033 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2034 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2035 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2036 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2037 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2044 /*************************************************
2045 * Print an individual option value *
2046 *************************************************/
2048 /* This is used by the -bP option, so prints to the standard output.
2049 The entire options list is passed in as an argument, because some options come
2050 in pairs - typically uid/gid settings, which can either be explicit numerical
2051 values, or strings to be expanded later. If the numerical value is unset,
2052 search for "*expand_<name>" to see if there is a string equivalent.
2055 ol option entry, or NULL for an unknown option
2057 options_block NULL for main configuration options; otherwise points to
2058 a driver block; if the option doesn't have opt_public
2059 set, then options_block->options_block is where the item
2061 oltop points to the option list in which ol exists
2062 last one more than the offset of the last entry in optop
2068 print_ol(optionlist *ol, uschar *name, void *options_block,
2069 optionlist *oltop, int last)
2082 printf("%s is not a known option\n", name);
2086 /* Non-admin callers cannot see options that have been flagged secure by the
2089 if (!admin_user && (ol->type & opt_secure) != 0)
2091 printf("%s = <value not displayable>\n", name);
2095 /* Else show the value of the option */
2098 if (options_block != NULL)
2100 if ((ol->type & opt_public) == 0)
2101 options_block = (void *)(((driver_instance *)options_block)->options_block);
2102 value = (void *)((uschar *)options_block + (long int)value);
2105 switch(ol->type & opt_mask)
2108 case opt_rewrite: /* Show the text value */
2109 s = *((uschar **)value);
2110 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2114 printf("%s = %d\n", name, *((int *)value));
2119 int x = *((int *)value);
2120 if (x != 0 && (x & 1023) == 0)
2124 if ((x & 1023) == 0)
2129 printf("%s = %d%c\n", name, x, c);
2131 else printf("%s = %d\n", name, x);
2137 int x = *((int *)value);
2138 if (x == 0) printf("%s = 0\n", name);
2139 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2140 else printf("%s = %dK\n", name, x);
2145 printf("%s = %#o\n", name, *((int *)value));
2148 /* Can be negative only when "unset", in which case integer */
2152 int x = *((int *)value);
2155 if (x < 0) printf("%s =\n", name); else
2157 printf("%s = %d.", name, x/1000);
2170 /* If the numerical value is unset, try for the string value */
2172 case opt_expand_uid:
2173 if (! *get_set_flag(name, oltop, last, options_block))
2175 sprintf(CS name2, "*expand_%.50s", name);
2176 ol2 = find_option(name2, oltop, last);
2179 void *value2 = ol2->value;
2180 if (options_block != NULL)
2181 value2 = (void *)((uschar *)options_block + (long int)value2);
2182 s = *((uschar **)value2);
2183 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2188 /* Else fall through */
2191 if (! *get_set_flag(name, oltop, last, options_block))
2192 printf("%s =\n", name);
2195 pw = getpwuid(*((uid_t *)value));
2197 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2198 else printf("%s = %s\n", name, pw->pw_name);
2202 /* If the numerical value is unset, try for the string value */
2204 case opt_expand_gid:
2205 if (! *get_set_flag(name, oltop, last, options_block))
2207 sprintf(CS name2, "*expand_%.50s", name);
2208 ol2 = find_option(name2, oltop, last);
2209 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2211 void *value2 = ol2->value;
2212 if (options_block != NULL)
2213 value2 = (void *)((uschar *)options_block + (long int)value2);
2214 s = *((uschar **)value2);
2215 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2220 /* Else fall through */
2223 if (! *get_set_flag(name, oltop, last, options_block))
2224 printf("%s =\n", name);
2227 gr = getgrgid(*((int *)value));
2229 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2230 else printf("%s = %s\n", name, gr->gr_name);
2235 uidlist = *((uid_t **)value);
2236 printf("%s =", name);
2237 if (uidlist != NULL)
2241 for (i = 1; i <= (int)(uidlist[0]); i++)
2243 uschar *name = NULL;
2244 pw = getpwuid(uidlist[i]);
2245 if (pw != NULL) name = US pw->pw_name;
2246 if (name != NULL) printf("%c%s", sep, name);
2247 else printf("%c%ld", sep, (long int)(uidlist[i]));
2255 gidlist = *((gid_t **)value);
2256 printf("%s =", name);
2257 if (gidlist != NULL)
2261 for (i = 1; i <= (int)(gidlist[0]); i++)
2263 uschar *name = NULL;
2264 gr = getgrgid(gidlist[i]);
2265 if (gr != NULL) name = US gr->gr_name;
2266 if (name != NULL) printf("%c%s", sep, name);
2267 else printf("%c%ld", sep, (long int)(gidlist[i]));
2275 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2281 int *list = (int *)value;
2282 printf("%s = ", name);
2283 for (i = 0; i < list[1]; i++)
2284 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2290 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2294 case opt_expand_bool:
2295 sprintf(CS name2, "*expand_%.50s", name);
2296 ol2 = find_option(name2, oltop, last);
2297 if (ol2 != NULL && ol2->value != NULL)
2299 void *value2 = ol2->value;
2300 if (options_block != NULL)
2301 value2 = (void *)((uschar *)options_block + (long int)value2);
2302 s = *((uschar **)value2);
2305 printf("%s = %s\n", name, string_printing(s));
2308 /* s == NULL => string not set; fall through */
2314 case opt_bool_verify:
2316 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2323 /*************************************************
2324 * Print value from main configuration *
2325 *************************************************/
2327 /* This function, called as a result of encountering the -bP option,
2328 causes the value of any main configuration variable to be output if the
2329 second argument is NULL. There are some special values:
2331 all print all main configuration options
2332 configure_file print the name of the configuration file
2333 routers print the routers' configurations
2334 transports print the transports' configuration
2335 authenticators print the authenticators' configuration
2336 router_list print a list of router names
2337 transport_list print a list of transport names
2338 authenticator_list print a list of authentication mechanism names
2339 +name print a named list item
2340 local_scan print the local_scan options
2342 If the second argument is not NULL, it must be one of "router", "transport", or
2343 "authenticator" in which case the first argument identifies the driver whose
2344 options are to be printed.
2347 name option name if type == NULL; else driver name
2348 type NULL or driver type name, as described above
2354 readconf_print(uschar *name, uschar *type)
2356 BOOL names_only = FALSE;
2358 optionlist *ol2 = NULL;
2359 driver_instance *d = NULL;
2369 static uschar *types[] = { US"address", US"domain", US"host",
2371 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2372 &hostlist_anchor, &localpartlist_anchor };
2374 for (i = 0; i < 4; i++)
2376 t = tree_search(*(anchors[i]), name+1);
2380 printf("%slist %s = %s\n", types[i], name+1,
2381 ((namedlist_block *)(t->data.ptr))->string);
2386 printf("no address, domain, host, or local part list called \"%s\" "
2387 "exists\n", name+1);
2392 if (Ustrcmp(name, "configure_file") == 0)
2394 printf("%s\n", CS config_main_filename);
2398 if (Ustrcmp(name, "all") == 0)
2400 for (ol = optionlist_config;
2401 ol < optionlist_config + optionlist_config_size; ol++)
2403 if ((ol->type & opt_hidden) == 0)
2404 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2409 if (Ustrcmp(name, "local_scan") == 0)
2411 #ifndef LOCAL_SCAN_HAS_OPTIONS
2412 printf("local_scan() options are not supported\n");
2414 for (ol = local_scan_options;
2415 ol < local_scan_options + local_scan_options_count; ol++)
2417 print_ol(ol, US ol->name, NULL, local_scan_options,
2418 local_scan_options_count);
2424 if (Ustrcmp(name, "routers") == 0)
2429 else if (Ustrcmp(name, "transports") == 0)
2431 type = US"transport";
2435 else if (Ustrcmp(name, "authenticators") == 0)
2437 type = US"authenticator";
2441 else if (Ustrcmp(name, "authenticator_list") == 0)
2443 type = US"authenticator";
2448 else if (Ustrcmp(name, "router_list") == 0)
2454 else if (Ustrcmp(name, "transport_list") == 0)
2456 type = US"transport";
2462 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2463 name, NULL, optionlist_config, optionlist_config_size);
2468 /* Handle the options for a router or transport. Skip options that are flagged
2469 as hidden. Some of these are options with names starting with '*', used for
2470 internal alternative representations of other options (which the printing
2471 function will sort out). Others are synonyms kept for backward compatibility.
2474 if (Ustrcmp(type, "router") == 0)
2476 d = (driver_instance *)routers;
2477 ol2 = optionlist_routers;
2478 size = optionlist_routers_size;
2480 else if (Ustrcmp(type, "transport") == 0)
2482 d = (driver_instance *)transports;
2483 ol2 = optionlist_transports;
2484 size = optionlist_transports_size;
2486 else if (Ustrcmp(type, "authenticator") == 0)
2488 d = (driver_instance *)auths;
2489 ol2 = optionlist_auths;
2490 size = optionlist_auths_size;
2495 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2499 /* Either search for a given driver, or print all of them */
2501 for (; d != NULL; d = d->next)
2504 printf("\n%s %s:\n", d->name, type);
2505 else if (Ustrcmp(d->name, name) != 0) continue;
2507 for (ol = ol2; ol < ol2 + size; ol++)
2509 if ((ol->type & opt_hidden) == 0)
2510 print_ol(ol, US ol->name, d, ol2, size);
2513 for (ol = d->info->options;
2514 ol < d->info->options + *(d->info->options_count); ol++)
2516 if ((ol->type & opt_hidden) == 0)
2517 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2519 if (name != NULL) return;
2521 if (name != NULL) printf("%s %s not found\n", type, name);
2526 /*************************************************
2527 * Read a named list item *
2528 *************************************************/
2530 /* This function reads a name and a list (i.e. string). The name is used to
2531 save the list in a tree, sorted by its name. Each entry also has a number,
2532 which can be used for caching tests, but if the string contains any expansion
2533 items other than $key, the number is set negative to inhibit caching. This
2534 mechanism is used for domain, host, and address lists that are referenced by
2538 anchorp points to the tree anchor
2539 numberp points to the current number for this tree
2540 max the maximum number permitted
2541 s the text of the option line, starting immediately after the name
2543 tname the name of the list type, for messages
2549 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2552 BOOL forcecache = FALSE;
2555 namedlist_block *nb = store_get(sizeof(namedlist_block));
2557 if (Ustrncmp(s, "_cache", 6) == 0)
2564 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2566 if (*numberp >= max)
2567 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2570 while (isspace(*s)) s++;
2572 while (isalnum(*s) || *s == '_') s++;
2573 t = store_get(sizeof(tree_node) + s-ss);
2574 Ustrncpy(t->name, ss, s-ss);
2576 while (isspace(*s)) s++;
2578 if (!tree_insertnode(anchorp, t))
2579 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2580 "duplicate name \"%s\" for a named %s", t->name, tname);
2583 nb->number = *numberp;
2586 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2587 "missing '=' after \"%s\"", t->name);
2588 while (isspace(*s)) s++;
2589 nb->string = read_string(s, t->name);
2590 nb->cache_data = NULL;
2592 /* Check the string for any expansions; if any are found, mark this list
2593 uncacheable unless the user has explicited forced caching. */
2595 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2601 /*************************************************
2602 * Unpick data for a rate limit *
2603 *************************************************/
2605 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2609 s string, in the form t,b,f,l
2610 where t is the threshold (integer)
2611 b is the initial delay (time)
2612 f is the multiplicative factor (fixed point)
2613 k is the maximum time (time)
2614 threshold where to store threshold
2615 base where to store base in milliseconds
2616 factor where to store factor in milliseconds
2617 limit where to store limit
2619 Returns: nothing (panics on error)
2623 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2626 uschar bstring[16], lstring[16];
2628 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2629 factor, lstring) == 4)
2631 *base = readconf_readtime(bstring, 0, TRUE);
2632 *limit = readconf_readtime(lstring, 0, TRUE);
2633 if (*base >= 0 && *limit >= 0) return;
2635 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2641 /*************************************************
2642 * Read main configuration options *
2643 *************************************************/
2645 /* This function is the first to be called for configuration reading. It
2646 opens the configuration file and reads general configuration settings until
2647 it reaches the end of the configuration section. The file is then left open so
2648 that the remaining configuration data can subsequently be read if needed for
2651 The configuration file must be owned either by root or exim, and be writeable
2652 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2653 in the config file, so the test is done on the compiled in values. A slight
2654 anomaly, to be carefully documented.
2656 The name of the configuration file is taken from a list that is included in the
2657 binary of Exim. It can be altered from the command line, but if that is done,
2658 root privilege is immediately withdrawn unless the caller is root or exim.
2659 The first file on the list that exists is used.
2661 For use on multiple systems that share file systems, first look for a
2662 configuration file whose name has the current node name on the end. If that is
2663 not found, try the generic name. For really contorted configurations, that run
2664 multiple Exims with different uid settings, first try adding the effective uid
2665 before the node name. These complications are going to waste resources on most
2666 systems. Therefore they are available only when requested by compile-time
2673 struct stat statbuf;
2674 uschar *s, *filename;
2675 uschar *list = config_main_filelist;
2677 /* Loop through the possible file names */
2679 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2682 /* Cut out all the fancy processing unless specifically wanted */
2684 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2685 uschar *suffix = filename + Ustrlen(filename);
2687 /* Try for the node-specific file if a node name exists */
2689 #ifdef CONFIGURE_FILE_USE_NODE
2691 if (uname(&uts) >= 0)
2693 #ifdef CONFIGURE_FILE_USE_EUID
2694 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2695 config_file = Ufopen(filename, "rb");
2696 if (config_file == NULL)
2697 #endif /* CONFIGURE_FILE_USE_EUID */
2699 sprintf(CS suffix, ".%.256s", uts.nodename);
2700 config_file = Ufopen(filename, "rb");
2703 #endif /* CONFIGURE_FILE_USE_NODE */
2705 /* Otherwise, try the generic name, possibly with the euid added */
2707 #ifdef CONFIGURE_FILE_USE_EUID
2708 if (config_file == NULL)
2710 sprintf(CS suffix, ".%ld", (long int)original_euid);
2711 config_file = Ufopen(filename, "rb");
2713 #endif /* CONFIGURE_FILE_USE_EUID */
2715 /* Finally, try the unadorned name */
2717 if (config_file == NULL)
2720 config_file = Ufopen(filename, "rb");
2722 #else /* if neither defined */
2724 /* This is the common case when the fancy processing is not included. */
2726 config_file = Ufopen(filename, "rb");
2729 /* If the file does not exist, continue to try any others. For any other
2730 error, break out (and die). */
2732 if (config_file != NULL || errno != ENOENT) break;
2735 /* On success, save the name for verification; config_filename is used when
2736 logging configuration errors (it changes for .included files) whereas
2737 config_main_filename is the name shown by -bP. Failure to open a configuration
2738 file is a serious disaster. */
2740 if (config_file != NULL)
2742 config_filename = config_main_filename = string_copy(filename);
2746 if (filename == NULL)
2747 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2748 "%s", config_main_filelist);
2750 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2751 "configuration file %s", filename));
2754 /* Check the status of the file we have opened, unless it was specified on
2755 the command line, in which case privilege was given away at the start. */
2757 if (!config_changed)
2759 if (fstat(fileno(config_file), &statbuf) != 0)
2760 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2763 if ((statbuf.st_uid != root_uid && /* owner not root */
2764 statbuf.st_uid != exim_uid /* owner not exim */
2765 #ifdef CONFIGURE_OWNER
2766 && statbuf.st_uid != config_uid /* owner not the special one */
2769 (statbuf.st_gid != exim_gid /* group not exim & */
2770 #ifdef CONFIGURE_GROUP
2771 && statbuf.st_gid != config_gid /* group not the special one */
2773 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2775 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2777 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2778 "wrong owner, group, or mode", big_buffer);
2781 /* Process the main configuration settings. They all begin with a lower case
2782 letter. If we see something starting with an upper case letter, it is taken as
2783 a macro definition. */
2785 while ((s = get_config_line()) != NULL)
2787 if (isupper(s[0])) read_macro_assignment(s);
2789 else if (Ustrncmp(s, "domainlist", 10) == 0)
2790 read_named_list(&domainlist_anchor, &domainlist_count,
2791 MAX_NAMED_LIST, s+10, US"domain list");
2793 else if (Ustrncmp(s, "hostlist", 8) == 0)
2794 read_named_list(&hostlist_anchor, &hostlist_count,
2795 MAX_NAMED_LIST, s+8, US"host list");
2797 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2798 read_named_list(&addresslist_anchor, &addresslist_count,
2799 MAX_NAMED_LIST, s+11, US"address list");
2801 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2802 read_named_list(&localpartlist_anchor, &localpartlist_count,
2803 MAX_NAMED_LIST, s+13, US"local part list");
2806 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2807 NULL, US"main option \"%s\" unknown");
2811 /* If local_sender_retain is set, local_from_check must be unset. */
2813 if (local_sender_retain && local_from_check)
2814 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2815 "local_sender_retain are set; this combination is not allowed");
2817 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2820 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2822 /* The max retry interval must not be greater than 24 hours. */
2824 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2826 /* remote_max_parallel must be > 0 */
2828 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2830 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2831 start of a new SMTP message. */
2833 freeze_tell_config = freeze_tell;
2835 /* The primary host name may be required for expansion of spool_directory
2836 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2837 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2838 canonize it. Some people like upper case letters in their host names, so we
2839 don't force the case. */
2841 if (primary_hostname == NULL)
2845 if (uname(&uts) < 0)
2846 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2847 hostname = US uts.nodename;
2849 if (Ustrchr(hostname, '.') == NULL)
2852 struct hostent *hostdata;
2855 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2856 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2866 #if HAVE_GETIPNODEBYNAME
2868 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2870 hostdata = gethostbyname2(CS hostname, af);
2873 hostdata = gethostbyname(CS hostname);
2876 if (hostdata != NULL)
2878 hostname = US hostdata->h_name;
2882 if (af == AF_INET) break;
2887 primary_hostname = string_copy(hostname);
2890 /* Set up default value for smtp_active_hostname */
2892 smtp_active_hostname = primary_hostname;
2894 /* If spool_directory wasn't set in the build-time configuration, it must have
2895 got set above. Of course, writing to the log may not work if log_file_path is
2896 not set, but it will at least get to syslog or somewhere, with any luck. */
2898 if (*spool_directory == 0)
2899 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2902 /* Expand the spool directory name; it may, for example, contain the primary
2903 host name. Same comment about failure. */
2905 s = expand_string(spool_directory);
2907 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2908 "\"%s\": %s", spool_directory, expand_string_message);
2909 spool_directory = s;
2911 /* Expand log_file_path, which must contain "%s" in any component that isn't
2912 the null string or "syslog". It is also allowed to contain one instance of %D.
2913 However, it must NOT contain % followed by anything else. */
2915 if (*log_file_path != 0)
2918 int sep = ':'; /* Fixed for log file path */
2919 s = expand_string(log_file_path);
2921 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2922 "\"%s\": %s", log_file_path, expand_string_message);
2925 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2928 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2929 t = Ustrstr(sss, "%s");
2931 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2932 "contain \"%%s\"", sss);
2934 t = Ustrchr(sss, '%');
2937 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2938 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2939 "unexpected \"%%\" character", s);
2946 /* Interpret syslog_facility into an integer argument for 'ident' param to
2947 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2950 if (syslog_facility_str != NULL)
2953 uschar *s = syslog_facility_str;
2955 if ((Ustrlen(syslog_facility_str) >= 4) &&
2956 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2959 for (i = 0; i < syslog_list_size; i++)
2961 if (strcmpic(s, syslog_list[i].name) == 0)
2963 syslog_facility = syslog_list[i].value;
2968 if (i >= syslog_list_size)
2970 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2971 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2975 /* Expand pid_file_path */
2977 if (*pid_file_path != 0)
2979 s = expand_string(pid_file_path);
2981 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2982 "\"%s\": %s", pid_file_path, expand_string_message);
2986 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2989 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2991 /* Unpick the SMTP rate limiting options, if set */
2993 if (smtp_ratelimit_mail != NULL)
2995 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2996 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
2999 if (smtp_ratelimit_rcpt != NULL)
3001 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3002 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3005 /* The qualify domains default to the primary host name */
3007 if (qualify_domain_sender == NULL)
3008 qualify_domain_sender = primary_hostname;
3009 if (qualify_domain_recipient == NULL)
3010 qualify_domain_recipient = qualify_domain_sender;
3012 /* Setting system_filter_user in the configuration sets the gid as well if a
3013 name is given, but a numerical value does not. */
3015 if (system_filter_uid_set && !system_filter_gid_set)
3017 struct passwd *pw = getpwuid(system_filter_uid);
3019 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3020 (long int)system_filter_uid);
3021 system_filter_gid = pw->pw_gid;
3022 system_filter_gid_set = TRUE;
3025 /* If the errors_reply_to field is set, check that it is syntactically valid
3026 and ensure it contains a domain. */
3028 if (errors_reply_to != NULL)
3031 int start, end, domain;
3032 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3033 &start, &end, &domain, FALSE);
3035 if (recipient == NULL)
3036 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3037 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3040 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3041 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3044 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3045 smtp_accept_max must also be set. */
3047 if (smtp_accept_max == 0 &&
3048 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3049 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3050 "smtp_accept_max must be set if smtp_accept_queue or "
3051 "smtp_accept_max_per_host is set");
3053 /* Set up the host number if anything is specified. It is an expanded string
3054 so that it can be computed from the host name, for example. We do this last
3055 so as to ensure that everything else is set up before the expansion. */
3057 if (host_number_string != NULL)
3060 uschar *s = expand_string(host_number_string);
3061 long int n = Ustrtol(s, &end, 0);
3062 while (isspace(*end)) end++;
3064 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3065 "localhost_number value is not a number: %s", s);
3066 if (n > LOCALHOST_MAX)
3067 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3068 "localhost_number is greater than the maximum allowed value (%d)",
3074 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3076 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3077 tls_verify_certificates == NULL)
3078 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3079 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3080 (tls_verify_hosts != NULL)? "" : "try_");
3086 /*************************************************
3087 * Initialize one driver *
3088 *************************************************/
3090 /* This is called once the driver's generic options, if any, have been read.
3091 We can now find the driver, set up defaults for the private options, and
3092 unset any "set" bits in the private options table (which might have been
3093 set by another incarnation of the same driver).
3096 d pointer to driver instance block, with generic
3098 drivers_available vector of available drivers
3099 size_of_info size of each block in drivers_available
3100 class class of driver, for error message
3102 Returns: pointer to the driver info block
3105 static driver_info *
3106 init_driver(driver_instance *d, driver_info *drivers_available,
3107 int size_of_info, uschar *class)
3111 for (dd = drivers_available; dd->driver_name[0] != 0;
3112 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3114 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3117 int len = dd->options_len;
3119 d->options_block = store_get(len);
3120 memcpy(d->options_block, dd->options_block, len);
3121 for (i = 0; i < *(dd->options_count); i++)
3122 dd->options[i].type &= ~opt_set;
3127 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3128 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3130 return NULL; /* never obeyed */
3136 /*************************************************
3137 * Initialize driver list *
3138 *************************************************/
3140 /* This function is called for routers, transports, and authentication
3141 mechanisms. It reads the data from the current point in the configuration file
3142 up to the end of the section, and sets up a chain of instance blocks according
3143 to the file's contents. The file will already have been opened by a call to
3144 readconf_main, and must be left open for subsequent reading of further data.
3146 Any errors cause a panic crash. Note that the blocks with names driver_info and
3147 driver_instance must map the first portions of all the _info and _instance
3148 blocks for this shared code to work.
3151 class "router", "transport", or "authenticator"
3152 anchor &routers, &transports, &auths
3153 drivers_available available drivers
3154 size_of_info size of each info block
3155 instance_default points to default data for an instance
3156 instance_size size of instance block
3157 driver_optionlist generic option list
3158 driver_optionlist_count count of generic option list
3164 readconf_driver_init(
3166 driver_instance **anchor,
3167 driver_info *drivers_available,
3169 void *instance_default,
3171 optionlist *driver_optionlist,
3172 int driver_optionlist_count)
3174 driver_instance **p = anchor;
3175 driver_instance *d = NULL;
3178 while ((buffer = get_config_line()) != NULL)
3183 /* Read the first name on the line and test for the start of a new driver. A
3184 macro definition indicates the end of the previous driver. If this isn't the
3185 start of a new driver, the line will be re-read. */
3187 s = readconf_readname(name, sizeof(name), buffer);
3189 /* Handle macro definition, first finishing off the initialization of the
3190 previous driver, if any. */
3192 if (isupper(*name) && *s == '=')
3196 if (d->driver_name == NULL)
3197 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3198 "no driver defined for %s \"%s\"", class, d->name);
3202 read_macro_assignment(buffer);
3206 /* If the line starts with a name terminated by a colon, we are at the
3207 start of the definition of a new driver. The rest of the line must be
3214 /* Finish off initializing the previous driver. */
3218 if (d->driver_name == NULL)
3219 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3220 "no driver defined for %s \"%s\"", class, d->name);
3224 /* Check that we haven't already got a driver of this name */
3226 for (d = *anchor; d != NULL; d = d->next)
3227 if (Ustrcmp(name, d->name) == 0)
3228 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3229 "there are two %ss called \"%s\"", class, name);
3231 /* Set up a new driver instance data block on the chain, with
3232 its default values installed. */
3234 d = store_get(instance_size);
3235 memcpy(d, instance_default, instance_size);
3238 d->name = string_copy(name);
3240 /* Clear out the "set" bits in the generic options */
3242 for (i = 0; i < driver_optionlist_count; i++)
3243 driver_optionlist[i].type &= ~opt_set;
3245 /* Check nothing more on this line, then do the next loop iteration. */
3247 while (isspace(*s)) s++;
3248 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3252 /* Not the start of a new driver. Give an error if we have not set up a
3253 current driver yet. */
3255 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3256 "%s name missing", class);
3258 /* First look to see if this is a generic option; if it is "driver",
3259 initialize the driver. If is it not a generic option, we can look for a
3260 private option provided that the driver has been previously set up. */
3262 if (readconf_handle_option(buffer, driver_optionlist,
3263 driver_optionlist_count, d, NULL))
3265 if (d->info == NULL && d->driver_name != NULL)
3266 init_driver(d, drivers_available, size_of_info, class);
3269 /* Handle private options - pass the generic block because some may
3270 live therein. A flag with each option indicates if it is in the public
3273 else if (d->info != NULL)
3275 readconf_handle_option(buffer, d->info->options,
3276 *(d->info->options_count), d, US"option \"%s\" unknown");
3279 /* The option is not generic and the driver name has not yet been given. */
3281 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3282 "(\"driver\" must be specified before any private options)", name);
3285 /* Run the initialization function for the final driver. */
3289 if (d->driver_name == NULL)
3290 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3291 "no driver defined for %s \"%s\"", class, d->name);
3298 /*************************************************
3299 * Check driver dependency *
3300 *************************************************/
3302 /* This function is passed a driver instance and a string. It checks whether
3303 any of the string options for the driver contains the given string as an
3307 d points to a driver instance block
3308 s the string to search for
3310 Returns: TRUE if a dependency is found
3314 readconf_depends(driver_instance *d, uschar *s)
3316 int count = *(d->info->options_count);
3320 for (ol = d->info->options; ol < d->info->options + count; ol++)
3322 void *options_block;
3324 int type = ol->type & opt_mask;
3325 if (type != opt_stringptr) continue;
3326 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3327 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3328 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3330 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3331 isalnum(ss[Ustrlen(s)])) continue;
3332 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3333 d->name, ol->name, s);
3338 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3345 /*************************************************
3346 * Decode an error type for retries *
3347 *************************************************/
3349 /* This function is global because it is also called from the main
3350 program when testing retry information. It decodes strings such as "quota_7d"
3351 into numerical error codes.
3354 pp points to start of text
3355 p points past end of text
3356 basic_errno points to an int to receive the main error number
3357 more_errno points to an int to receive the secondary error data
3359 Returns: NULL if decoded correctly; else points to error text
3363 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3367 while (q < p && *q != '_') q++;
3370 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3372 *basic_errno = ERRNO_EXIMQUOTA;
3373 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3374 return US"bad time value";
3377 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3379 *basic_errno = ECONNREFUSED;
3382 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3383 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3384 else return US"A or MX expected after \"refused\"";
3388 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3390 *basic_errno = ETIMEDOUT;
3394 int xlen = p - q - 1;
3397 static uschar *extras[] =
3398 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3399 static int values[] =
3400 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3402 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3404 if (strncmpic(x, extras[i], xlen) == 0)
3406 *more_errno = values[i];
3411 if (i >= sizeof(extras)/sizeof(uschar *))
3413 if (strncmpic(x, US"DNS", xlen) == 0)
3415 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3416 "available in retry rules (it has never worked) - treated as "
3419 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3424 else if (strncmpic(pp, US"rcpt_4", 6) == 0)
3427 int x = 255; /* means "any 4xx code" */
3428 if (p != pp + 8) bad = TRUE; else
3430 int a = pp[6], b = pp[7];
3434 if (isdigit(b)) x += b - '0';
3435 else if (b == 'x') x += 100;
3438 else if (a != 'x' || b != 'x') bad = TRUE;
3441 if (bad) return US"rcpt_4 must be followed by xx, dx, or dd, where "
3442 "x is literal and d is any digit";
3444 *basic_errno = ERRNO_RCPT4XX;
3445 *more_errno = x << 8;
3448 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3449 strncmpic(q+1, US"failed", p-q-1) == 0)
3451 *basic_errno = ERRNO_AUTHFAIL;
3454 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3455 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3463 /*************************************************
3464 * Read retry information *
3465 *************************************************/
3467 /* Each line of retry information contains:
3469 . A domain name pattern or an address pattern;
3471 . An error name, possibly with additional data, or *;
3473 . An optional sequence of retry items, each consisting of an identifying
3474 letter, a cutoff time, and optional parameters.
3476 All this is decoded and placed into a control block. */
3479 /* Subroutine to read an argument, preceded by a comma and terminated
3480 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3481 1 = fixed point number (returned *1000).
3484 paddr pointer to pointer to current character; updated
3485 type 0 => read a time; 1 => read a fixed point number
3487 Returns: time in seconds or fixed point number * 1000
3491 retry_arg(uschar **paddr, int type)
3496 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3498 while (isspace(*p)) p++;
3500 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3502 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3503 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3509 return readconf_readtime(pp, *p, FALSE);
3511 return readconf_readfixed(pp, *p);
3513 return 0; /* Keep picky compilers happy */
3516 /* The function proper */
3519 readconf_retries(void)
3521 retry_config **chain = &retries;
3525 while ((p = get_config_line()) != NULL)
3527 retry_rule **rchain;
3530 next = store_get(sizeof(retry_config));
3533 chain = &(next->next);
3534 next->basic_errno = next->more_errno = 0;
3535 next->senders = NULL;
3537 rchain = &(next->rules);
3539 next->pattern = string_dequote(&p);
3540 while (isspace(*p)) p++;
3542 while (mac_isgraph(*p)) p++;
3543 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3544 "missing error type");
3546 /* Test error names for things we understand. */
3548 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3549 &(next->more_errno))) != NULL)
3550 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3552 /* There may be an optional address list of senders to be used as another
3553 constraint on the rule. This was added later, so the syntax is a bit of a
3554 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3557 while (isspace(*p)) p++;
3558 if (Ustrncmp(p, "senders", 7) == 0)
3561 while (isspace(*p)) p++;
3562 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3563 "\"=\" expected after \"senders\" in retry rule");
3564 while (isspace(*p)) p++;
3565 next->senders = string_dequote(&p);
3568 /* Now the retry rules. Keep the maximum timeout encountered. */
3570 while (isspace(*p)) p++;
3574 retry_rule *rule = store_get(sizeof(retry_rule));
3576 rchain = &(rule->next);
3578 rule->rule = toupper(*p++);
3579 rule->timeout = retry_arg(&p, 0);
3580 if (rule->timeout > retry_maximum_timeout)
3581 retry_maximum_timeout = rule->timeout;
3585 case 'F': /* Fixed interval */
3586 rule->p1 = retry_arg(&p, 0);
3589 case 'G': /* Geometrically increasing intervals */
3590 case 'H': /* Ditto, but with randomness */
3591 rule->p1 = retry_arg(&p, 0);
3592 rule->p2 = retry_arg(&p, 1);
3596 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3600 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3601 (rule->rule != 'F' && rule->p2 < 1000))
3602 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3603 "bad parameters for retry rule");
3605 while (isspace(*p)) p++;
3609 while (isspace(*p)) p++;
3612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3619 /*************************************************
3620 * Initialize authenticators *
3621 *************************************************/
3623 /* Read the authenticators section of the configuration file.
3632 auth_instance *au, *bu;
3633 readconf_driver_init(US"authenticator",
3634 (driver_instance **)(&auths), /* chain anchor */
3635 (driver_info *)auths_available, /* available drivers */
3636 sizeof(auth_info), /* size of info block */
3637 &auth_defaults, /* default values for generic options */
3638 sizeof(auth_instance), /* size of instance block */
3639 optionlist_auths, /* generic options */
3640 optionlist_auths_size);
3642 for (au = auths; au != NULL; au = au->next)
3644 if (au->public_name == NULL)
3645 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3646 "the %s authenticator", au->name);
3647 for (bu = au->next; bu != NULL; bu = bu->next)
3649 if (strcmpic(au->public_name, bu->public_name) == 0)
3651 if ((au->client && bu->client) || (au->server && bu->server))
3652 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3653 "(%s and %s) have the same public name (%s)",
3654 (au->client)? US"client" : US"server", au->name, bu->name,
3664 /*************************************************
3665 * Read ACL information *
3666 *************************************************/
3668 /* If this run of Exim is not doing something that involves receiving a
3669 message, we can just skip over the ACL information. No need to parse it.
3671 First, we have a function for acl_read() to call back to get the next line. We
3672 need to remember the line we passed, because at the end it will contain the
3673 name of the next ACL. */
3675 static uschar *acl_line;
3680 acl_line = get_config_line();
3685 /* Now the main function:
3688 skip TRUE when this Exim process is doing something that will
3689 not need the ACL data
3695 readconf_acl(BOOL skip)
3699 /* Not receiving messages, don't need to parse the ACL data */
3703 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3704 while ((p = get_config_line()) != NULL);
3708 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3711 acl_line = get_config_line();
3713 while(acl_line != NULL)
3719 p = readconf_readname(name, sizeof(name), acl_line);
3720 if (isupper(*name) && *p == '=')
3722 read_macro_assignment(acl_line);
3723 acl_line = get_config_line();
3727 if (*p != ':' || name[0] == 0)
3728 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3730 node = store_get(sizeof(tree_node) + Ustrlen(name));
3731 Ustrcpy(node->name, name);
3732 if (!tree_insertnode(&acl_anchor, node))
3733 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3734 "there are two ACLs called \"%s\"", name);
3736 node->data.ptr = acl_read(acl_callback, &error);
3738 if (node->data.ptr == NULL && error != NULL)
3739 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3745 /*************************************************
3746 * Read configuration for local_scan() *
3747 *************************************************/
3749 /* This function is called after "begin local_scan" is encountered in the
3750 configuration file. If the local_scan() function allows for configuration
3751 options, we can process them. Otherwise, we expire in a panic.
3758 local_scan_init(void)
3760 #ifndef LOCAL_SCAN_HAS_OPTIONS
3761 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3762 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3766 while ((p = get_config_line()) != NULL)
3768 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3769 NULL, US"local_scan option \"%s\" unknown");
3776 /*************************************************
3777 * Read rest of configuration (after main) *
3778 *************************************************/
3780 /* This function reads the rest of the runtime configuration, after the main
3781 configuration. It is called only when actually needed. Each subsequent section
3782 of the configuration starts with a line of the form
3786 where the name is "routers", "transports", etc. A section is terminated by
3787 hitting the next "begin" line, and the next name is left in next_section.
3788 Because it may confuse people as to whether the names are singular or plural,
3789 we add "s" if it's missing. There is always enough room in next_section for
3790 this. This function is basically just a switch.
3793 skip_acl TRUE if ACL information is not needed
3798 static uschar *section_list[] = {
3808 readconf_rest(BOOL skip_acl)
3812 while(next_section[0] != 0)
3816 int last = sizeof(section_list) / sizeof(uschar *);
3818 int n = Ustrlen(next_section);
3820 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3824 int c = strcmpic(next_section, section_list[mid]);
3826 if (c > 0) first = mid + 1; else last = mid;
3828 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3829 "\"%.*s\" is not a known configuration section name", n, next_section);
3830 mid = (last + first)/2;
3834 if (((had ^= bit) & bit) == 0)
3835 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3836 "\"%.*s\" section is repeated in the configuration file", n,
3841 case 0: readconf_acl(skip_acl); break;
3842 case 1: auths_init(); break;
3843 case 2: local_scan_init(); break;
3844 case 3: readconf_retries(); break;
3845 case 4: readconf_rewrites(); break;
3846 case 5: route_init(); break;
3847 case 6: transport_init(); break;
3851 (void)fclose(config_file);
3854 /* End of readconf.c */