1 /* $Cambridge: exim/src/src/readconf.c,v 1.19 2006/02/13 12:02:59 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] == '\"')
815 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
817 save = store_get(sizeof(config_file_item));
818 save->next = config_file_stack;
819 config_file_stack = save;
820 save->file = config_file;
821 save->filename = config_filename;
822 save->lineno = config_lineno;
824 config_file = Ufopen(ss, "rb");
825 if (config_file == NULL)
826 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
827 "configuration file %s", ss);
828 config_filename = string_copy(ss);
833 /* If this is the start of the logical line, remember where the non-blank
834 data starts. Otherwise shuffle down continuation lines to remove leading
838 startoffset = ss - big_buffer;
841 s = big_buffer + len;
844 memmove(s, ss, (newlen - len) - (ss - s) + 1);
849 /* Accept the new addition to the line. Remove trailing white space. */
852 while (len > 0 && isspace(big_buffer[len-1])) len--;
855 /* We are done if the line does not end in backslash and contains some data.
856 Empty logical lines are ignored. For continuations, remove the backslash and
857 go round the loop to read the continuation line. */
861 if (big_buffer[len-1] != '\\') break; /* End of logical line */
862 big_buffer[--len] = 0; /* Remove backslash */
864 } /* Loop for reading multiple physical lines */
866 /* We now have a logical line. Test for the end of a configuration section (or,
867 more accurately, for the start of the next section). Place the name of the next
868 section in next_section, and return NULL. If the name given is longer than
869 next_section, truncate it. It will be unrecognized later, because all the known
870 section names do fit. Leave space for pluralizing. */
872 s = big_buffer + startoffset; /* First non-space character */
873 if (strncmpic(s, US"begin ", 6) == 0)
876 while (isspace(*s)) s++;
877 if (big_buffer + len - s > sizeof(next_section) - 2)
878 s[sizeof(next_section) - 2] = 0;
879 Ustrcpy(next_section, s);
883 /* Return the first non-blank character. */
890 /*************************************************
892 *************************************************/
894 /* The yield is the pointer to the next uschar. Names longer than the
895 output space are silently truncated. This function is also used from acl.c when
899 name where to put the name
903 Returns: new input pointer
907 readconf_readname(uschar *name, int len, uschar *s)
910 while (isspace(*s)) s++;
913 while (isalnum(*s) || *s == '_')
915 if (p < len-1) name[p++] = *s;
920 while (isspace(*s)) s++;
927 /*************************************************
928 * Read a time value *
929 *************************************************/
931 /* This function is also called from outside, to read argument
932 time values. The format of a time value is:
934 [<n>w][<n>d][<n>h][<n>m][<n>s]
936 as long as at least one is present. If a format error is encountered,
937 return a negative value. The value must be terminated by the given
942 terminator required terminating character
943 return_msec if TRUE, allow fractional seconds and return milliseconds
945 Returns: the time value, or -1 on syntax error
946 value is seconds if return_msec is FALSE
947 value is milliseconds if return_msec is TRUE
951 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
959 if (!isdigit(*s)) return -1;
960 (void)sscanf(CS s, "%d%n", &value, &count);
965 case 'w': value *= 7;
966 case 'd': value *= 24;
967 case 'h': value *= 60;
968 case 'm': value *= 60;
973 if (!return_msec) return -1;
974 (void)sscanf(CS s, "%lf%n", &fraction, &count);
976 if (*s++ != 's') return -1;
977 yield += (int)(fraction * 1000.0);
983 if (return_msec) value *= 1000;
985 if (*s == terminator) return yield;
987 /* Control never reaches here. */
992 /*************************************************
993 * Read a fixed point value *
994 *************************************************/
996 /* The value is returned *1000
1000 terminator required terminator
1002 Returns: the value, or -1 on error
1006 readconf_readfixed(uschar *s, int terminator)
1010 if (!isdigit(*s)) return -1;
1011 (void)sscanf(CS s, "%d%n", &value, &count);
1013 yield = value * 1000;
1017 while (isdigit((*(++s))))
1019 yield += (*s - '0') * m;
1024 return (*s == terminator)? yield : (-1);
1029 /*************************************************
1030 * Find option in list *
1031 *************************************************/
1033 /* The lists are always in order, so binary chop can be used.
1036 name the option name to search for
1037 ol the first entry in the option list
1038 last one more than the offset of the last entry in the option list
1040 Returns: pointer to an option entry, or NULL if not found
1044 find_option(uschar *name, optionlist *ol, int last)
1047 while (last > first)
1049 int middle = (first + last)/2;
1050 int c = Ustrcmp(name, ol[middle].name);
1051 if (c == 0) return ol + middle;
1052 else if (c > 0) first = middle + 1;
1060 /*************************************************
1061 * Find a set flag in option list *
1062 *************************************************/
1064 /* Because some versions of Unix make no restrictions on the values of uids and
1065 gids (even negative ones), we cannot represent "unset" by a special value.
1066 There is therefore a separate boolean variable for each one indicating whether
1067 a value is set or not. This function returns a pointer to the boolean, given
1068 the original option name. It is a major disaster if the flag cannot be found.
1071 name the name of the uid or gid option
1072 oltop points to the start of the relevant option list
1073 last one more than the offset of the last item in the option list
1074 data_block NULL when reading main options => data values in the option
1075 list are absolute addresses; otherwise they are byte offsets
1076 in data_block (used for driver options)
1078 Returns: a pointer to the boolean flag.
1082 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1086 sprintf(CS name2, "*set_%.50s", name);
1087 ol = find_option(name2, oltop, last);
1088 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1089 "Exim internal error: missing set flag for %s", name);
1090 return (data_block == NULL)? (BOOL *)(ol->value) :
1091 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1097 /*************************************************
1098 * Output extra characters message and die *
1099 *************************************************/
1101 /* Called when an option line has junk on the end. Sometimes this is because
1102 the sysadmin thinks comments are permitted.
1105 s points to the extra characters
1106 t1..t3 strings to insert in the log message
1108 Returns: doesn't return; dies
1112 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1114 uschar *comment = US"";
1115 if (*s == '#') comment = US" (# is comment only at line start)";
1116 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1117 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1122 /*************************************************
1123 * Read rewrite information *
1124 *************************************************/
1126 /* Each line of rewrite information contains:
1128 . A complete address in the form user@domain, possibly with
1129 leading * for each part; or alternatively, a regex.
1131 . A replacement string (which will be expanded).
1133 . An optional sequence of one-letter flags, indicating which
1134 headers etc. to apply this rule to.
1136 All this is decoded and placed into a control block. The OR of the flags is
1137 maintained in a common word.
1140 p points to the string that makes up the rule
1141 existflags points to the overall flag word
1142 isglobal TRUE if reading global rewrite rules
1144 Returns: the control block for the parsed rule.
1147 static rewrite_rule *
1148 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1150 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1153 next->key = string_dequote(&p);
1155 while (isspace(*p)) p++;
1157 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1158 "missing rewrite replacement string");
1161 next->replacement = string_dequote(&p);
1163 while (*p != 0) switch (*p++)
1165 case ' ': case '\t': break;
1167 case 'q': next->flags |= rewrite_quit; break;
1168 case 'w': next->flags |= rewrite_whole; break;
1170 case 'h': next->flags |= rewrite_all_headers; break;
1171 case 's': next->flags |= rewrite_sender; break;
1172 case 'f': next->flags |= rewrite_from; break;
1173 case 't': next->flags |= rewrite_to; break;
1174 case 'c': next->flags |= rewrite_cc; break;
1175 case 'b': next->flags |= rewrite_bcc; break;
1176 case 'r': next->flags |= rewrite_replyto; break;
1178 case 'E': next->flags |= rewrite_all_envelope; break;
1179 case 'F': next->flags |= rewrite_envfrom; break;
1180 case 'T': next->flags |= rewrite_envto; break;
1182 case 'Q': next->flags |= rewrite_qualify; break;
1183 case 'R': next->flags |= rewrite_repeat; break;
1186 next->flags |= rewrite_smtp;
1187 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1188 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1189 "rewrite rule has the S flag but is not a regular expression");
1193 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1194 "unknown rewrite flag character '%c' "
1195 "(could be missing quotes round replacement item)", p[-1]);
1199 /* If no action flags are set, set all the "normal" rewrites. */
1201 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1202 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1204 /* Remember which exist, for optimization, and return the rule */
1206 *existflags |= next->flags;
1213 /*************************************************
1214 * Read global rewrite information *
1215 *************************************************/
1217 /* Each line is a single rewrite rule; it is parsed into a control block
1218 by readconf_one_rewrite(), and its flags are ORed into the global flag
1219 word rewrite_existflags. */
1222 readconf_rewrites(void)
1224 rewrite_rule **chain = &global_rewrite_rules;
1227 while ((p = get_config_line()) != NULL)
1229 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1231 chain = &(next->next);
1237 /*************************************************
1239 *************************************************/
1241 /* Strings are read into the normal store pool. As long we aren't too
1242 near the end of the current block, the string will just use what is necessary
1243 on the top of the stacking pool, because string_cat() uses the extension
1247 s the rest of the input line
1248 name the option name (for errors)
1250 Returns: pointer to the string
1254 read_string(uschar *s, uschar *name)
1259 if (*s != '\"') return string_copy(s);
1262 yield = string_dequote(&s);
1264 if (s == ss+1 || s[-1] != '\"')
1265 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1266 "missing quote at end of string value for %s", name);
1268 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1274 /*************************************************
1275 * Handle option line *
1276 *************************************************/
1278 /* This function is called from several places to process a line containing the
1279 setting of an option. The first argument is the line to be decoded; it has been
1280 checked not to be empty and not to start with '#'. Trailing newlines and white
1281 space have been removed. The second argument is a pointer to the list of
1282 variable names that are to be recognized, together with their types and
1283 locations, and the third argument gives the number of entries in the list.
1285 The fourth argument is a pointer to a data block. If it is NULL, then the data
1286 values in the options list are absolute addresses. Otherwise, they are byte
1287 offsets in the data block.
1289 String option data may continue onto several lines; this function reads further
1290 data from config_file if necessary.
1292 The yield of this function is normally zero. If a string continues onto
1293 multiple lines, then the data value is permitted to be followed by a comma
1294 or a semicolon (for use in drivers) and the yield is that character.
1297 buffer contains the configuration line to be handled
1298 oltop points to the start of the relevant option list
1299 last one more than the offset of the last item in the option list
1300 data_block NULL when reading main options => data values in the option
1301 list are absolute addresses; otherwise they are byte offsets
1302 in data_block when they have opt_public set; otherwise
1303 they are byte offsets in data_block->options_block.
1304 unknown_txt format string to use in panic message for unknown option;
1305 must contain %s for option name
1306 if given as NULL, don't panic on unknown option
1308 Returns: TRUE if an option was read successfully,
1309 FALSE false for an unknown option if unknown_txt == NULL,
1310 otherwise panic and die on an unknown option
1314 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1315 void *data_block, uschar *unknown_txt)
1319 int n, count, type, value;
1323 BOOL boolvalue = TRUE;
1324 BOOL freesptr = TRUE;
1325 optionlist *ol, *ol2;
1329 uschar *inttype = US"";
1335 /* There may be leading spaces; thereafter, we expect an option name starting
1338 while (isspace(*s)) s++;
1340 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1342 /* Read the name of the option, and skip any subsequent white space. If
1343 it turns out that what we read was "hide", set the flag indicating that
1344 this is a secure option, and loop to read the next word. */
1346 for (n = 0; n < 2; n++)
1348 while (isalnum(*s) || *s == '_')
1350 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1354 while (isspace(*s)) s++;
1355 if (Ustrcmp(name, "hide") != 0) break;
1356 issecure = opt_secure;
1360 /* Deal with "no_" or "not_" here for booleans */
1362 if (Ustrncmp(name, "no_", 3) == 0)
1368 if (Ustrncmp(name, "not_", 4) == 0)
1374 /* Search the list for the given name. A non-existent name, or an option that
1375 is set twice, is a disaster. */
1377 ol = find_option(name + offset, oltop, last);
1381 if (unknown_txt == NULL) return FALSE;
1382 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1385 if ((ol->type & opt_set) != 0)
1387 uschar *mname = name;
1388 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1389 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1390 "\"%s\" option set for the second time", mname);
1393 ol->type |= opt_set | issecure;
1394 type = ol->type & opt_mask;
1396 /* Types with data values must be followed by '='; the "no[t]_" prefix
1397 applies only to boolean values. */
1399 if (type < opt_bool || type > opt_bool_last)
1402 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1403 "negation prefix applied to a non-boolean option");
1405 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1406 "unexpected end of line (data missing) after %s", name);
1408 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1411 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1412 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1413 ultimately expands to one of those values. */
1415 else if (*s != 0 && (offset != 0 || *s != '='))
1416 extra_chars_error(s, US"boolean option ", name, US"");
1418 /* Skip white space after = */
1420 if (*s == '=') while (isspace((*(++s))));
1422 /* If there is a data block and the opt_public flag is not set, change
1423 the data block pointer to the private options block. */
1425 if (data_block != NULL && (ol->type & opt_public) == 0)
1426 data_block = (void *)(((driver_instance *)data_block)->options_block);
1428 /* Now get the data according to the type. */
1432 /* If a string value is not enclosed in quotes, it consists of
1433 the rest of the current line, verbatim. Otherwise, string escapes
1436 A transport is specified as a string, which is then looked up in the
1437 list of transports. A search type is specified as one of a number of
1440 A set or rewrite rules for a driver is specified as a string, which is
1441 then parsed into a suitable chain of control blocks.
1443 Uids and gids are specified as strings which are then looked up in the
1444 passwd file. Lists of uids and gids are similarly specified as colon-
1445 separated strings. */
1450 case opt_expand_uid:
1451 case opt_expand_gid:
1456 reset_point = sptr = read_string(s, name);
1458 /* Having read a string, we now have several different ways of using it,
1459 depending on the data type, so do another switch. If keeping the actual
1460 string is not required (because it is interpreted), freesptr is set TRUE,
1461 and at the end we reset the pool. */
1465 /* If this was a string, set the variable to point to the new string,
1466 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1467 rules, we still keep the string (for printing), and parse the rules into a
1468 control block and flags word. */
1472 if (data_block == NULL)
1473 *((uschar **)(ol->value)) = sptr;
1475 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1477 if (type == opt_rewrite)
1482 rewrite_rule **chain;
1485 sprintf(CS name2, "*%.50s_rules", name);
1486 ol2 = find_option(name2, oltop, last);
1487 sprintf(CS name2, "*%.50s_flags", name);
1488 ol3 = find_option(name2, oltop, last);
1490 if (ol2 == NULL || ol3 == NULL)
1491 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1492 "rewrite rules not available for driver");
1494 if (data_block == NULL)
1496 chain = (rewrite_rule **)(ol2->value);
1497 flagptr = (int *)(ol3->value);
1501 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1502 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1505 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1508 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1510 chain = &(next->next);
1513 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1514 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1515 "non-header rewrite - not allowed at transport time -");
1519 /* If it was an expanded uid, see if there is any expansion to be
1520 done by checking for the presence of a $ character. If there is, save it
1521 in the corresponding *expand_user option field. Otherwise, fall through
1522 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1525 case opt_expand_uid:
1526 sprintf(CS name2, "*expand_%.50s", name);
1527 ol2 = find_option(name2, oltop, last);
1530 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1532 if (data_block == NULL)
1533 *((uschar **)(ol2->value)) = ss;
1535 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1539 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1545 /* Look up a fixed uid, and also make use of the corresponding gid
1546 if a passwd entry is returned and the gid has not been set. */
1549 if (!route_finduser(sptr, &pw, &uid))
1550 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1551 if (data_block == NULL)
1552 *((uid_t *)(ol->value)) = uid;
1554 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1556 /* Set the flag indicating a fixed value is set */
1558 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1560 /* Handle matching gid if we have a passwd entry: done by finding the
1561 same name with terminating "user" changed to "group"; if not found,
1562 ignore. Also ignore if the value is already set. */
1564 if (pw == NULL) break;
1565 Ustrcpy(name+Ustrlen(name)-4, "group");
1566 ol2 = find_option(name, oltop, last);
1567 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1568 (ol2->type & opt_mask) == opt_expand_gid))
1570 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1573 if (data_block == NULL)
1574 *((gid_t *)(ol2->value)) = pw->pw_gid;
1576 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1582 /* If it was an expanded gid, see if there is any expansion to be
1583 done by checking for the presence of a $ character. If there is, save it
1584 in the corresponding *expand_user option field. Otherwise, fall through
1585 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1588 case opt_expand_gid:
1589 sprintf(CS name2, "*expand_%.50s", name);
1590 ol2 = find_option(name2, oltop, last);
1593 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1595 if (data_block == NULL)
1596 *((uschar **)(ol2->value)) = ss;
1598 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1602 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1608 /* Handle freestanding gid */
1611 if (!route_findgroup(sptr, &gid))
1612 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1613 if (data_block == NULL)
1614 *((gid_t *)(ol->value)) = gid;
1616 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1617 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1620 /* If it was a uid list, look up each individual entry, and build
1621 a vector of uids, with a count in the first element. Put the vector
1622 in malloc store so we can free the string. (We are reading into
1623 permanent store already.) */
1631 uschar *op = expand_string (sptr);
1634 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1635 name, expand_string_message);
1638 if (*p != 0) count++;
1639 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1640 list = store_malloc(count*sizeof(uid_t));
1641 list[ptr++] = (uid_t)(count - 1);
1643 if (data_block == NULL)
1644 *((uid_t **)(ol->value)) = list;
1646 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1652 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1653 if (!route_finduser(big_buffer, NULL, &uid))
1654 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1661 /* If it was a gid list, look up each individual entry, and build
1662 a vector of gids, with a count in the first element. Put the vector
1663 in malloc store so we can free the string. (We are reading into permanent
1672 uschar *op = expand_string (sptr);
1675 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1676 name, expand_string_message);
1679 if (*p != 0) count++;
1680 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1681 list = store_malloc(count*sizeof(gid_t));
1682 list[ptr++] = (gid_t)(count - 1);
1684 if (data_block == NULL)
1685 *((gid_t **)(ol->value)) = list;
1687 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1693 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1694 if (!route_findgroup(big_buffer, &gid))
1695 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1703 /* Release store if the value of the string doesn't need to be kept. */
1705 if (freesptr) store_reset(reset_point);
1708 /* Expanded boolean: if no characters follow, or if there are no dollar
1709 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1710 save the string for later expansion in the alternate place. */
1712 case opt_expand_bool:
1713 if (*s != 0 && Ustrchr(s, '$') != 0)
1715 sprintf(CS name2, "*expand_%.50s", name);
1716 ol2 = find_option(name2, oltop, last);
1719 reset_point = sptr = read_string(s, name);
1720 if (data_block == NULL)
1721 *((uschar **)(ol2->value)) = sptr;
1723 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1730 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1731 look for yes/not/true/false. Some booleans are stored in a single bit in
1732 a single int. There's a special fudge for verify settings; without a suffix
1733 they set both xx_sender and xx_recipient. The table points to the sender
1734 value; search subsequently for the recipient. There's another special case:
1735 opt_bool_set also notes when a boolean has been set. */
1739 case opt_bool_verify:
1743 s = readconf_readname(name2, 64, s);
1744 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1746 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1748 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1749 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1750 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1751 US"for boolean option ", name);
1754 /* Handle single-bit type. */
1756 if (type == opt_bit)
1758 int bit = 1 << ((ol->type >> 16) & 31);
1759 int *ptr = (data_block == NULL)?
1760 (int *)(ol->value) :
1761 (int *)((uschar *)data_block + (long int)ol->value);
1762 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1766 /* Handle full BOOL types */
1768 if (data_block == NULL)
1769 *((BOOL *)(ol->value)) = boolvalue;
1771 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1775 if (type == opt_bool_verify)
1777 sprintf(CS name2, "%.50s_recipient", name + offset);
1778 ol2 = find_option(name2, oltop, last);
1781 if (data_block == NULL)
1782 *((BOOL *)(ol2->value)) = boolvalue;
1784 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1788 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1790 else if (type == opt_bool_set)
1792 sprintf(CS name2, "*set_%.50s", name + offset);
1793 ol2 = find_option(name2, oltop, last);
1796 if (data_block == NULL)
1797 *((BOOL *)(ol2->value)) = TRUE;
1799 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1808 inttype = US"octal ";
1810 /* Integer: a simple(ish) case; allow octal and hex formats, and
1811 suffixes K and M. The different types affect output, not input. */
1818 value = strtol(CS s, CSS &endptr, intbase);
1821 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1824 if (errno != ERANGE)
1826 if (tolower(*endptr) == 'k')
1828 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1832 else if (tolower(*endptr) == 'm')
1834 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
1836 else value *= 1024*1024;
1841 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1842 "absolute value of integer \"%s\" is too large (overflow)", s);
1844 while (isspace(*endptr)) endptr++;
1846 extra_chars_error(endptr, inttype, US"integer value for ", name);
1849 if (data_block == NULL)
1850 *((int *)(ol->value)) = value;
1852 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1855 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1862 value = strtol(CS s, CSS &endptr, intbase);
1865 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1868 if (errno != ERANGE)
1870 if (tolower(*endptr) == 'm')
1872 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1876 else if (tolower(*endptr) == 'k')
1882 value = (value + 512)/1024;
1886 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1887 "absolute value of integer \"%s\" is too large (overflow)", s);
1889 while (isspace(*endptr)) endptr++;
1891 extra_chars_error(endptr, inttype, US"integer value for ", name);
1894 if (data_block == NULL)
1895 *((int *)(ol->value)) = value;
1897 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1900 /* Fixed-point number: held to 3 decimal places. */
1903 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1904 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1905 "fixed-point number expected for %s", name);
1907 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1908 "integer \"%s\" is too large (overflow)", s);
1912 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1913 "integer \"%s\" is too large (overflow)", s);
1915 if (s[count] == '.')
1918 while (isdigit(s[++count]))
1920 value += (s[count] - '0') * d;
1925 while (isspace(s[count])) count++;
1928 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1930 if (data_block == NULL)
1931 *((int *)(ol->value)) = value;
1933 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1936 /* There's a special routine to read time values. */
1939 value = readconf_readtime(s, 0, FALSE);
1941 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1943 if (data_block == NULL)
1944 *((int *)(ol->value)) = value;
1946 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1949 /* A time list is a list of colon-separated times, with the first
1950 element holding the size of the list and the second the number of
1956 int *list = (data_block == NULL)?
1957 (int *)(ol->value) :
1958 (int *)((uschar *)data_block + (long int)(ol->value));
1960 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1963 uschar *snext = Ustrchr(s, ':');
1967 while (ss > s && isspace(ss[-1])) ss--;
1970 value = readconf_readtime(s, terminator, FALSE);
1972 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1974 if (count > 1 && value <= list[count])
1975 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1976 "time value out of order for %s", name);
1977 list[count+1] = value;
1978 if (snext == NULL) break;
1980 while (isspace(*s)) s++;
1983 if (count > list[0] - 2)
1984 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
1986 if (count > 0 && list[2] == 0) count = 0;
1998 /*************************************************
1999 * Print a time value *
2000 *************************************************/
2003 Argument: a time value in seconds
2004 Returns: pointer to a fixed buffer containing the time as a string,
2005 in readconf_readtime() format
2009 readconf_printtime(int t)
2012 uschar *p = time_buffer;
2029 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2030 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2031 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2032 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2033 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2040 /*************************************************
2041 * Print an individual option value *
2042 *************************************************/
2044 /* This is used by the -bP option, so prints to the standard output.
2045 The entire options list is passed in as an argument, because some options come
2046 in pairs - typically uid/gid settings, which can either be explicit numerical
2047 values, or strings to be expanded later. If the numerical value is unset,
2048 search for "*expand_<name>" to see if there is a string equivalent.
2051 ol option entry, or NULL for an unknown option
2053 options_block NULL for main configuration options; otherwise points to
2054 a driver block; if the option doesn't have opt_public
2055 set, then options_block->options_block is where the item
2057 oltop points to the option list in which ol exists
2058 last one more than the offset of the last entry in optop
2064 print_ol(optionlist *ol, uschar *name, void *options_block,
2065 optionlist *oltop, int last)
2078 printf("%s is not a known option\n", name);
2082 /* Non-admin callers cannot see options that have been flagged secure by the
2085 if (!admin_user && (ol->type & opt_secure) != 0)
2087 printf("%s = <value not displayable>\n", name);
2091 /* Else show the value of the option */
2094 if (options_block != NULL)
2096 if ((ol->type & opt_public) == 0)
2097 options_block = (void *)(((driver_instance *)options_block)->options_block);
2098 value = (void *)((uschar *)options_block + (long int)value);
2101 switch(ol->type & opt_mask)
2104 case opt_rewrite: /* Show the text value */
2105 s = *((uschar **)value);
2106 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2110 printf("%s = %d\n", name, *((int *)value));
2115 int x = *((int *)value);
2116 if (x != 0 && (x & 1023) == 0)
2120 if ((x & 1023) == 0)
2125 printf("%s = %d%c\n", name, x, c);
2127 else printf("%s = %d\n", name, x);
2133 int x = *((int *)value);
2134 if (x == 0) printf("%s = 0\n", name);
2135 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2136 else printf("%s = %dK\n", name, x);
2141 printf("%s = %#o\n", name, *((int *)value));
2144 /* Can be negative only when "unset", in which case integer */
2148 int x = *((int *)value);
2151 if (x < 0) printf("%s =\n", name); else
2153 printf("%s = %d.", name, x/1000);
2166 /* If the numerical value is unset, try for the string value */
2168 case opt_expand_uid:
2169 if (! *get_set_flag(name, oltop, last, options_block))
2171 sprintf(CS name2, "*expand_%.50s", name);
2172 ol2 = find_option(name2, oltop, last);
2175 void *value2 = ol2->value;
2176 if (options_block != NULL)
2177 value2 = (void *)((uschar *)options_block + (long int)value2);
2178 s = *((uschar **)value2);
2179 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2184 /* Else fall through */
2187 if (! *get_set_flag(name, oltop, last, options_block))
2188 printf("%s =\n", name);
2191 pw = getpwuid(*((uid_t *)value));
2193 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2194 else printf("%s = %s\n", name, pw->pw_name);
2198 /* If the numerical value is unset, try for the string value */
2200 case opt_expand_gid:
2201 if (! *get_set_flag(name, oltop, last, options_block))
2203 sprintf(CS name2, "*expand_%.50s", name);
2204 ol2 = find_option(name2, oltop, last);
2205 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2207 void *value2 = ol2->value;
2208 if (options_block != NULL)
2209 value2 = (void *)((uschar *)options_block + (long int)value2);
2210 s = *((uschar **)value2);
2211 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2216 /* Else fall through */
2219 if (! *get_set_flag(name, oltop, last, options_block))
2220 printf("%s =\n", name);
2223 gr = getgrgid(*((int *)value));
2225 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2226 else printf("%s = %s\n", name, gr->gr_name);
2231 uidlist = *((uid_t **)value);
2232 printf("%s =", name);
2233 if (uidlist != NULL)
2237 for (i = 1; i <= (int)(uidlist[0]); i++)
2239 uschar *name = NULL;
2240 pw = getpwuid(uidlist[i]);
2241 if (pw != NULL) name = US pw->pw_name;
2242 if (name != NULL) printf("%c%s", sep, name);
2243 else printf("%c%ld", sep, (long int)(uidlist[i]));
2251 gidlist = *((gid_t **)value);
2252 printf("%s =", name);
2253 if (gidlist != NULL)
2257 for (i = 1; i <= (int)(gidlist[0]); i++)
2259 uschar *name = NULL;
2260 gr = getgrgid(gidlist[i]);
2261 if (gr != NULL) name = US gr->gr_name;
2262 if (name != NULL) printf("%c%s", sep, name);
2263 else printf("%c%ld", sep, (long int)(gidlist[i]));
2271 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2277 int *list = (int *)value;
2278 printf("%s = ", name);
2279 for (i = 0; i < list[1]; i++)
2280 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2286 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2290 case opt_expand_bool:
2291 sprintf(CS name2, "*expand_%.50s", name);
2292 ol2 = find_option(name2, oltop, last);
2293 if (ol2 != NULL && ol2->value != NULL)
2295 void *value2 = ol2->value;
2296 if (options_block != NULL)
2297 value2 = (void *)((uschar *)options_block + (long int)value2);
2298 s = *((uschar **)value2);
2301 printf("%s = %s\n", name, string_printing(s));
2304 /* s == NULL => string not set; fall through */
2310 case opt_bool_verify:
2312 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2319 /*************************************************
2320 * Print value from main configuration *
2321 *************************************************/
2323 /* This function, called as a result of encountering the -bP option,
2324 causes the value of any main configuration variable to be output if the
2325 second argument is NULL. There are some special values:
2327 all print all main configuration options
2328 configure_file print the name of the configuration file
2329 routers print the routers' configurations
2330 transports print the transports' configuration
2331 authenticators print the authenticators' configuration
2332 router_list print a list of router names
2333 transport_list print a list of transport names
2334 authenticator_list print a list of authentication mechanism names
2335 +name print a named list item
2336 local_scan print the local_scan options
2338 If the second argument is not NULL, it must be one of "router", "transport", or
2339 "authenticator" in which case the first argument identifies the driver whose
2340 options are to be printed.
2343 name option name if type == NULL; else driver name
2344 type NULL or driver type name, as described above
2350 readconf_print(uschar *name, uschar *type)
2352 BOOL names_only = FALSE;
2354 optionlist *ol2 = NULL;
2355 driver_instance *d = NULL;
2365 static uschar *types[] = { US"address", US"domain", US"host",
2367 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2368 &hostlist_anchor, &localpartlist_anchor };
2370 for (i = 0; i < 4; i++)
2372 t = tree_search(*(anchors[i]), name+1);
2376 printf("%slist %s = %s\n", types[i], name+1,
2377 ((namedlist_block *)(t->data.ptr))->string);
2382 printf("no address, domain, host, or local part list called \"%s\" "
2383 "exists\n", name+1);
2388 if (Ustrcmp(name, "configure_file") == 0)
2390 printf("%s\n", CS config_main_filename);
2394 if (Ustrcmp(name, "all") == 0)
2396 for (ol = optionlist_config;
2397 ol < optionlist_config + optionlist_config_size; ol++)
2399 if ((ol->type & opt_hidden) == 0)
2400 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2405 if (Ustrcmp(name, "local_scan") == 0)
2407 #ifndef LOCAL_SCAN_HAS_OPTIONS
2408 printf("local_scan() options are not supported\n");
2410 for (ol = local_scan_options;
2411 ol < local_scan_options + local_scan_options_count; ol++)
2413 print_ol(ol, US ol->name, NULL, local_scan_options,
2414 local_scan_options_count);
2420 if (Ustrcmp(name, "routers") == 0)
2425 else if (Ustrcmp(name, "transports") == 0)
2427 type = US"transport";
2431 else if (Ustrcmp(name, "authenticators") == 0)
2433 type = US"authenticator";
2437 else if (Ustrcmp(name, "authenticator_list") == 0)
2439 type = US"authenticator";
2444 else if (Ustrcmp(name, "router_list") == 0)
2450 else if (Ustrcmp(name, "transport_list") == 0)
2452 type = US"transport";
2458 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2459 name, NULL, optionlist_config, optionlist_config_size);
2464 /* Handle the options for a router or transport. Skip options that are flagged
2465 as hidden. Some of these are options with names starting with '*', used for
2466 internal alternative representations of other options (which the printing
2467 function will sort out). Others are synonyms kept for backward compatibility.
2470 if (Ustrcmp(type, "router") == 0)
2472 d = (driver_instance *)routers;
2473 ol2 = optionlist_routers;
2474 size = optionlist_routers_size;
2476 else if (Ustrcmp(type, "transport") == 0)
2478 d = (driver_instance *)transports;
2479 ol2 = optionlist_transports;
2480 size = optionlist_transports_size;
2482 else if (Ustrcmp(type, "authenticator") == 0)
2484 d = (driver_instance *)auths;
2485 ol2 = optionlist_auths;
2486 size = optionlist_auths_size;
2491 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2495 /* Either search for a given driver, or print all of them */
2497 for (; d != NULL; d = d->next)
2500 printf("\n%s %s:\n", d->name, type);
2501 else if (Ustrcmp(d->name, name) != 0) continue;
2503 for (ol = ol2; ol < ol2 + size; ol++)
2505 if ((ol->type & opt_hidden) == 0)
2506 print_ol(ol, US ol->name, d, ol2, size);
2509 for (ol = d->info->options;
2510 ol < d->info->options + *(d->info->options_count); ol++)
2512 if ((ol->type & opt_hidden) == 0)
2513 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2515 if (name != NULL) return;
2517 if (name != NULL) printf("%s %s not found\n", type, name);
2522 /*************************************************
2523 * Read a named list item *
2524 *************************************************/
2526 /* This function reads a name and a list (i.e. string). The name is used to
2527 save the list in a tree, sorted by its name. Each entry also has a number,
2528 which can be used for caching tests, but if the string contains any expansion
2529 items other than $key, the number is set negative to inhibit caching. This
2530 mechanism is used for domain, host, and address lists that are referenced by
2534 anchorp points to the tree anchor
2535 numberp points to the current number for this tree
2536 max the maximum number permitted
2537 s the text of the option line, starting immediately after the name
2539 tname the name of the list type, for messages
2545 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2548 BOOL forcecache = FALSE;
2551 namedlist_block *nb = store_get(sizeof(namedlist_block));
2553 if (Ustrncmp(s, "_cache", 6) == 0)
2560 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2562 if (*numberp >= max)
2563 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2566 while (isspace(*s)) s++;
2568 while (isalnum(*s) || *s == '_') s++;
2569 t = store_get(sizeof(tree_node) + s-ss);
2570 Ustrncpy(t->name, ss, s-ss);
2572 while (isspace(*s)) s++;
2574 if (!tree_insertnode(anchorp, t))
2575 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2576 "duplicate name \"%s\" for a named %s", t->name, tname);
2579 nb->number = *numberp;
2582 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2583 "missing '=' after \"%s\"", t->name);
2584 while (isspace(*s)) s++;
2585 nb->string = read_string(s, t->name);
2586 nb->cache_data = NULL;
2588 /* Check the string for any expansions; if any are found, mark this list
2589 uncacheable unless the user has explicited forced caching. */
2591 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2597 /*************************************************
2598 * Unpick data for a rate limit *
2599 *************************************************/
2601 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2605 s string, in the form t,b,f,l
2606 where t is the threshold (integer)
2607 b is the initial delay (time)
2608 f is the multiplicative factor (fixed point)
2609 k is the maximum time (time)
2610 threshold where to store threshold
2611 base where to store base in milliseconds
2612 factor where to store factor in milliseconds
2613 limit where to store limit
2615 Returns: nothing (panics on error)
2619 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2622 uschar bstring[16], lstring[16];
2624 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2625 factor, lstring) == 4)
2627 *base = readconf_readtime(bstring, 0, TRUE);
2628 *limit = readconf_readtime(lstring, 0, TRUE);
2629 if (*base >= 0 && *limit >= 0) return;
2631 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2637 /*************************************************
2638 * Read main configuration options *
2639 *************************************************/
2641 /* This function is the first to be called for configuration reading. It
2642 opens the configuration file and reads general configuration settings until
2643 it reaches the end of the configuration section. The file is then left open so
2644 that the remaining configuration data can subsequently be read if needed for
2647 The configuration file must be owned either by root or exim, and be writeable
2648 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2649 in the config file, so the test is done on the compiled in values. A slight
2650 anomaly, to be carefully documented.
2652 The name of the configuration file is taken from a list that is included in the
2653 binary of Exim. It can be altered from the command line, but if that is done,
2654 root privilege is immediately withdrawn unless the caller is root or exim.
2655 The first file on the list that exists is used.
2657 For use on multiple systems that share file systems, first look for a
2658 configuration file whose name has the current node name on the end. If that is
2659 not found, try the generic name. For really contorted configurations, that run
2660 multiple Exims with different uid settings, first try adding the effective uid
2661 before the node name. These complications are going to waste resources on most
2662 systems. Therefore they are available only when requested by compile-time
2669 struct stat statbuf;
2670 uschar *s, *filename;
2671 uschar *list = config_main_filelist;
2673 /* Loop through the possible file names */
2675 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2678 /* Cut out all the fancy processing unless specifically wanted */
2680 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2681 uschar *suffix = filename + Ustrlen(filename);
2683 /* Try for the node-specific file if a node name exists */
2685 #ifdef CONFIGURE_FILE_USE_NODE
2687 if (uname(&uts) >= 0)
2689 #ifdef CONFIGURE_FILE_USE_EUID
2690 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2691 config_file = Ufopen(filename, "rb");
2692 if (config_file == NULL)
2693 #endif /* CONFIGURE_FILE_USE_EUID */
2695 sprintf(CS suffix, ".%.256s", uts.nodename);
2696 config_file = Ufopen(filename, "rb");
2699 #endif /* CONFIGURE_FILE_USE_NODE */
2701 /* Otherwise, try the generic name, possibly with the euid added */
2703 #ifdef CONFIGURE_FILE_USE_EUID
2704 if (config_file == NULL)
2706 sprintf(CS suffix, ".%ld", (long int)original_euid);
2707 config_file = Ufopen(filename, "rb");
2709 #endif /* CONFIGURE_FILE_USE_EUID */
2711 /* Finally, try the unadorned name */
2713 if (config_file == NULL)
2716 config_file = Ufopen(filename, "rb");
2718 #else /* if neither defined */
2720 /* This is the common case when the fancy processing is not included. */
2722 config_file = Ufopen(filename, "rb");
2725 /* If the file does not exist, continue to try any others. For any other
2726 error, break out (and die). */
2728 if (config_file != NULL || errno != ENOENT) break;
2731 /* On success, save the name for verification; config_filename is used when
2732 logging configuration errors (it changes for .included files) whereas
2733 config_main_filename is the name shown by -bP. Failure to open a configuration
2734 file is a serious disaster. */
2736 if (config_file != NULL)
2738 config_filename = config_main_filename = string_copy(filename);
2742 if (filename == NULL)
2743 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2744 "%s", config_main_filelist);
2746 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2747 "configuration file %s", filename));
2750 /* Check the status of the file we have opened, unless it was specified on
2751 the command line, in which case privilege was given away at the start. */
2753 if (!config_changed)
2755 if (fstat(fileno(config_file), &statbuf) != 0)
2756 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2759 if ((statbuf.st_uid != root_uid && /* owner not root */
2760 statbuf.st_uid != exim_uid /* owner not exim */
2761 #ifdef CONFIGURE_OWNER
2762 && statbuf.st_uid != config_uid /* owner not the special one */
2765 (statbuf.st_gid != exim_gid /* group not exim & */
2766 #ifdef CONFIGURE_GROUP
2767 && statbuf.st_gid != config_gid /* group not the special one */
2769 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2771 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2773 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2774 "wrong owner, group, or mode", big_buffer);
2777 /* Process the main configuration settings. They all begin with a lower case
2778 letter. If we see something starting with an upper case letter, it is taken as
2779 a macro definition. */
2781 while ((s = get_config_line()) != NULL)
2783 if (isupper(s[0])) read_macro_assignment(s);
2785 else if (Ustrncmp(s, "domainlist", 10) == 0)
2786 read_named_list(&domainlist_anchor, &domainlist_count,
2787 MAX_NAMED_LIST, s+10, US"domain list");
2789 else if (Ustrncmp(s, "hostlist", 8) == 0)
2790 read_named_list(&hostlist_anchor, &hostlist_count,
2791 MAX_NAMED_LIST, s+8, US"host list");
2793 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2794 read_named_list(&addresslist_anchor, &addresslist_count,
2795 MAX_NAMED_LIST, s+11, US"address list");
2797 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2798 read_named_list(&localpartlist_anchor, &localpartlist_count,
2799 MAX_NAMED_LIST, s+13, US"local part list");
2802 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2803 NULL, US"main option \"%s\" unknown");
2807 /* If local_sender_retain is set, local_from_check must be unset. */
2809 if (local_sender_retain && local_from_check)
2810 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2811 "local_sender_retain are set; this combination is not allowed");
2813 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2816 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2818 /* remote_max_parallel must be > 0 */
2820 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2822 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2823 start of a new SMTP message. */
2825 freeze_tell_config = freeze_tell;
2827 /* The primary host name may be required for expansion of spool_directory
2828 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2829 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2830 canonize it. Some people like upper case letters in their host names, so we
2831 don't force the case. */
2833 if (primary_hostname == NULL)
2837 if (uname(&uts) < 0)
2838 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2839 hostname = US uts.nodename;
2841 if (Ustrchr(hostname, '.') == NULL)
2844 struct hostent *hostdata;
2847 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2848 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2858 #if HAVE_GETIPNODEBYNAME
2860 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2862 hostdata = gethostbyname2(CS hostname, af);
2865 hostdata = gethostbyname(CS hostname);
2868 if (hostdata != NULL)
2870 hostname = US hostdata->h_name;
2874 if (af == AF_INET) break;
2879 primary_hostname = string_copy(hostname);
2882 /* Set up default value for smtp_active_hostname */
2884 smtp_active_hostname = primary_hostname;
2886 /* If spool_directory wasn't set in the build-time configuration, it must have
2887 got set above. Of course, writing to the log may not work if log_file_path is
2888 not set, but it will at least get to syslog or somewhere, with any luck. */
2890 if (*spool_directory == 0)
2891 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2894 /* Expand the spool directory name; it may, for example, contain the primary
2895 host name. Same comment about failure. */
2897 s = expand_string(spool_directory);
2899 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2900 "\"%s\": %s", spool_directory, expand_string_message);
2901 spool_directory = s;
2903 /* Expand log_file_path, which must contain "%s" in any component that isn't
2904 the null string or "syslog". It is also allowed to contain one instance of %D.
2905 However, it must NOT contain % followed by anything else. */
2907 if (*log_file_path != 0)
2910 int sep = ':'; /* Fixed for log file path */
2911 s = expand_string(log_file_path);
2913 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2914 "\"%s\": %s", log_file_path, expand_string_message);
2917 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
2920 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
2921 t = Ustrstr(sss, "%s");
2923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
2924 "contain \"%%s\"", sss);
2926 t = Ustrchr(sss, '%');
2929 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
2930 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
2931 "unexpected \"%%\" character", s);
2938 /* Interpret syslog_facility into an integer argument for 'ident' param to
2939 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
2942 if (syslog_facility_str != NULL)
2945 uschar *s = syslog_facility_str;
2947 if ((Ustrlen(syslog_facility_str) >= 4) &&
2948 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
2951 for (i = 0; i < syslog_list_size; i++)
2953 if (strcmpic(s, syslog_list[i].name) == 0)
2955 syslog_facility = syslog_list[i].value;
2960 if (i >= syslog_list_size)
2962 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
2963 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
2967 /* Expand pid_file_path */
2969 if (*pid_file_path != 0)
2971 s = expand_string(pid_file_path);
2973 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
2974 "\"%s\": %s", pid_file_path, expand_string_message);
2978 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
2981 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
2983 /* Unpick the SMTP rate limiting options, if set */
2985 if (smtp_ratelimit_mail != NULL)
2987 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
2988 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
2991 if (smtp_ratelimit_rcpt != NULL)
2993 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
2994 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
2997 /* The qualify domains default to the primary host name */
2999 if (qualify_domain_sender == NULL)
3000 qualify_domain_sender = primary_hostname;
3001 if (qualify_domain_recipient == NULL)
3002 qualify_domain_recipient = qualify_domain_sender;
3004 /* Setting system_filter_user in the configuration sets the gid as well if a
3005 name is given, but a numerical value does not. */
3007 if (system_filter_uid_set && !system_filter_gid_set)
3009 struct passwd *pw = getpwuid(system_filter_uid);
3011 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3012 (long int)system_filter_uid);
3013 system_filter_gid = pw->pw_gid;
3014 system_filter_gid_set = TRUE;
3017 /* If the errors_reply_to field is set, check that it is syntactically valid
3018 and ensure it contains a domain. */
3020 if (errors_reply_to != NULL)
3023 int start, end, domain;
3024 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3025 &start, &end, &domain, FALSE);
3027 if (recipient == NULL)
3028 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3029 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3032 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3033 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3036 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3037 smtp_accept_max must also be set. */
3039 if (smtp_accept_max == 0 &&
3040 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3041 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3042 "smtp_accept_max must be set if smtp_accept_queue or "
3043 "smtp_accept_max_per_host is set");
3045 /* Set up the host number if anything is specified. It is an expanded string
3046 so that it can be computed from the host name, for example. We do this last
3047 so as to ensure that everything else is set up before the expansion. */
3049 if (host_number_string != NULL)
3052 uschar *s = expand_string(host_number_string);
3053 long int n = Ustrtol(s, &end, 0);
3054 while (isspace(*end)) end++;
3056 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3057 "localhost_number value is not a number: %s", s);
3058 if (n > LOCALHOST_MAX)
3059 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3060 "localhost_number is greater than the maximum allowed value (%d)",
3066 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3068 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3069 tls_verify_certificates == NULL)
3070 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3071 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3072 (tls_verify_hosts != NULL)? "" : "try_");
3078 /*************************************************
3079 * Initialize one driver *
3080 *************************************************/
3082 /* This is called once the driver's generic options, if any, have been read.
3083 We can now find the driver, set up defaults for the private options, and
3084 unset any "set" bits in the private options table (which might have been
3085 set by another incarnation of the same driver).
3088 d pointer to driver instance block, with generic
3090 drivers_available vector of available drivers
3091 size_of_info size of each block in drivers_available
3092 class class of driver, for error message
3094 Returns: pointer to the driver info block
3097 static driver_info *
3098 init_driver(driver_instance *d, driver_info *drivers_available,
3099 int size_of_info, uschar *class)
3103 for (dd = drivers_available; dd->driver_name[0] != 0;
3104 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3106 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3109 int len = dd->options_len;
3111 d->options_block = store_get(len);
3112 memcpy(d->options_block, dd->options_block, len);
3113 for (i = 0; i < *(dd->options_count); i++)
3114 dd->options[i].type &= ~opt_set;
3119 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3120 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3122 return NULL; /* never obeyed */
3128 /*************************************************
3129 * Initialize driver list *
3130 *************************************************/
3132 /* This function is called for routers, transports, and authentication
3133 mechanisms. It reads the data from the current point in the configuration file
3134 up to the end of the section, and sets up a chain of instance blocks according
3135 to the file's contents. The file will already have been opened by a call to
3136 readconf_main, and must be left open for subsequent reading of further data.
3138 Any errors cause a panic crash. Note that the blocks with names driver_info and
3139 driver_instance must map the first portions of all the _info and _instance
3140 blocks for this shared code to work.
3143 class "router", "transport", or "authenticator"
3144 anchor &routers, &transports, &auths
3145 drivers_available available drivers
3146 size_of_info size of each info block
3147 instance_default points to default data for an instance
3148 instance_size size of instance block
3149 driver_optionlist generic option list
3150 driver_optionlist_count count of generic option list
3156 readconf_driver_init(
3158 driver_instance **anchor,
3159 driver_info *drivers_available,
3161 void *instance_default,
3163 optionlist *driver_optionlist,
3164 int driver_optionlist_count)
3166 driver_instance **p = anchor;
3167 driver_instance *d = NULL;
3170 while ((buffer = get_config_line()) != NULL)
3175 /* Read the first name on the line and test for the start of a new driver. A
3176 macro definition indicates the end of the previous driver. If this isn't the
3177 start of a new driver, the line will be re-read. */
3179 s = readconf_readname(name, sizeof(name), buffer);
3181 /* Handle macro definition, first finishing off the initialization of the
3182 previous driver, if any. */
3184 if (isupper(*name) && *s == '=')
3188 if (d->driver_name == NULL)
3189 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3190 "no driver defined for %s \"%s\"", class, d->name);
3194 read_macro_assignment(buffer);
3198 /* If the line starts with a name terminated by a colon, we are at the
3199 start of the definition of a new driver. The rest of the line must be
3206 /* Finish off initializing the previous driver. */
3210 if (d->driver_name == NULL)
3211 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3212 "no driver defined for %s \"%s\"", class, d->name);
3216 /* Check that we haven't already got a driver of this name */
3218 for (d = *anchor; d != NULL; d = d->next)
3219 if (Ustrcmp(name, d->name) == 0)
3220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3221 "there are two %ss called \"%s\"", class, name);
3223 /* Set up a new driver instance data block on the chain, with
3224 its default values installed. */
3226 d = store_get(instance_size);
3227 memcpy(d, instance_default, instance_size);
3230 d->name = string_copy(name);
3232 /* Clear out the "set" bits in the generic options */
3234 for (i = 0; i < driver_optionlist_count; i++)
3235 driver_optionlist[i].type &= ~opt_set;
3237 /* Check nothing more on this line, then do the next loop iteration. */
3239 while (isspace(*s)) s++;
3240 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3244 /* Not the start of a new driver. Give an error if we have not set up a
3245 current driver yet. */
3247 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3248 "%s name missing", class);
3250 /* First look to see if this is a generic option; if it is "driver",
3251 initialize the driver. If is it not a generic option, we can look for a
3252 private option provided that the driver has been previously set up. */
3254 if (readconf_handle_option(buffer, driver_optionlist,
3255 driver_optionlist_count, d, NULL))
3257 if (d->info == NULL && d->driver_name != NULL)
3258 init_driver(d, drivers_available, size_of_info, class);
3261 /* Handle private options - pass the generic block because some may
3262 live therein. A flag with each option indicates if it is in the public
3265 else if (d->info != NULL)
3267 readconf_handle_option(buffer, d->info->options,
3268 *(d->info->options_count), d, US"option \"%s\" unknown");
3271 /* The option is not generic and the driver name has not yet been given. */
3273 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3274 "(\"driver\" must be specified before any private options)", name);
3277 /* Run the initialization function for the final driver. */
3281 if (d->driver_name == NULL)
3282 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3283 "no driver defined for %s \"%s\"", class, d->name);
3290 /*************************************************
3291 * Check driver dependency *
3292 *************************************************/
3294 /* This function is passed a driver instance and a string. It checks whether
3295 any of the string options for the driver contains the given string as an
3299 d points to a driver instance block
3300 s the string to search for
3302 Returns: TRUE if a dependency is found
3306 readconf_depends(driver_instance *d, uschar *s)
3308 int count = *(d->info->options_count);
3312 for (ol = d->info->options; ol < d->info->options + count; ol++)
3314 void *options_block;
3316 int type = ol->type & opt_mask;
3317 if (type != opt_stringptr) continue;
3318 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3319 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3320 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3322 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3323 isalnum(ss[Ustrlen(s)])) continue;
3324 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3325 d->name, ol->name, s);
3330 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3337 /*************************************************
3338 * Decode an error type for retries *
3339 *************************************************/
3341 /* This function is global because it is also called from the main
3342 program when testing retry information. It decodes strings such as "quota_7d"
3343 into numerical error codes.
3346 pp points to start of text
3347 p points past end of text
3348 basic_errno points to an int to receive the main error number
3349 more_errno points to an int to receive the secondary error data
3351 Returns: NULL if decoded correctly; else points to error text
3355 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3359 while (q < p && *q != '_') q++;
3362 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3364 *basic_errno = ERRNO_EXIMQUOTA;
3365 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3366 return US"bad time value";
3369 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3371 *basic_errno = ECONNREFUSED;
3374 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3375 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3376 else return US"A or MX expected after \"refused\"";
3380 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3382 *basic_errno = ETIMEDOUT;
3386 int xlen = p - q - 1;
3389 static uschar *extras[] =
3390 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3391 static int values[] =
3392 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3394 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3396 if (strncmpic(x, extras[i], xlen) == 0)
3398 *more_errno = values[i];
3403 if (i >= sizeof(extras)/sizeof(uschar *))
3405 if (strncmpic(x, US"DNS", xlen) == 0)
3407 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3408 "available in retry rules (it has never worked) - treated as "
3411 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3416 else if (strncmpic(pp, US"rcpt_4", 6) == 0)
3419 int x = 255; /* means "any 4xx code" */
3420 if (p != pp + 8) bad = TRUE; else
3422 int a = pp[6], b = pp[7];
3426 if (isdigit(b)) x += b - '0';
3427 else if (b == 'x') x += 100;
3430 else if (a != 'x' || b != 'x') bad = TRUE;
3433 if (bad) return US"rcpt_4 must be followed by xx, dx, or dd, where "
3434 "x is literal and d is any digit";
3436 *basic_errno = ERRNO_RCPT4XX;
3437 *more_errno = x << 8;
3440 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3441 strncmpic(q+1, US"failed", p-q-1) == 0)
3443 *basic_errno = ERRNO_AUTHFAIL;
3446 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3447 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3455 /*************************************************
3456 * Read retry information *
3457 *************************************************/
3459 /* Each line of retry information contains:
3461 . A domain name pattern or an address pattern;
3463 . An error name, possibly with additional data, or *;
3465 . An optional sequence of retry items, each consisting of an identifying
3466 letter, a cutoff time, and optional parameters.
3468 All this is decoded and placed into a control block. */
3471 /* Subroutine to read an argument, preceded by a comma and terminated
3472 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3473 1 = fixed point number (returned *1000).
3476 paddr pointer to pointer to current character; updated
3477 type 0 => read a time; 1 => read a fixed point number
3479 Returns: time in seconds or fixed point number * 1000
3483 retry_arg(uschar **paddr, int type)
3488 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3490 while (isspace(*p)) p++;
3492 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3494 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3495 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3501 return readconf_readtime(pp, *p, FALSE);
3503 return readconf_readfixed(pp, *p);
3505 return 0; /* Keep picky compilers happy */
3508 /* The function proper */
3511 readconf_retries(void)
3513 retry_config **chain = &retries;
3517 while ((p = get_config_line()) != NULL)
3519 retry_rule **rchain;
3522 next = store_get(sizeof(retry_config));
3525 chain = &(next->next);
3526 next->basic_errno = next->more_errno = 0;
3527 next->senders = NULL;
3529 rchain = &(next->rules);
3531 next->pattern = string_dequote(&p);
3532 while (isspace(*p)) p++;
3534 while (mac_isgraph(*p)) p++;
3535 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3536 "missing error type");
3538 /* Test error names for things we understand. */
3540 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3541 &(next->more_errno))) != NULL)
3542 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3544 /* There may be an optional address list of senders to be used as another
3545 constraint on the rule. This was added later, so the syntax is a bit of a
3546 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3549 while (isspace(*p)) p++;
3550 if (Ustrncmp(p, "senders", 7) == 0)
3553 while (isspace(*p)) p++;
3554 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3555 "\"=\" expected after \"senders\" in retry rule");
3556 while (isspace(*p)) p++;
3557 next->senders = string_dequote(&p);
3560 /* Now the retry rules. Keep the maximum timeout encountered. */
3562 while (isspace(*p)) p++;
3566 retry_rule *rule = store_get(sizeof(retry_rule));
3568 rchain = &(rule->next);
3570 rule->rule = toupper(*p++);
3571 rule->timeout = retry_arg(&p, 0);
3572 if (rule->timeout > retry_maximum_timeout)
3573 retry_maximum_timeout = rule->timeout;
3577 case 'F': /* Fixed interval */
3578 rule->p1 = retry_arg(&p, 0);
3581 case 'G': /* Geometrically increasing intervals */
3582 case 'H': /* Ditto, but with randomness */
3583 rule->p1 = retry_arg(&p, 0);
3584 rule->p2 = retry_arg(&p, 1);
3588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3592 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3593 (rule->rule != 'F' && rule->p2 < 1000))
3594 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3595 "bad parameters for retry rule");
3597 while (isspace(*p)) p++;
3601 while (isspace(*p)) p++;
3604 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3611 /*************************************************
3612 * Initialize authenticators *
3613 *************************************************/
3615 /* Read the authenticators section of the configuration file.
3624 auth_instance *au, *bu;
3625 readconf_driver_init(US"authenticator",
3626 (driver_instance **)(&auths), /* chain anchor */
3627 (driver_info *)auths_available, /* available drivers */
3628 sizeof(auth_info), /* size of info block */
3629 &auth_defaults, /* default values for generic options */
3630 sizeof(auth_instance), /* size of instance block */
3631 optionlist_auths, /* generic options */
3632 optionlist_auths_size);
3634 for (au = auths; au != NULL; au = au->next)
3636 if (au->public_name == NULL)
3637 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3638 "the %s authenticator", au->name);
3639 for (bu = au->next; bu != NULL; bu = bu->next)
3641 if (strcmpic(au->public_name, bu->public_name) == 0)
3643 if ((au->client && bu->client) || (au->server && bu->server))
3644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3645 "(%s and %s) have the same public name (%s)",
3646 (au->client)? US"client" : US"server", au->name, bu->name,
3656 /*************************************************
3657 * Read ACL information *
3658 *************************************************/
3660 /* If this run of Exim is not doing something that involves receiving a
3661 message, we can just skip over the ACL information. No need to parse it.
3663 First, we have a function for acl_read() to call back to get the next line. We
3664 need to remember the line we passed, because at the end it will contain the
3665 name of the next ACL. */
3667 static uschar *acl_line;
3672 acl_line = get_config_line();
3677 /* Now the main function:
3680 skip TRUE when this Exim process is doing something that will
3681 not need the ACL data
3687 readconf_acl(BOOL skip)
3691 /* Not receiving messages, don't need to parse the ACL data */
3695 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3696 while ((p = get_config_line()) != NULL);
3700 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3703 acl_line = get_config_line();
3705 while(acl_line != NULL)
3711 p = readconf_readname(name, sizeof(name), acl_line);
3712 if (isupper(*name) && *p == '=')
3714 read_macro_assignment(acl_line);
3715 acl_line = get_config_line();
3719 if (*p != ':' || name[0] == 0)
3720 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3722 node = store_get(sizeof(tree_node) + Ustrlen(name));
3723 Ustrcpy(node->name, name);
3724 if (!tree_insertnode(&acl_anchor, node))
3725 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3726 "there are two ACLs called \"%s\"", name);
3728 node->data.ptr = acl_read(acl_callback, &error);
3730 if (node->data.ptr == NULL && error != NULL)
3731 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3737 /*************************************************
3738 * Read configuration for local_scan() *
3739 *************************************************/
3741 /* This function is called after "begin local_scan" is encountered in the
3742 configuration file. If the local_scan() function allows for configuration
3743 options, we can process them. Otherwise, we expire in a panic.
3750 local_scan_init(void)
3752 #ifndef LOCAL_SCAN_HAS_OPTIONS
3753 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3754 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3758 while ((p = get_config_line()) != NULL)
3760 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3761 NULL, US"local_scan option \"%s\" unknown");
3768 /*************************************************
3769 * Read rest of configuration (after main) *
3770 *************************************************/
3772 /* This function reads the rest of the runtime configuration, after the main
3773 configuration. It is called only when actually needed. Each subsequent section
3774 of the configuration starts with a line of the form
3778 where the name is "routers", "transports", etc. A section is terminated by
3779 hitting the next "begin" line, and the next name is left in next_section.
3780 Because it may confuse people as to whether the names are singular or plural,
3781 we add "s" if it's missing. There is always enough room in next_section for
3782 this. This function is basically just a switch.
3785 skip_acl TRUE if ACL information is not needed
3790 static uschar *section_list[] = {
3800 readconf_rest(BOOL skip_acl)
3804 while(next_section[0] != 0)
3808 int last = sizeof(section_list) / sizeof(uschar *);
3810 int n = Ustrlen(next_section);
3812 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3816 int c = strcmpic(next_section, section_list[mid]);
3818 if (c > 0) first = mid + 1; else last = mid;
3820 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3821 "\"%.*s\" is not a known configuration section name", n, next_section);
3822 mid = (last + first)/2;
3826 if (((had ^= bit) & bit) == 0)
3827 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3828 "\"%.*s\" section is repeated in the configuration file", n,
3833 case 0: readconf_acl(skip_acl); break;
3834 case 1: auths_init(); break;
3835 case 2: local_scan_init(); break;
3836 case 3: readconf_retries(); break;
3837 case 4: readconf_rewrites(); break;
3838 case 5: route_init(); break;
3839 case 6: transport_init(); break;
3843 (void)fclose(config_file);
3846 /* End of readconf.c */