1651ecc6ac339dff6c5645a8aad0a6da5f246234
[exim.git] / src / src / readconf.c
1 /* $Cambridge: exim/src/src/readconf.c,v 1.37 2009/10/16 08:51:34 tom Exp $ */
2
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
6
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
9
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. */
13
14 #include "exim.h"
15
16 #define CSTATE_STACK_SIZE 10
17
18
19 /* Structure for chain (stack) of .included files */
20
21 typedef struct config_file_item {
22 struct config_file_item *next;
23 uschar *filename;
24 FILE *file;
25 int lineno;
26 } config_file_item;
27
28 /* Structure of table of conditional words and their state transitions */
29
30 typedef struct cond_item {
31 uschar *name;
32 int namelen;
33 int action1;
34 int action2;
35 int pushpop;
36 } cond_item;
37
38 /* Structure of table of syslog facility names and values */
39
40 typedef struct syslog_fac_item {
41 uschar *name;
42 int value;
43 } syslog_fac_item;
44
45
46 /* Static variables */
47
48 static config_file_item *config_file_stack = NULL; /* For includes */
49
50 static uschar *syslog_facility_str = NULL;
51 static uschar next_section[24];
52 static uschar time_buffer[24];
53
54 /* State variables for conditional loading (.ifdef / .else / .endif) */
55
56 static int cstate = 0;
57 static int cstate_stack_ptr = -1;
58 static int cstate_stack[CSTATE_STACK_SIZE];
59
60 /* Table of state transitions for handling conditional inclusions. There are
61 four possible state transitions:
62
63 .ifdef true
64 .ifdef false
65 .elifdef true (or .else)
66 .elifdef false
67
68 .endif just causes the previous cstate to be popped off the stack */
69
70 static int next_cstate[3][4] =
71 {
72 /* State 0: reading from file, or reading until next .else or .endif */
73 { 0, 1, 2, 2 },
74 /* State 1: condition failed, skipping until next .else or .endif */
75 { 2, 2, 0, 1 },
76 /* State 2: skipping until .endif */
77 { 2, 2, 2, 2 },
78 };
79
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:
84
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
88 */
89
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 }
97 };
98
99 static int cond_list_size = sizeof(cond_list)/sizeof(cond_item);
100
101 /* Table of syslog facility names and their values */
102
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 }
117 };
118
119 static int syslog_list_size = sizeof(syslog_list)/sizeof(syslog_fac_item);
120
121
122
123
124 /*************************************************
125 * Main configuration options *
126 *************************************************/
127
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. */
130
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 },
140 #endif
141 { "acl_not_smtp_start", opt_stringptr, &acl_not_smtp_start },
142 { "acl_smtp_auth", opt_stringptr, &acl_smtp_auth },
143 { "acl_smtp_connect", opt_stringptr, &acl_smtp_connect },
144 { "acl_smtp_data", opt_stringptr, &acl_smtp_data },
145 #ifndef DISABLE_DKIM
146 { "acl_smtp_dkim", opt_stringptr, &acl_smtp_dkim },
147 #endif
148 { "acl_smtp_etrn", opt_stringptr, &acl_smtp_etrn },
149 { "acl_smtp_expn", opt_stringptr, &acl_smtp_expn },
150 { "acl_smtp_helo", opt_stringptr, &acl_smtp_helo },
151 { "acl_smtp_mail", opt_stringptr, &acl_smtp_mail },
152 { "acl_smtp_mailauth", opt_stringptr, &acl_smtp_mailauth },
153 #ifdef WITH_CONTENT_SCAN
154 { "acl_smtp_mime", opt_stringptr, &acl_smtp_mime },
155 #endif
156 { "acl_smtp_notquit", opt_stringptr, &acl_smtp_notquit },
157 { "acl_smtp_predata", opt_stringptr, &acl_smtp_predata },
158 { "acl_smtp_quit", opt_stringptr, &acl_smtp_quit },
159 { "acl_smtp_rcpt", opt_stringptr, &acl_smtp_rcpt },
160 #ifdef SUPPORT_TLS
161 { "acl_smtp_starttls", opt_stringptr, &acl_smtp_starttls },
162 #endif
163 { "acl_smtp_vrfy", opt_stringptr, &acl_smtp_vrfy },
164 { "admin_groups", opt_gidlist, &admin_groups },
165 { "allow_domain_literals", opt_bool, &allow_domain_literals },
166 { "allow_mx_to_ip", opt_bool, &allow_mx_to_ip },
167 { "allow_utf8_domains", opt_bool, &allow_utf8_domains },
168 { "auth_advertise_hosts", opt_stringptr, &auth_advertise_hosts },
169 { "auto_thaw", opt_time, &auto_thaw },
170 #ifdef WITH_CONTENT_SCAN
171 { "av_scanner", opt_stringptr, &av_scanner },
172 #endif
173 { "bi_command", opt_stringptr, &bi_command },
174 #ifdef EXPERIMENTAL_BRIGHTMAIL
175 { "bmi_config_file", opt_stringptr, &bmi_config_file },
176 #endif
177 { "bounce_message_file", opt_stringptr, &bounce_message_file },
178 { "bounce_message_text", opt_stringptr, &bounce_message_text },
179 { "bounce_return_body", opt_bool, &bounce_return_body },
180 { "bounce_return_message", opt_bool, &bounce_return_message },
181 { "bounce_return_size_limit", opt_mkint, &bounce_return_size_limit },
182 { "bounce_sender_authentication",opt_stringptr,&bounce_sender_authentication },
183 { "callout_domain_negative_expire", opt_time, &callout_cache_domain_negative_expire },
184 { "callout_domain_positive_expire", opt_time, &callout_cache_domain_positive_expire },
185 { "callout_negative_expire", opt_time, &callout_cache_negative_expire },
186 { "callout_positive_expire", opt_time, &callout_cache_positive_expire },
187 { "callout_random_local_part",opt_stringptr, &callout_random_local_part },
188 { "check_log_inodes", opt_int, &check_log_inodes },
189 { "check_log_space", opt_Kint, &check_log_space },
190 { "check_rfc2047_length", opt_bool, &check_rfc2047_length },
191 { "check_spool_inodes", opt_int, &check_spool_inodes },
192 { "check_spool_space", opt_Kint, &check_spool_space },
193 { "daemon_smtp_port", opt_stringptr|opt_hidden, &daemon_smtp_port },
194 { "daemon_smtp_ports", opt_stringptr, &daemon_smtp_port },
195 { "daemon_startup_retries", opt_int, &daemon_startup_retries },
196 { "daemon_startup_sleep", opt_time, &daemon_startup_sleep },
197 #ifdef EXPERIMENTAL_DCC
198 { "dcc_direct_add_header", opt_bool, &dcc_direct_add_header },
199 { "dccifd_address", opt_stringptr, &dccifd_address },
200 { "dccifd_options", opt_stringptr, &dccifd_options },
201 #endif
202 { "delay_warning", opt_timelist, &delay_warning },
203 { "delay_warning_condition", opt_stringptr, &delay_warning_condition },
204 { "deliver_drop_privilege", opt_bool, &deliver_drop_privilege },
205 { "deliver_queue_load_max", opt_fixed, &deliver_queue_load_max },
206 { "delivery_date_remove", opt_bool, &delivery_date_remove },
207 #ifdef ENABLE_DISABLE_FSYNC
208 { "disable_fsync", opt_bool, &disable_fsync },
209 #endif
210 { "disable_ipv6", opt_bool, &disable_ipv6 },
211 #ifndef DISABLE_DKIM
212 { "dkim_verify_signers", opt_stringptr, &dkim_verify_signers },
213 #endif
214 { "dns_again_means_nonexist", opt_stringptr, &dns_again_means_nonexist },
215 { "dns_check_names_pattern", opt_stringptr, &check_dns_names_pattern },
216 { "dns_csa_search_limit", opt_int, &dns_csa_search_limit },
217 { "dns_csa_use_reverse", opt_bool, &dns_csa_use_reverse },
218 { "dns_ipv4_lookup", opt_stringptr, &dns_ipv4_lookup },
219 { "dns_retrans", opt_time, &dns_retrans },
220 { "dns_retry", opt_int, &dns_retry },
221 /* This option is now a no-op, retained for compability */
222 { "drop_cr", opt_bool, &drop_cr },
223 /*********************************************************/
224 { "dsn_from", opt_stringptr, &dsn_from },
225 { "envelope_to_remove", opt_bool, &envelope_to_remove },
226 { "errors_copy", opt_stringptr, &errors_copy },
227 { "errors_reply_to", opt_stringptr, &errors_reply_to },
228 { "exim_group", opt_gid, &exim_gid },
229 { "exim_path", opt_stringptr, &exim_path },
230 { "exim_user", opt_uid, &exim_uid },
231 { "extra_local_interfaces", opt_stringptr, &extra_local_interfaces },
232 { "extract_addresses_remove_arguments", opt_bool, &extract_addresses_remove_arguments },
233 { "finduser_retries", opt_int, &finduser_retries },
234 { "freeze_tell", opt_stringptr, &freeze_tell },
235 { "gecos_name", opt_stringptr, &gecos_name },
236 { "gecos_pattern", opt_stringptr, &gecos_pattern },
237 #ifdef SUPPORT_TLS
238 { "gnutls_require_kx", opt_stringptr, &gnutls_require_kx },
239 { "gnutls_require_mac", opt_stringptr, &gnutls_require_mac },
240 { "gnutls_require_protocols", opt_stringptr, &gnutls_require_proto },
241 #endif
242 { "header_line_maxsize", opt_int, &header_line_maxsize },
243 { "header_maxsize", opt_int, &header_maxsize },
244 { "headers_charset", opt_stringptr, &headers_charset },
245 { "helo_accept_junk_hosts", opt_stringptr, &helo_accept_junk_hosts },
246 { "helo_allow_chars", opt_stringptr, &helo_allow_chars },
247 { "helo_lookup_domains", opt_stringptr, &helo_lookup_domains },
248 { "helo_try_verify_hosts", opt_stringptr, &helo_try_verify_hosts },
249 { "helo_verify_hosts", opt_stringptr, &helo_verify_hosts },
250 { "hold_domains", opt_stringptr, &hold_domains },
251 { "host_lookup", opt_stringptr, &host_lookup },
252 { "host_lookup_order", opt_stringptr, &host_lookup_order },
253 { "host_reject_connection", opt_stringptr, &host_reject_connection },
254 { "hosts_connection_nolog", opt_stringptr, &hosts_connection_nolog },
255 { "hosts_treat_as_local", opt_stringptr, &hosts_treat_as_local },
256 #ifdef LOOKUP_IBASE
257 { "ibase_servers", opt_stringptr, &ibase_servers },
258 #endif
259 { "ignore_bounce_errors_after", opt_time, &ignore_bounce_errors_after },
260 { "ignore_fromline_hosts", opt_stringptr, &ignore_fromline_hosts },
261 { "ignore_fromline_local", opt_bool, &ignore_fromline_local },
262 { "keep_malformed", opt_time, &keep_malformed },
263 #ifdef LOOKUP_LDAP
264 { "ldap_default_servers", opt_stringptr, &eldap_default_servers },
265 { "ldap_version", opt_int, &eldap_version },
266 #endif
267 { "local_from_check", opt_bool, &local_from_check },
268 { "local_from_prefix", opt_stringptr, &local_from_prefix },
269 { "local_from_suffix", opt_stringptr, &local_from_suffix },
270 { "local_interfaces", opt_stringptr, &local_interfaces },
271 { "local_scan_timeout", opt_time, &local_scan_timeout },
272 { "local_sender_retain", opt_bool, &local_sender_retain },
273 { "localhost_number", opt_stringptr, &host_number_string },
274 { "log_file_path", opt_stringptr, &log_file_path },
275 { "log_selector", opt_stringptr, &log_selector_string },
276 { "log_timezone", opt_bool, &log_timezone },
277 { "lookup_open_max", opt_int, &lookup_open_max },
278 { "max_username_length", opt_int, &max_username_length },
279 { "message_body_newlines", opt_bool, &message_body_newlines },
280 { "message_body_visible", opt_mkint, &message_body_visible },
281 { "message_id_header_domain", opt_stringptr, &message_id_domain },
282 { "message_id_header_text", opt_stringptr, &message_id_text },
283 { "message_logs", opt_bool, &message_logs },
284 { "message_size_limit", opt_stringptr, &message_size_limit },
285 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
286 { "move_frozen_messages", opt_bool, &move_frozen_messages },
287 #endif
288 { "mua_wrapper", opt_bool, &mua_wrapper },
289 #ifdef LOOKUP_MYSQL
290 { "mysql_servers", opt_stringptr, &mysql_servers },
291 #endif
292 { "never_users", opt_uidlist, &never_users },
293 #ifdef LOOKUP_ORACLE
294 { "oracle_servers", opt_stringptr, &oracle_servers },
295 #endif
296 { "percent_hack_domains", opt_stringptr, &percent_hack_domains },
297 #ifdef EXIM_PERL
298 { "perl_at_start", opt_bool, &opt_perl_at_start },
299 { "perl_startup", opt_stringptr, &opt_perl_startup },
300 #endif
301 #ifdef LOOKUP_PGSQL
302 { "pgsql_servers", opt_stringptr, &pgsql_servers },
303 #endif
304 { "pid_file_path", opt_stringptr, &pid_file_path },
305 { "pipelining_advertise_hosts", opt_stringptr, &pipelining_advertise_hosts },
306 { "preserve_message_logs", opt_bool, &preserve_message_logs },
307 { "primary_hostname", opt_stringptr, &primary_hostname },
308 { "print_topbitchars", opt_bool, &print_topbitchars },
309 { "process_log_path", opt_stringptr, &process_log_path },
310 { "prod_requires_admin", opt_bool, &prod_requires_admin },
311 { "qualify_domain", opt_stringptr, &qualify_domain_sender },
312 { "qualify_recipient", opt_stringptr, &qualify_domain_recipient },
313 { "queue_domains", opt_stringptr, &queue_domains },
314 { "queue_list_requires_admin",opt_bool, &queue_list_requires_admin },
315 { "queue_only", opt_bool, &queue_only },
316 { "queue_only_file", opt_stringptr, &queue_only_file },
317 { "queue_only_load", opt_fixed, &queue_only_load },
318 { "queue_only_load_latch", opt_bool, &queue_only_load_latch },
319 { "queue_only_override", opt_bool, &queue_only_override },
320 { "queue_run_in_order", opt_bool, &queue_run_in_order },
321 { "queue_run_max", opt_int, &queue_run_max },
322 { "queue_smtp_domains", opt_stringptr, &queue_smtp_domains },
323 { "receive_timeout", opt_time, &receive_timeout },
324 { "received_header_text", opt_stringptr, &received_header_text },
325 { "received_headers_max", opt_int, &received_headers_max },
326 { "recipient_unqualified_hosts", opt_stringptr, &recipient_unqualified_hosts },
327 { "recipients_max", opt_int, &recipients_max },
328 { "recipients_max_reject", opt_bool, &recipients_max_reject },
329 { "remote_max_parallel", opt_int, &remote_max_parallel },
330 { "remote_sort_domains", opt_stringptr, &remote_sort_domains },
331 { "retry_data_expire", opt_time, &retry_data_expire },
332 { "retry_interval_max", opt_time, &retry_interval_max },
333 { "return_path_remove", opt_bool, &return_path_remove },
334 { "return_size_limit", opt_mkint|opt_hidden, &bounce_return_size_limit },
335 { "rfc1413_hosts", opt_stringptr, &rfc1413_hosts },
336 { "rfc1413_query_timeout", opt_time, &rfc1413_query_timeout },
337 { "sender_unqualified_hosts", opt_stringptr, &sender_unqualified_hosts },
338 { "smtp_accept_keepalive", opt_bool, &smtp_accept_keepalive },
339 { "smtp_accept_max", opt_int, &smtp_accept_max },
340 { "smtp_accept_max_nonmail", opt_int, &smtp_accept_max_nonmail },
341 { "smtp_accept_max_nonmail_hosts", opt_stringptr, &smtp_accept_max_nonmail_hosts },
342 { "smtp_accept_max_per_connection", opt_int, &smtp_accept_max_per_connection },
343 { "smtp_accept_max_per_host", opt_stringptr, &smtp_accept_max_per_host },
344 { "smtp_accept_queue", opt_int, &smtp_accept_queue },
345 { "smtp_accept_queue_per_connection", opt_int, &smtp_accept_queue_per_connection },
346 { "smtp_accept_reserve", opt_int, &smtp_accept_reserve },
347 { "smtp_active_hostname", opt_stringptr, &raw_active_hostname },
348 { "smtp_banner", opt_stringptr, &smtp_banner },
349 { "smtp_check_spool_space", opt_bool, &smtp_check_spool_space },
350 { "smtp_connect_backlog", opt_int, &smtp_connect_backlog },
351 { "smtp_enforce_sync", opt_bool, &smtp_enforce_sync },
352 { "smtp_etrn_command", opt_stringptr, &smtp_etrn_command },
353 { "smtp_etrn_serialize", opt_bool, &smtp_etrn_serialize },
354 { "smtp_load_reserve", opt_fixed, &smtp_load_reserve },
355 { "smtp_max_synprot_errors", opt_int, &smtp_max_synprot_errors },
356 { "smtp_max_unknown_commands",opt_int, &smtp_max_unknown_commands },
357 { "smtp_ratelimit_hosts", opt_stringptr, &smtp_ratelimit_hosts },
358 { "smtp_ratelimit_mail", opt_stringptr, &smtp_ratelimit_mail },
359 { "smtp_ratelimit_rcpt", opt_stringptr, &smtp_ratelimit_rcpt },
360 { "smtp_receive_timeout", opt_time, &smtp_receive_timeout },
361 { "smtp_reserve_hosts", opt_stringptr, &smtp_reserve_hosts },
362 { "smtp_return_error_details",opt_bool, &smtp_return_error_details },
363 #ifdef WITH_CONTENT_SCAN
364 { "spamd_address", opt_stringptr, &spamd_address },
365 #endif
366 #ifdef EXPERIMENTAL_SPF
367 { "spf_guess", opt_stringptr, &spf_guess },
368 #endif
369 { "split_spool_directory", opt_bool, &split_spool_directory },
370 { "spool_directory", opt_stringptr, &spool_directory },
371 #ifdef LOOKUP_SQLITE
372 { "sqlite_lock_timeout", opt_int, &sqlite_lock_timeout },
373 #endif
374 #ifdef EXPERIMENTAL_SRS
375 { "srs_config", opt_stringptr, &srs_config },
376 { "srs_hashlength", opt_int, &srs_hashlength },
377 { "srs_hashmin", opt_int, &srs_hashmin },
378 { "srs_maxage", opt_int, &srs_maxage },
379 { "srs_secrets", opt_stringptr, &srs_secrets },
380 { "srs_usehash", opt_bool, &srs_usehash },
381 { "srs_usetimestamp", opt_bool, &srs_usetimestamp },
382 #endif
383 { "strict_acl_vars", opt_bool, &strict_acl_vars },
384 { "strip_excess_angle_brackets", opt_bool, &strip_excess_angle_brackets },
385 { "strip_trailing_dot", opt_bool, &strip_trailing_dot },
386 { "syslog_duplication", opt_bool, &syslog_duplication },
387 { "syslog_facility", opt_stringptr, &syslog_facility_str },
388 { "syslog_processname", opt_stringptr, &syslog_processname },
389 { "syslog_timestamp", opt_bool, &syslog_timestamp },
390 { "system_filter", opt_stringptr, &system_filter },
391 { "system_filter_directory_transport", opt_stringptr,&system_filter_directory_transport },
392 { "system_filter_file_transport",opt_stringptr,&system_filter_file_transport },
393 { "system_filter_group", opt_gid, &system_filter_gid },
394 { "system_filter_pipe_transport",opt_stringptr,&system_filter_pipe_transport },
395 { "system_filter_reply_transport",opt_stringptr,&system_filter_reply_transport },
396 { "system_filter_user", opt_uid, &system_filter_uid },
397 { "tcp_nodelay", opt_bool, &tcp_nodelay },
398 { "timeout_frozen_after", opt_time, &timeout_frozen_after },
399 { "timezone", opt_stringptr, &timezone_string },
400 #ifdef SUPPORT_TLS
401 { "tls_advertise_hosts", opt_stringptr, &tls_advertise_hosts },
402 { "tls_certificate", opt_stringptr, &tls_certificate },
403 { "tls_crl", opt_stringptr, &tls_crl },
404 { "tls_dhparam", opt_stringptr, &tls_dhparam },
405 { "tls_on_connect_ports", opt_stringptr, &tls_on_connect_ports },
406 { "tls_privatekey", opt_stringptr, &tls_privatekey },
407 { "tls_remember_esmtp", opt_bool, &tls_remember_esmtp },
408 { "tls_require_ciphers", opt_stringptr, &tls_require_ciphers },
409 { "tls_try_verify_hosts", opt_stringptr, &tls_try_verify_hosts },
410 { "tls_verify_certificates", opt_stringptr, &tls_verify_certificates },
411 { "tls_verify_hosts", opt_stringptr, &tls_verify_hosts },
412 #endif
413 { "trusted_groups", opt_gidlist, &trusted_groups },
414 { "trusted_users", opt_uidlist, &trusted_users },
415 { "unknown_login", opt_stringptr, &unknown_login },
416 { "unknown_username", opt_stringptr, &unknown_username },
417 { "untrusted_set_sender", opt_stringptr, &untrusted_set_sender },
418 { "uucp_from_pattern", opt_stringptr, &uucp_from_pattern },
419 { "uucp_from_sender", opt_stringptr, &uucp_from_sender },
420 { "warn_message_file", opt_stringptr, &warn_message_file },
421 { "write_rejectlog", opt_bool, &write_rejectlog }
422 };
423
424 static int optionlist_config_size =
425 sizeof(optionlist_config)/sizeof(optionlist);
426
427
428
429 /*************************************************
430 * Find the name of an option *
431 *************************************************/
432
433 /* This function is to aid debugging. Various functions take arguments that are
434 pointer variables in the options table or in option tables for various drivers.
435 For debugging output, it is useful to be able to find the name of the option
436 which is currently being processed. This function finds it, if it exists, by
437 searching the table(s).
438
439 Arguments: a value that is presumed to be in the table above
440 Returns: the option name, or an empty string
441 */
442
443 uschar *
444 readconf_find_option(void *p)
445 {
446 int i;
447 router_instance *r;
448 transport_instance *t;
449
450 for (i = 0; i < optionlist_config_size; i++)
451 if (p == optionlist_config[i].value) return US optionlist_config[i].name;
452
453 for (r = routers; r != NULL; r = r->next)
454 {
455 router_info *ri = r->info;
456 for (i = 0; i < ri->options_count[0]; i++)
457 {
458 if ((ri->options[i].type & opt_mask) != opt_stringptr) continue;
459 if (p == (char *)(r->options_block) + (long int)(ri->options[i].value))
460 return US ri->options[i].name;
461 }
462 }
463
464 for (t = transports; t != NULL; t = t->next)
465 {
466 transport_info *ti = t->info;
467 for (i = 0; i < ti->options_count[0]; i++)
468 {
469 if ((ti->options[i].type & opt_mask) != opt_stringptr) continue;
470 if (p == (char *)(t->options_block) + (long int)(ti->options[i].value))
471 return US ti->options[i].name;
472 }
473 }
474
475 return US"";
476 }
477
478
479
480
481 /*************************************************
482 * Deal with an assignment to a macro *
483 *************************************************/
484
485 /* This function is called when a line that starts with an upper case letter is
486 encountered. The argument "line" should contain a complete logical line, and
487 start with the first letter of the macro name. The macro name and the
488 replacement text are extracted and stored. Redefinition of existing,
489 non-command line, macros is permitted using '==' instead of '='.
490
491 Arguments:
492 s points to the start of the logical line
493
494 Returns: nothing
495 */
496
497 static void
498 read_macro_assignment(uschar *s)
499 {
500 uschar name[64];
501 int namelen = 0;
502 BOOL redef = FALSE;
503 macro_item *m;
504 macro_item *mlast = NULL;
505
506 while (isalnum(*s) || *s == '_')
507 {
508 if (namelen >= sizeof(name) - 1)
509 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
510 "macro name too long (maximum is %d characters)", sizeof(name) - 1);
511 name[namelen++] = *s++;
512 }
513 name[namelen] = 0;
514
515 while (isspace(*s)) s++;
516 if (*s++ != '=')
517 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "malformed macro definition");
518
519 if (*s == '=')
520 {
521 redef = TRUE;
522 s++;
523 }
524 while (isspace(*s)) s++;
525
526 /* If an existing macro of the same name was defined on the command line, we
527 just skip this definition. It's an error to attempt to redefine a macro without
528 redef set to TRUE, or to redefine a macro when it hasn't been defined earlier.
529 It is also an error to define a macro whose name begins with the name of a
530 previously defined macro. Note: it is documented that the other way round
531 works. */
532
533 for (m = macros; m != NULL; m = m->next)
534 {
535 int len = Ustrlen(m->name);
536
537 if (Ustrcmp(m->name, name) == 0)
538 {
539 if (!m->command_line && !redef)
540 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "macro \"%s\" is already "
541 "defined (use \"==\" if you want to redefine it", name);
542 break;
543 }
544
545 if (len < namelen && Ustrstr(name, m->name) != NULL)
546 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
547 "a macro because previously defined macro \"%s\" is a substring",
548 name, m->name);
549
550 /* We cannot have this test, because it is documented that a substring
551 macro is permitted (there is even an example).
552 *
553 * if (len > namelen && Ustrstr(m->name, name) != NULL)
554 * log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "\"%s\" cannot be defined as "
555 * "a macro because it is a substring of previously defined macro \"%s\"",
556 * name, m->name);
557 */
558
559 mlast = m;
560 }
561
562 /* Check for an overriding command-line definition. */
563
564 if (m != NULL && m->command_line) return;
565
566 /* Redefinition must refer to an existing macro. */
567
568 if (redef)
569 {
570 if (m == NULL)
571 log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "can't redefine an undefined macro "
572 "\"%s\"", name);
573 }
574
575 /* We have a new definition. The macro_item structure includes a final vector
576 called "name" which is one byte long. Thus, adding "namelen" gives us enough
577 room to store the "name" string. */
578
579 else
580 {
581 m = store_get(sizeof(macro_item) + namelen);
582 if (macros == NULL) macros = m; else mlast->next = m;
583 Ustrncpy(m->name, name, namelen);
584 m->name[namelen] = 0;
585 m->next = NULL;
586 m->command_line = FALSE;
587 }
588
589 /* Set the value of the new or redefined macro */
590
591 m->replacement = string_copy(s);
592 }
593
594
595
596
597
598 /*************************************************
599 * Read configuration line *
600 *************************************************/
601
602 /* A logical line of text is read from the configuration file into the big
603 buffer, taking account of macros, .includes, and continuations. The size of
604 big_buffer is increased if necessary. The count of configuration lines is
605 maintained. Physical input lines starting with # (ignoring leading white space,
606 and after macro replacement) and empty logical lines are always ignored.
607 Leading and trailing spaces are removed.
608
609 If we hit a line of the form "begin xxxx", the xxxx is placed in the
610 next_section vector, and the function returns NULL, indicating the end of a
611 configuration section. On end-of-file, NULL is returned with next_section
612 empty.
613
614 Arguments: none
615
616 Returns: a pointer to the first non-blank in the line,
617 or NULL if eof or end of section is reached
618 */
619
620 static uschar *
621 get_config_line(void)
622 {
623 int startoffset = 0; /* To first non-blank char in logical line */
624 int len = 0; /* Of logical line so far */
625 int newlen;
626 uschar *s, *ss;
627 macro_item *m;
628 BOOL macro_found;
629
630 /* Loop for handling continuation lines, skipping comments, and dealing with
631 .include files. */
632
633 for (;;)
634 {
635 if (Ufgets(big_buffer+len, big_buffer_size-len, config_file) == NULL)
636 {
637 if (config_file_stack != NULL) /* EOF inside .include */
638 {
639 (void)fclose(config_file);
640 config_file = config_file_stack->file;
641 config_filename = config_file_stack->filename;
642 config_lineno = config_file_stack->lineno;
643 config_file_stack = config_file_stack->next;
644 continue;
645 }
646
647 /* EOF at top level */
648
649 if (cstate_stack_ptr >= 0)
650 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
651 "Unexpected end of configuration file: .endif missing");
652
653 if (len != 0) break; /* EOF after continuation */
654 next_section[0] = 0; /* EOF at start of logical line */
655 return NULL;
656 }
657
658 config_lineno++;
659 newlen = len + Ustrlen(big_buffer + len);
660
661 /* Handle pathologically long physical lines - yes, it did happen - by
662 extending big_buffer at this point. The code also copes with very long
663 logical lines. */
664
665 while (newlen == big_buffer_size - 1 && big_buffer[newlen - 1] != '\n')
666 {
667 uschar *newbuffer;
668 big_buffer_size += BIG_BUFFER_SIZE;
669 newbuffer = store_malloc(big_buffer_size);
670
671 /* This use of strcpy is OK because we know that the string in the old
672 buffer is shorter than the new buffer. */
673
674 Ustrcpy(newbuffer, big_buffer);
675 store_free(big_buffer);
676 big_buffer = newbuffer;
677 if (Ufgets(big_buffer+newlen, big_buffer_size-newlen, config_file) == NULL)
678 break;
679 newlen += Ustrlen(big_buffer + newlen);
680 }
681
682 /* Find the true start of the physical line - leading spaces are always
683 ignored. */
684
685 ss = big_buffer + len;
686 while (isspace(*ss)) ss++;
687
688 /* Process the physical line for macros. If this is the start of the logical
689 line, skip over initial text at the start of the line if it starts with an
690 upper case character followed by a sequence of name characters and an equals
691 sign, because that is the definition of a new macro, and we don't do
692 replacement therein. */
693
694 s = ss;
695 if (len == 0 && isupper(*s))
696 {
697 while (isalnum(*s) || *s == '_') s++;
698 while (isspace(*s)) s++;
699 if (*s != '=') s = ss; /* Not a macro definition */
700 }
701
702 /* For each defined macro, scan the line (from after XXX= if present),
703 replacing all occurrences of the macro. */
704
705 macro_found = FALSE;
706 for (m = macros; m != NULL; m = m->next)
707 {
708 uschar *p, *pp;
709 uschar *t = s;
710
711 while ((p = Ustrstr(t, m->name)) != NULL)
712 {
713 int moveby;
714 int namelen = Ustrlen(m->name);
715 int replen = Ustrlen(m->replacement);
716
717 /* Expand the buffer if necessary */
718
719 while (newlen - namelen + replen + 1 > big_buffer_size)
720 {
721 int newsize = big_buffer_size + BIG_BUFFER_SIZE;
722 uschar *newbuffer = store_malloc(newsize);
723 memcpy(newbuffer, big_buffer, newlen + 1);
724 p = newbuffer + (p - big_buffer);
725 s = newbuffer + (s - big_buffer);
726 ss = newbuffer + (ss - big_buffer);
727 t = newbuffer + (t - big_buffer);
728 big_buffer_size = newsize;
729 store_free(big_buffer);
730 big_buffer = newbuffer;
731 }
732
733 /* Shuffle the remaining characters up or down in the buffer before
734 copying in the replacement text. Don't rescan the replacement for this
735 same macro. */
736
737 pp = p + namelen;
738 moveby = replen - namelen;
739 if (moveby != 0)
740 {
741 memmove(p + replen, pp, (big_buffer + newlen) - pp + 1);
742 newlen += moveby;
743 }
744 Ustrncpy(p, m->replacement, replen);
745 t = p + replen;
746 macro_found = TRUE;
747 }
748 }
749
750 /* An empty macro replacement at the start of a line could mean that ss no
751 longer points to the first non-blank character. */
752
753 while (isspace(*ss)) ss++;
754
755 /* Check for comment lines - these are physical lines. */
756
757 if (*ss == '#') continue;
758
759 /* Handle conditionals, which are also applied to physical lines. Conditions
760 are of the form ".ifdef ANYTEXT" and are treated as true if any macro
761 expansion occured on the rest of the line. A preliminary test for the leading
762 '.' saves effort on most lines. */
763
764 if (*ss == '.')
765 {
766 int i;
767
768 /* Search the list of conditional directives */
769
770 for (i = 0; i < cond_list_size; i++)
771 {
772 int n;
773 cond_item *c = cond_list+i;
774 if (Ustrncmp(ss+1, c->name, c->namelen) != 0) continue;
775
776 /* The following character must be white space or end of string */
777
778 n = ss[1 + c->namelen];
779 if (n != ' ' && n != 't' && n != '\n' && n != 0) break;
780
781 /* .ifdef and .ifndef push the current state onto the stack, then set
782 a new one from the table. Stack overflow is an error */
783
784 if (c->pushpop > 0)
785 {
786 if (cstate_stack_ptr >= CSTATE_STACK_SIZE - 1)
787 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
788 ".%s nested too deeply", c->name);
789 cstate_stack[++cstate_stack_ptr] = cstate;
790 cstate = next_cstate[cstate][macro_found? c->action1 : c->action2];
791 }
792
793 /* For any of the others, stack underflow is an error. The next state
794 comes either from the stack (.endif) or from the table. */
795
796 else
797 {
798 if (cstate_stack_ptr < 0)
799 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
800 ".%s without matching .ifdef", c->name);
801 cstate = (c->pushpop < 0)? cstate_stack[cstate_stack_ptr--] :
802 next_cstate[cstate][macro_found? c->action1 : c->action2];
803 }
804
805 /* Having dealt with a directive, break the loop */
806
807 break;
808 }
809
810 /* If we have handled a conditional directive, continue with the next
811 physical line. Otherwise, fall through. */
812
813 if (i < cond_list_size) continue;
814 }
815
816 /* If the conditional state is not 0 (actively using these lines), ignore
817 this input line. */
818
819 if (cstate != 0) continue; /* Conditional skip */
820
821 /* Handle .include lines - these are also physical lines. */
822
823 if (Ustrncmp(ss, ".include", 8) == 0 &&
824 (isspace(ss[8]) ||
825 (Ustrncmp(ss+8, "_if_exists", 10) == 0 && isspace(ss[18]))))
826 {
827 uschar *t;
828 int include_if_exists = isspace(ss[8])? 0 : 10;
829 config_file_item *save;
830 struct stat statbuf;
831
832 ss += 9 + include_if_exists;
833 while (isspace(*ss)) ss++;
834 t = ss + Ustrlen(ss);
835 while (t > ss && isspace(t[-1])) t--;
836 if (*ss == '\"' && t[-1] == '\"')
837 {
838 ss++;
839 t--;
840 }
841 *t = 0;
842
843 if (*ss != '/')
844 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, ".include specifies a non-"
845 "absolute path \"%s\"", ss);
846
847 if (include_if_exists != 0 && (Ustat(ss, &statbuf) != 0)) continue;
848
849 save = store_get(sizeof(config_file_item));
850 save->next = config_file_stack;
851 config_file_stack = save;
852 save->file = config_file;
853 save->filename = config_filename;
854 save->lineno = config_lineno;
855
856 config_file = Ufopen(ss, "rb");
857 if (config_file == NULL)
858 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to open included "
859 "configuration file %s", ss);
860 config_filename = string_copy(ss);
861 config_lineno = 0;
862 continue;
863 }
864
865 /* If this is the start of the logical line, remember where the non-blank
866 data starts. Otherwise shuffle down continuation lines to remove leading
867 white space. */
868
869 if (len == 0)
870 startoffset = ss - big_buffer;
871 else
872 {
873 s = big_buffer + len;
874 if (ss > s)
875 {
876 memmove(s, ss, (newlen - len) - (ss - s) + 1);
877 newlen -= ss - s;
878 }
879 }
880
881 /* Accept the new addition to the line. Remove trailing white space. */
882
883 len = newlen;
884 while (len > 0 && isspace(big_buffer[len-1])) len--;
885 big_buffer[len] = 0;
886
887 /* We are done if the line does not end in backslash and contains some data.
888 Empty logical lines are ignored. For continuations, remove the backslash and
889 go round the loop to read the continuation line. */
890
891 if (len > 0)
892 {
893 if (big_buffer[len-1] != '\\') break; /* End of logical line */
894 big_buffer[--len] = 0; /* Remove backslash */
895 }
896 } /* Loop for reading multiple physical lines */
897
898 /* We now have a logical line. Test for the end of a configuration section (or,
899 more accurately, for the start of the next section). Place the name of the next
900 section in next_section, and return NULL. If the name given is longer than
901 next_section, truncate it. It will be unrecognized later, because all the known
902 section names do fit. Leave space for pluralizing. */
903
904 s = big_buffer + startoffset; /* First non-space character */
905 if (strncmpic(s, US"begin ", 6) == 0)
906 {
907 s += 6;
908 while (isspace(*s)) s++;
909 if (big_buffer + len - s > sizeof(next_section) - 2)
910 s[sizeof(next_section) - 2] = 0;
911 Ustrcpy(next_section, s);
912 return NULL;
913 }
914
915 /* Return the first non-blank character. */
916
917 return s;
918 }
919
920
921
922 /*************************************************
923 * Read a name *
924 *************************************************/
925
926 /* The yield is the pointer to the next uschar. Names longer than the
927 output space are silently truncated. This function is also used from acl.c when
928 parsing ACLs.
929
930 Arguments:
931 name where to put the name
932 len length of name
933 s input pointer
934
935 Returns: new input pointer
936 */
937
938 uschar *
939 readconf_readname(uschar *name, int len, uschar *s)
940 {
941 int p = 0;
942 while (isspace(*s)) s++;
943 if (isalpha(*s))
944 {
945 while (isalnum(*s) || *s == '_')
946 {
947 if (p < len-1) name[p++] = *s;
948 s++;
949 }
950 }
951 name[p] = 0;
952 while (isspace(*s)) s++;
953 return s;
954 }
955
956
957
958
959 /*************************************************
960 * Read a time value *
961 *************************************************/
962
963 /* This function is also called from outside, to read argument
964 time values. The format of a time value is:
965
966 [<n>w][<n>d][<n>h][<n>m][<n>s]
967
968 as long as at least one is present. If a format error is encountered,
969 return a negative value. The value must be terminated by the given
970 terminator.
971
972 Arguments:
973 s input pointer
974 terminator required terminating character
975 return_msec if TRUE, allow fractional seconds and return milliseconds
976
977 Returns: the time value, or -1 on syntax error
978 value is seconds if return_msec is FALSE
979 value is milliseconds if return_msec is TRUE
980 */
981
982 int
983 readconf_readtime(uschar *s, int terminator, BOOL return_msec)
984 {
985 int yield = 0;
986 for (;;)
987 {
988 int value, count;
989 double fraction;
990
991 if (!isdigit(*s)) return -1;
992 (void)sscanf(CS s, "%d%n", &value, &count);
993 s += count;
994
995 switch (*s)
996 {
997 case 'w': value *= 7;
998 case 'd': value *= 24;
999 case 'h': value *= 60;
1000 case 'm': value *= 60;
1001 case 's': s++;
1002 break;
1003
1004 case '.':
1005 if (!return_msec) return -1;
1006 (void)sscanf(CS s, "%lf%n", &fraction, &count);
1007 s += count;
1008 if (*s++ != 's') return -1;
1009 yield += (int)(fraction * 1000.0);
1010 break;
1011
1012 default: return -1;
1013 }
1014
1015 if (return_msec) value *= 1000;
1016 yield += value;
1017 if (*s == terminator) return yield;
1018 }
1019 /* Control never reaches here. */
1020 }
1021
1022
1023
1024 /*************************************************
1025 * Read a fixed point value *
1026 *************************************************/
1027
1028 /* The value is returned *1000
1029
1030 Arguments:
1031 s input pointer
1032 terminator required terminator
1033
1034 Returns: the value, or -1 on error
1035 */
1036
1037 static int
1038 readconf_readfixed(uschar *s, int terminator)
1039 {
1040 int yield = 0;
1041 int value, count;
1042 if (!isdigit(*s)) return -1;
1043 (void)sscanf(CS s, "%d%n", &value, &count);
1044 s += count;
1045 yield = value * 1000;
1046 if (*s == '.')
1047 {
1048 int m = 100;
1049 while (isdigit((*(++s))))
1050 {
1051 yield += (*s - '0') * m;
1052 m /= 10;
1053 }
1054 }
1055
1056 return (*s == terminator)? yield : (-1);
1057 }
1058
1059
1060
1061 /*************************************************
1062 * Find option in list *
1063 *************************************************/
1064
1065 /* The lists are always in order, so binary chop can be used.
1066
1067 Arguments:
1068 name the option name to search for
1069 ol the first entry in the option list
1070 last one more than the offset of the last entry in the option list
1071
1072 Returns: pointer to an option entry, or NULL if not found
1073 */
1074
1075 static optionlist *
1076 find_option(uschar *name, optionlist *ol, int last)
1077 {
1078 int first = 0;
1079 while (last > first)
1080 {
1081 int middle = (first + last)/2;
1082 int c = Ustrcmp(name, ol[middle].name);
1083 if (c == 0) return ol + middle;
1084 else if (c > 0) first = middle + 1;
1085 else last = middle;
1086 }
1087 return NULL;
1088 }
1089
1090
1091
1092 /*************************************************
1093 * Find a set flag in option list *
1094 *************************************************/
1095
1096 /* Because some versions of Unix make no restrictions on the values of uids and
1097 gids (even negative ones), we cannot represent "unset" by a special value.
1098 There is therefore a separate boolean variable for each one indicating whether
1099 a value is set or not. This function returns a pointer to the boolean, given
1100 the original option name. It is a major disaster if the flag cannot be found.
1101
1102 Arguments:
1103 name the name of the uid or gid option
1104 oltop points to the start of the relevant option list
1105 last one more than the offset of the last item in the option list
1106 data_block NULL when reading main options => data values in the option
1107 list are absolute addresses; otherwise they are byte offsets
1108 in data_block (used for driver options)
1109
1110 Returns: a pointer to the boolean flag.
1111 */
1112
1113 static BOOL *
1114 get_set_flag(uschar *name, optionlist *oltop, int last, void *data_block)
1115 {
1116 optionlist *ol;
1117 uschar name2[64];
1118 sprintf(CS name2, "*set_%.50s", name);
1119 ol = find_option(name2, oltop, last);
1120 if (ol == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1121 "Exim internal error: missing set flag for %s", name);
1122 return (data_block == NULL)? (BOOL *)(ol->value) :
1123 (BOOL *)((uschar *)data_block + (long int)(ol->value));
1124 }
1125
1126
1127
1128
1129 /*************************************************
1130 * Output extra characters message and die *
1131 *************************************************/
1132
1133 /* Called when an option line has junk on the end. Sometimes this is because
1134 the sysadmin thinks comments are permitted.
1135
1136 Arguments:
1137 s points to the extra characters
1138 t1..t3 strings to insert in the log message
1139
1140 Returns: doesn't return; dies
1141 */
1142
1143 static void
1144 extra_chars_error(uschar *s, uschar *t1, uschar *t2, uschar *t3)
1145 {
1146 uschar *comment = US"";
1147 if (*s == '#') comment = US" (# is comment only at line start)";
1148 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1149 "extra characters follow %s%s%s%s", t1, t2, t3, comment);
1150 }
1151
1152
1153
1154 /*************************************************
1155 * Read rewrite information *
1156 *************************************************/
1157
1158 /* Each line of rewrite information contains:
1159
1160 . A complete address in the form user@domain, possibly with
1161 leading * for each part; or alternatively, a regex.
1162
1163 . A replacement string (which will be expanded).
1164
1165 . An optional sequence of one-letter flags, indicating which
1166 headers etc. to apply this rule to.
1167
1168 All this is decoded and placed into a control block. The OR of the flags is
1169 maintained in a common word.
1170
1171 Arguments:
1172 p points to the string that makes up the rule
1173 existflags points to the overall flag word
1174 isglobal TRUE if reading global rewrite rules
1175
1176 Returns: the control block for the parsed rule.
1177 */
1178
1179 static rewrite_rule *
1180 readconf_one_rewrite(uschar *p, int *existflags, BOOL isglobal)
1181 {
1182 rewrite_rule *next = store_get(sizeof(rewrite_rule));
1183
1184 next->next = NULL;
1185 next->key = string_dequote(&p);
1186
1187 while (isspace(*p)) p++;
1188 if (*p == 0)
1189 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1190 "missing rewrite replacement string");
1191
1192 next->flags = 0;
1193 next->replacement = string_dequote(&p);
1194
1195 while (*p != 0) switch (*p++)
1196 {
1197 case ' ': case '\t': break;
1198
1199 case 'q': next->flags |= rewrite_quit; break;
1200 case 'w': next->flags |= rewrite_whole; break;
1201
1202 case 'h': next->flags |= rewrite_all_headers; break;
1203 case 's': next->flags |= rewrite_sender; break;
1204 case 'f': next->flags |= rewrite_from; break;
1205 case 't': next->flags |= rewrite_to; break;
1206 case 'c': next->flags |= rewrite_cc; break;
1207 case 'b': next->flags |= rewrite_bcc; break;
1208 case 'r': next->flags |= rewrite_replyto; break;
1209
1210 case 'E': next->flags |= rewrite_all_envelope; break;
1211 case 'F': next->flags |= rewrite_envfrom; break;
1212 case 'T': next->flags |= rewrite_envto; break;
1213
1214 case 'Q': next->flags |= rewrite_qualify; break;
1215 case 'R': next->flags |= rewrite_repeat; break;
1216
1217 case 'S':
1218 next->flags |= rewrite_smtp;
1219 if (next->key[0] != '^' && Ustrncmp(next->key, "\\N^", 3) != 0)
1220 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1221 "rewrite rule has the S flag but is not a regular expression");
1222 break;
1223
1224 default:
1225 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1226 "unknown rewrite flag character '%c' "
1227 "(could be missing quotes round replacement item)", p[-1]);
1228 break;
1229 }
1230
1231 /* If no action flags are set, set all the "normal" rewrites. */
1232
1233 if ((next->flags & (rewrite_all | rewrite_smtp)) == 0)
1234 next->flags |= isglobal? rewrite_all : rewrite_all_headers;
1235
1236 /* Remember which exist, for optimization, and return the rule */
1237
1238 *existflags |= next->flags;
1239 return next;
1240 }
1241
1242
1243
1244
1245 /*************************************************
1246 * Read global rewrite information *
1247 *************************************************/
1248
1249 /* Each line is a single rewrite rule; it is parsed into a control block
1250 by readconf_one_rewrite(), and its flags are ORed into the global flag
1251 word rewrite_existflags. */
1252
1253 void
1254 readconf_rewrites(void)
1255 {
1256 rewrite_rule **chain = &global_rewrite_rules;
1257 uschar *p;
1258
1259 while ((p = get_config_line()) != NULL)
1260 {
1261 rewrite_rule *next = readconf_one_rewrite(p, &rewrite_existflags, TRUE);
1262 *chain = next;
1263 chain = &(next->next);
1264 }
1265 }
1266
1267
1268
1269 /*************************************************
1270 * Read a string *
1271 *************************************************/
1272
1273 /* Strings are read into the normal store pool. As long we aren't too
1274 near the end of the current block, the string will just use what is necessary
1275 on the top of the stacking pool, because string_cat() uses the extension
1276 mechanism.
1277
1278 Argument:
1279 s the rest of the input line
1280 name the option name (for errors)
1281
1282 Returns: pointer to the string
1283 */
1284
1285 static uschar *
1286 read_string(uschar *s, uschar *name)
1287 {
1288 uschar *yield;
1289 uschar *ss;
1290
1291 if (*s != '\"') return string_copy(s);
1292
1293 ss = s;
1294 yield = string_dequote(&s);
1295
1296 if (s == ss+1 || s[-1] != '\"')
1297 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1298 "missing quote at end of string value for %s", name);
1299
1300 if (*s != 0) extra_chars_error(s, US"string value for ", name, US"");
1301
1302 return yield;
1303 }
1304
1305
1306 /*************************************************
1307 * Handle option line *
1308 *************************************************/
1309
1310 /* This function is called from several places to process a line containing the
1311 setting of an option. The first argument is the line to be decoded; it has been
1312 checked not to be empty and not to start with '#'. Trailing newlines and white
1313 space have been removed. The second argument is a pointer to the list of
1314 variable names that are to be recognized, together with their types and
1315 locations, and the third argument gives the number of entries in the list.
1316
1317 The fourth argument is a pointer to a data block. If it is NULL, then the data
1318 values in the options list are absolute addresses. Otherwise, they are byte
1319 offsets in the data block.
1320
1321 String option data may continue onto several lines; this function reads further
1322 data from config_file if necessary.
1323
1324 The yield of this function is normally zero. If a string continues onto
1325 multiple lines, then the data value is permitted to be followed by a comma
1326 or a semicolon (for use in drivers) and the yield is that character.
1327
1328 Arguments:
1329 buffer contains the configuration line to be handled
1330 oltop points to the start of the relevant option list
1331 last one more than the offset of the last item in the option list
1332 data_block NULL when reading main options => data values in the option
1333 list are absolute addresses; otherwise they are byte offsets
1334 in data_block when they have opt_public set; otherwise
1335 they are byte offsets in data_block->options_block.
1336 unknown_txt format string to use in panic message for unknown option;
1337 must contain %s for option name
1338 if given as NULL, don't panic on unknown option
1339
1340 Returns: TRUE if an option was read successfully,
1341 FALSE false for an unknown option if unknown_txt == NULL,
1342 otherwise panic and die on an unknown option
1343 */
1344
1345 static BOOL
1346 readconf_handle_option(uschar *buffer, optionlist *oltop, int last,
1347 void *data_block, uschar *unknown_txt)
1348 {
1349 int ptr = 0;
1350 int offset = 0;
1351 int n, count, type, value;
1352 int issecure = 0;
1353 uid_t uid;
1354 gid_t gid;
1355 BOOL boolvalue = TRUE;
1356 BOOL freesptr = TRUE;
1357 optionlist *ol, *ol2;
1358 struct passwd *pw;
1359 void *reset_point;
1360 int intbase = 0;
1361 uschar *inttype = US"";
1362 uschar *sptr;
1363 uschar *s = buffer;
1364 uschar name[64];
1365 uschar name2[64];
1366
1367 /* There may be leading spaces; thereafter, we expect an option name starting
1368 with a letter. */
1369
1370 while (isspace(*s)) s++;
1371 if (!isalpha(*s))
1372 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option setting expected: %s", s);
1373
1374 /* Read the name of the option, and skip any subsequent white space. If
1375 it turns out that what we read was "hide", set the flag indicating that
1376 this is a secure option, and loop to read the next word. */
1377
1378 for (n = 0; n < 2; n++)
1379 {
1380 while (isalnum(*s) || *s == '_')
1381 {
1382 if (ptr < sizeof(name)-1) name[ptr++] = *s;
1383 s++;
1384 }
1385 name[ptr] = 0;
1386 while (isspace(*s)) s++;
1387 if (Ustrcmp(name, "hide") != 0) break;
1388 issecure = opt_secure;
1389 ptr = 0;
1390 }
1391
1392 /* Deal with "no_" or "not_" here for booleans */
1393
1394 if (Ustrncmp(name, "no_", 3) == 0)
1395 {
1396 boolvalue = FALSE;
1397 offset = 3;
1398 }
1399
1400 if (Ustrncmp(name, "not_", 4) == 0)
1401 {
1402 boolvalue = FALSE;
1403 offset = 4;
1404 }
1405
1406 /* Search the list for the given name. A non-existent name, or an option that
1407 is set twice, is a disaster. */
1408
1409 ol = find_option(name + offset, oltop, last);
1410
1411 if (ol == NULL)
1412 {
1413 if (unknown_txt == NULL) return FALSE;
1414 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, CS unknown_txt, name);
1415 }
1416
1417 if ((ol->type & opt_set) != 0)
1418 {
1419 uschar *mname = name;
1420 if (Ustrncmp(mname, "no_", 3) == 0) mname += 3;
1421 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1422 "\"%s\" option set for the second time", mname);
1423 }
1424
1425 ol->type |= opt_set | issecure;
1426 type = ol->type & opt_mask;
1427
1428 /* Types with data values must be followed by '='; the "no[t]_" prefix
1429 applies only to boolean values. */
1430
1431 if (type < opt_bool || type > opt_bool_last)
1432 {
1433 if (offset != 0)
1434 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1435 "negation prefix applied to a non-boolean option");
1436 if (*s == 0)
1437 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1438 "unexpected end of line (data missing) after %s", name);
1439 if (*s != '=')
1440 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing \"=\" after %s", name);
1441 }
1442
1443 /* If a boolean wasn't preceded by "no[t]_" it can be followed by = and
1444 true/false/yes/no, or, in the case of opt_expanded_bool, a general string that
1445 ultimately expands to one of those values. */
1446
1447 else if (*s != 0 && (offset != 0 || *s != '='))
1448 extra_chars_error(s, US"boolean option ", name, US"");
1449
1450 /* Skip white space after = */
1451
1452 if (*s == '=') while (isspace((*(++s))));
1453
1454 /* If there is a data block and the opt_public flag is not set, change
1455 the data block pointer to the private options block. */
1456
1457 if (data_block != NULL && (ol->type & opt_public) == 0)
1458 data_block = (void *)(((driver_instance *)data_block)->options_block);
1459
1460 /* Now get the data according to the type. */
1461
1462 switch (type)
1463 {
1464 /* If a string value is not enclosed in quotes, it consists of
1465 the rest of the current line, verbatim. Otherwise, string escapes
1466 are processed.
1467
1468 A transport is specified as a string, which is then looked up in the
1469 list of transports. A search type is specified as one of a number of
1470 known strings.
1471
1472 A set or rewrite rules for a driver is specified as a string, which is
1473 then parsed into a suitable chain of control blocks.
1474
1475 Uids and gids are specified as strings which are then looked up in the
1476 passwd file. Lists of uids and gids are similarly specified as colon-
1477 separated strings. */
1478
1479 case opt_stringptr:
1480 case opt_uid:
1481 case opt_gid:
1482 case opt_expand_uid:
1483 case opt_expand_gid:
1484 case opt_uidlist:
1485 case opt_gidlist:
1486 case opt_rewrite:
1487
1488 reset_point = sptr = read_string(s, name);
1489
1490 /* Having read a string, we now have several different ways of using it,
1491 depending on the data type, so do another switch. If keeping the actual
1492 string is not required (because it is interpreted), freesptr is set TRUE,
1493 and at the end we reset the pool. */
1494
1495 switch (type)
1496 {
1497 /* If this was a string, set the variable to point to the new string,
1498 and set the flag so its store isn't reclaimed. If it was a list of rewrite
1499 rules, we still keep the string (for printing), and parse the rules into a
1500 control block and flags word. */
1501
1502 case opt_stringptr:
1503 case opt_rewrite:
1504 if (data_block == NULL)
1505 *((uschar **)(ol->value)) = sptr;
1506 else
1507 *((uschar **)((uschar *)data_block + (long int)(ol->value))) = sptr;
1508 freesptr = FALSE;
1509 if (type == opt_rewrite)
1510 {
1511 int sep = 0;
1512 int *flagptr;
1513 uschar *p = sptr;
1514 rewrite_rule **chain;
1515 optionlist *ol3;
1516
1517 sprintf(CS name2, "*%.50s_rules", name);
1518 ol2 = find_option(name2, oltop, last);
1519 sprintf(CS name2, "*%.50s_flags", name);
1520 ol3 = find_option(name2, oltop, last);
1521
1522 if (ol2 == NULL || ol3 == NULL)
1523 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1524 "rewrite rules not available for driver");
1525
1526 if (data_block == NULL)
1527 {
1528 chain = (rewrite_rule **)(ol2->value);
1529 flagptr = (int *)(ol3->value);
1530 }
1531 else
1532 {
1533 chain = (rewrite_rule **)((uschar *)data_block + (long int)(ol2->value));
1534 flagptr = (int *)((uschar *)data_block + (long int)(ol3->value));
1535 }
1536
1537 while ((p = string_nextinlist(&sptr, &sep, big_buffer, BIG_BUFFER_SIZE))
1538 != NULL)
1539 {
1540 rewrite_rule *next = readconf_one_rewrite(p, flagptr, FALSE);
1541 *chain = next;
1542 chain = &(next->next);
1543 }
1544
1545 if ((*flagptr & (rewrite_all_envelope | rewrite_smtp)) != 0)
1546 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "rewrite rule specifies a "
1547 "non-header rewrite - not allowed at transport time -");
1548 }
1549 break;
1550
1551 /* If it was an expanded uid, see if there is any expansion to be
1552 done by checking for the presence of a $ character. If there is, save it
1553 in the corresponding *expand_user option field. Otherwise, fall through
1554 to treat it as a fixed uid. Ensure mutual exclusivity of the two kinds
1555 of data. */
1556
1557 case opt_expand_uid:
1558 sprintf(CS name2, "*expand_%.50s", name);
1559 ol2 = find_option(name2, oltop, last);
1560 if (ol2 != NULL)
1561 {
1562 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1563
1564 if (data_block == NULL)
1565 *((uschar **)(ol2->value)) = ss;
1566 else
1567 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1568
1569 if (ss != NULL)
1570 {
1571 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1572 freesptr = FALSE;
1573 break;
1574 }
1575 }
1576
1577 /* Look up a fixed uid, and also make use of the corresponding gid
1578 if a passwd entry is returned and the gid has not been set. */
1579
1580 case opt_uid:
1581 if (!route_finduser(sptr, &pw, &uid))
1582 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found", sptr);
1583 if (data_block == NULL)
1584 *((uid_t *)(ol->value)) = uid;
1585 else
1586 *((uid_t *)((uschar *)data_block + (long int)(ol->value))) = uid;
1587
1588 /* Set the flag indicating a fixed value is set */
1589
1590 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1591
1592 /* Handle matching gid if we have a passwd entry: done by finding the
1593 same name with terminating "user" changed to "group"; if not found,
1594 ignore. Also ignore if the value is already set. */
1595
1596 if (pw == NULL) break;
1597 Ustrcpy(name+Ustrlen(name)-4, "group");
1598 ol2 = find_option(name, oltop, last);
1599 if (ol2 != NULL && ((ol2->type & opt_mask) == opt_gid ||
1600 (ol2->type & opt_mask) == opt_expand_gid))
1601 {
1602 BOOL *set_flag = get_set_flag(name, oltop, last, data_block);
1603 if (! *set_flag)
1604 {
1605 if (data_block == NULL)
1606 *((gid_t *)(ol2->value)) = pw->pw_gid;
1607 else
1608 *((gid_t *)((uschar *)data_block + (long int)(ol2->value))) = pw->pw_gid;
1609 *set_flag = TRUE;
1610 }
1611 }
1612 break;
1613
1614 /* If it was an expanded gid, see if there is any expansion to be
1615 done by checking for the presence of a $ character. If there is, save it
1616 in the corresponding *expand_user option field. Otherwise, fall through
1617 to treat it as a fixed gid. Ensure mutual exclusivity of the two kinds
1618 of data. */
1619
1620 case opt_expand_gid:
1621 sprintf(CS name2, "*expand_%.50s", name);
1622 ol2 = find_option(name2, oltop, last);
1623 if (ol2 != NULL)
1624 {
1625 uschar *ss = (Ustrchr(sptr, '$') != NULL)? sptr : NULL;
1626
1627 if (data_block == NULL)
1628 *((uschar **)(ol2->value)) = ss;
1629 else
1630 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = ss;
1631
1632 if (ss != NULL)
1633 {
1634 *(get_set_flag(name, oltop, last, data_block)) = FALSE;
1635 freesptr = FALSE;
1636 break;
1637 }
1638 }
1639
1640 /* Handle freestanding gid */
1641
1642 case opt_gid:
1643 if (!route_findgroup(sptr, &gid))
1644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found", sptr);
1645 if (data_block == NULL)
1646 *((gid_t *)(ol->value)) = gid;
1647 else
1648 *((gid_t *)((uschar *)data_block + (long int)(ol->value))) = gid;
1649 *(get_set_flag(name, oltop, last, data_block)) = TRUE;
1650 break;
1651
1652 /* If it was a uid list, look up each individual entry, and build
1653 a vector of uids, with a count in the first element. Put the vector
1654 in malloc store so we can free the string. (We are reading into
1655 permanent store already.) */
1656
1657 case opt_uidlist:
1658 {
1659 int count = 1;
1660 uid_t *list;
1661 int ptr = 0;
1662 uschar *p;
1663 uschar *op = expand_string (sptr);
1664
1665 if (op == NULL)
1666 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1667 name, expand_string_message);
1668
1669 p = op;
1670 if (*p != 0) count++;
1671 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1672 list = store_malloc(count*sizeof(uid_t));
1673 list[ptr++] = (uid_t)(count - 1);
1674
1675 if (data_block == NULL)
1676 *((uid_t **)(ol->value)) = list;
1677 else
1678 *((uid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1679
1680 p = op;
1681 while (count-- > 1)
1682 {
1683 int sep = 0;
1684 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1685 if (!route_finduser(big_buffer, NULL, &uid))
1686 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "user %s was not found",
1687 big_buffer);
1688 list[ptr++] = uid;
1689 }
1690 }
1691 break;
1692
1693 /* If it was a gid list, look up each individual entry, and build
1694 a vector of gids, with a count in the first element. Put the vector
1695 in malloc store so we can free the string. (We are reading into permanent
1696 store already.) */
1697
1698 case opt_gidlist:
1699 {
1700 int count = 1;
1701 gid_t *list;
1702 int ptr = 0;
1703 uschar *p;
1704 uschar *op = expand_string (sptr);
1705
1706 if (op == NULL)
1707 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "failed to expand %s: %s",
1708 name, expand_string_message);
1709
1710 p = op;
1711 if (*p != 0) count++;
1712 while (*p != 0) if (*p++ == ':' && *p != 0) count++;
1713 list = store_malloc(count*sizeof(gid_t));
1714 list[ptr++] = (gid_t)(count - 1);
1715
1716 if (data_block == NULL)
1717 *((gid_t **)(ol->value)) = list;
1718 else
1719 *((gid_t **)((uschar *)data_block + (long int)(ol->value))) = list;
1720
1721 p = op;
1722 while (count-- > 1)
1723 {
1724 int sep = 0;
1725 (void)string_nextinlist(&p, &sep, big_buffer, BIG_BUFFER_SIZE);
1726 if (!route_findgroup(big_buffer, &gid))
1727 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "group %s was not found",
1728 big_buffer);
1729 list[ptr++] = gid;
1730 }
1731 }
1732 break;
1733 }
1734
1735 /* Release store if the value of the string doesn't need to be kept. */
1736
1737 if (freesptr) store_reset(reset_point);
1738 break;
1739
1740 /* Expanded boolean: if no characters follow, or if there are no dollar
1741 characters, this is a fixed-valued boolean, and we fall through. Otherwise,
1742 save the string for later expansion in the alternate place. */
1743
1744 case opt_expand_bool:
1745 if (*s != 0 && Ustrchr(s, '$') != 0)
1746 {
1747 sprintf(CS name2, "*expand_%.50s", name);
1748 ol2 = find_option(name2, oltop, last);
1749 if (ol2 != NULL)
1750 {
1751 reset_point = sptr = read_string(s, name);
1752 if (data_block == NULL)
1753 *((uschar **)(ol2->value)) = sptr;
1754 else
1755 *((uschar **)((uschar *)data_block + (long int)(ol2->value))) = sptr;
1756 freesptr = FALSE;
1757 break;
1758 }
1759 }
1760 /* Fall through */
1761
1762 /* Boolean: if no characters follow, the value is boolvalue. Otherwise
1763 look for yes/not/true/false. Some booleans are stored in a single bit in
1764 a single int. There's a special fudge for verify settings; without a suffix
1765 they set both xx_sender and xx_recipient. The table points to the sender
1766 value; search subsequently for the recipient. There's another special case:
1767 opt_bool_set also notes when a boolean has been set. */
1768
1769 case opt_bool:
1770 case opt_bit:
1771 case opt_bool_verify:
1772 case opt_bool_set:
1773 if (*s != 0)
1774 {
1775 s = readconf_readname(name2, 64, s);
1776 if (strcmpic(name2, US"true") == 0 || strcmpic(name2, US"yes") == 0)
1777 boolvalue = TRUE;
1778 else if (strcmpic(name2, US"false") == 0 || strcmpic(name2, US"no") == 0)
1779 boolvalue = FALSE;
1780 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1781 "\"%s\" is not a valid value for the \"%s\" option", name2, name);
1782 if (*s != 0) extra_chars_error(s, string_sprintf("\"%s\" ", name2),
1783 US"for boolean option ", name);
1784 }
1785
1786 /* Handle single-bit type. */
1787
1788 if (type == opt_bit)
1789 {
1790 int bit = 1 << ((ol->type >> 16) & 31);
1791 int *ptr = (data_block == NULL)?
1792 (int *)(ol->value) :
1793 (int *)((uschar *)data_block + (long int)ol->value);
1794 if (boolvalue) *ptr |= bit; else *ptr &= ~bit;
1795 break;
1796 }
1797
1798 /* Handle full BOOL types */
1799
1800 if (data_block == NULL)
1801 *((BOOL *)(ol->value)) = boolvalue;
1802 else
1803 *((BOOL *)((uschar *)data_block + (long int)(ol->value))) = boolvalue;
1804
1805 /* Verify fudge */
1806
1807 if (type == opt_bool_verify)
1808 {
1809 sprintf(CS name2, "%.50s_recipient", name + offset);
1810 ol2 = find_option(name2, oltop, last);
1811 if (ol2 != NULL)
1812 {
1813 if (data_block == NULL)
1814 *((BOOL *)(ol2->value)) = boolvalue;
1815 else
1816 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = boolvalue;
1817 }
1818 }
1819
1820 /* Note that opt_bool_set type is set, if there is somewhere to do so */
1821
1822 else if (type == opt_bool_set)
1823 {
1824 sprintf(CS name2, "*set_%.50s", name + offset);
1825 ol2 = find_option(name2, oltop, last);
1826 if (ol2 != NULL)
1827 {
1828 if (data_block == NULL)
1829 *((BOOL *)(ol2->value)) = TRUE;
1830 else
1831 *((BOOL *)((uschar *)data_block + (long int)(ol2->value))) = TRUE;
1832 }
1833 }
1834 break;
1835
1836 /* Octal integer */
1837
1838 case opt_octint:
1839 intbase = 8;
1840 inttype = US"octal ";
1841
1842 /* Integer: a simple(ish) case; allow octal and hex formats, and
1843 suffixes K and M. The different types affect output, not input. */
1844
1845 case opt_mkint:
1846 case opt_int:
1847 {
1848 uschar *endptr;
1849 long int lvalue;
1850
1851 errno = 0;
1852 lvalue = strtol(CS s, CSS &endptr, intbase);
1853
1854 if (endptr == s)
1855 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1856 inttype, name);
1857
1858 if (errno != ERANGE)
1859 {
1860 if (tolower(*endptr) == 'k')
1861 {
1862 if (lvalue > INT_MAX/1024 || lvalue < INT_MIN/1024) errno = ERANGE;
1863 else lvalue *= 1024;
1864 endptr++;
1865 }
1866 else if (tolower(*endptr) == 'm')
1867 {
1868 if (lvalue > INT_MAX/(1024*1024) || lvalue < INT_MIN/(1024*1024))
1869 errno = ERANGE;
1870 else lvalue *= 1024*1024;
1871 endptr++;
1872 }
1873 }
1874
1875 if (errno == ERANGE || lvalue > INT_MAX || lvalue < INT_MIN)
1876 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1877 "absolute value of integer \"%s\" is too large (overflow)", s);
1878
1879 while (isspace(*endptr)) endptr++;
1880 if (*endptr != 0)
1881 extra_chars_error(endptr, inttype, US"integer value for ", name);
1882
1883 value = (int)lvalue;
1884 }
1885
1886 if (data_block == NULL)
1887 *((int *)(ol->value)) = value;
1888 else
1889 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1890 break;
1891
1892 /* Integer held in K: again, allow octal and hex formats, and suffixes K and
1893 M. */
1894
1895 case opt_Kint:
1896 {
1897 uschar *endptr;
1898 errno = 0;
1899 value = strtol(CS s, CSS &endptr, intbase);
1900
1901 if (endptr == s)
1902 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%sinteger expected for %s",
1903 inttype, name);
1904
1905 if (errno != ERANGE)
1906 {
1907 if (tolower(*endptr) == 'm')
1908 {
1909 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
1910 else value *= 1024;
1911 endptr++;
1912 }
1913 else if (tolower(*endptr) == 'k')
1914 {
1915 endptr++;
1916 }
1917 else
1918 {
1919 value = (value + 512)/1024;
1920 }
1921 }
1922
1923 if (errno == ERANGE) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1924 "absolute value of integer \"%s\" is too large (overflow)", s);
1925
1926 while (isspace(*endptr)) endptr++;
1927 if (*endptr != 0)
1928 extra_chars_error(endptr, inttype, US"integer value for ", name);
1929 }
1930
1931 if (data_block == NULL)
1932 *((int *)(ol->value)) = value;
1933 else
1934 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1935 break;
1936
1937 /* Fixed-point number: held to 3 decimal places. */
1938
1939 case opt_fixed:
1940 if (sscanf(CS s, "%d%n", &value, &count) != 1)
1941 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1942 "fixed-point number expected for %s", name);
1943
1944 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1945 "integer \"%s\" is too large (overflow)", s);
1946
1947 value *= 1000;
1948
1949 if (value < 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
1950 "integer \"%s\" is too large (overflow)", s);
1951
1952 if (s[count] == '.')
1953 {
1954 int d = 100;
1955 while (isdigit(s[++count]))
1956 {
1957 value += (s[count] - '0') * d;
1958 d /= 10;
1959 }
1960 }
1961
1962 while (isspace(s[count])) count++;
1963
1964 if (s[count] != 0)
1965 extra_chars_error(s+count, US"fixed-point value for ", name, US"");
1966
1967 if (data_block == NULL)
1968 *((int *)(ol->value)) = value;
1969 else
1970 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1971 break;
1972
1973 /* There's a special routine to read time values. */
1974
1975 case opt_time:
1976 value = readconf_readtime(s, 0, FALSE);
1977 if (value < 0)
1978 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
1979 name);
1980 if (data_block == NULL)
1981 *((int *)(ol->value)) = value;
1982 else
1983 *((int *)((uschar *)data_block + (long int)(ol->value))) = value;
1984 break;
1985
1986 /* A time list is a list of colon-separated times, with the first
1987 element holding the size of the list and the second the number of
1988 entries used. */
1989
1990 case opt_timelist:
1991 {
1992 int count = 0;
1993 int *list = (data_block == NULL)?
1994 (int *)(ol->value) :
1995 (int *)((uschar *)data_block + (long int)(ol->value));
1996
1997 if (*s != 0) for (count = 1; count <= list[0] - 2; count++)
1998 {
1999 int terminator = 0;
2000 uschar *snext = Ustrchr(s, ':');
2001 if (snext != NULL)
2002 {
2003 uschar *ss = snext;
2004 while (ss > s && isspace(ss[-1])) ss--;
2005 terminator = *ss;
2006 }
2007 value = readconf_readtime(s, terminator, FALSE);
2008 if (value < 0)
2009 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "invalid time value for %s",
2010 name);
2011 if (count > 1 && value <= list[count])
2012 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2013 "time value out of order for %s", name);
2014 list[count+1] = value;
2015 if (snext == NULL) break;
2016 s = snext + 1;
2017 while (isspace(*s)) s++;
2018 }
2019
2020 if (count > list[0] - 2)
2021 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many time values for %s",
2022 name);
2023 if (count > 0 && list[2] == 0) count = 0;
2024 list[1] = count;
2025 }
2026
2027 break;
2028 }
2029
2030 return TRUE;
2031 }
2032
2033
2034
2035 /*************************************************
2036 * Print a time value *
2037 *************************************************/
2038
2039 /*
2040 Argument: a time value in seconds
2041 Returns: pointer to a fixed buffer containing the time as a string,
2042 in readconf_readtime() format
2043 */
2044
2045 uschar *
2046 readconf_printtime(int t)
2047 {
2048 int s, m, h, d, w;
2049 uschar *p = time_buffer;
2050
2051 if (t < 0)
2052 {
2053 *p++ = '-';
2054 t = -t;
2055 }
2056
2057 s = t % 60;
2058 t /= 60;
2059 m = t % 60;
2060 t /= 60;
2061 h = t % 24;
2062 t /= 24;
2063 d = t % 7;
2064 w = t/7;
2065
2066 if (w > 0) { sprintf(CS p, "%dw", w); while (*p) p++; }
2067 if (d > 0) { sprintf(CS p, "%dd", d); while (*p) p++; }
2068 if (h > 0) { sprintf(CS p, "%dh", h); while (*p) p++; }
2069 if (m > 0) { sprintf(CS p, "%dm", m); while (*p) p++; }
2070 if (s > 0 || p == time_buffer) sprintf(CS p, "%ds", s);
2071
2072 return time_buffer;
2073 }
2074
2075
2076
2077 /*************************************************
2078 * Print an individual option value *
2079 *************************************************/
2080
2081 /* This is used by the -bP option, so prints to the standard output.
2082 The entire options list is passed in as an argument, because some options come
2083 in pairs - typically uid/gid settings, which can either be explicit numerical
2084 values, or strings to be expanded later. If the numerical value is unset,
2085 search for "*expand_<name>" to see if there is a string equivalent.
2086
2087 Arguments:
2088 ol option entry, or NULL for an unknown option
2089 name option name
2090 options_block NULL for main configuration options; otherwise points to
2091 a driver block; if the option doesn't have opt_public
2092 set, then options_block->options_block is where the item
2093 resides.
2094 oltop points to the option list in which ol exists
2095 last one more than the offset of the last entry in optop
2096
2097 Returns: nothing
2098 */
2099
2100 static void
2101 print_ol(optionlist *ol, uschar *name, void *options_block,
2102 optionlist *oltop, int last)
2103 {
2104 struct passwd *pw;
2105 struct group *gr;
2106 optionlist *ol2;
2107 void *value;
2108 uid_t *uidlist;
2109 gid_t *gidlist;
2110 uschar *s;
2111 uschar name2[64];
2112
2113 if (ol == NULL)
2114 {
2115 printf("%s is not a known option\n", name);
2116 return;
2117 }
2118
2119 /* Non-admin callers cannot see options that have been flagged secure by the
2120 "hide" prefix. */
2121
2122 if (!admin_user && (ol->type & opt_secure) != 0)
2123 {
2124 printf("%s = <value not displayable>\n", name);
2125 return;
2126 }
2127
2128 /* Else show the value of the option */
2129
2130 value = ol->value;
2131 if (options_block != NULL)
2132 {
2133 if ((ol->type & opt_public) == 0)
2134 options_block = (void *)(((driver_instance *)options_block)->options_block);
2135 value = (void *)((uschar *)options_block + (long int)value);
2136 }
2137
2138 switch(ol->type & opt_mask)
2139 {
2140 case opt_stringptr:
2141 case opt_rewrite: /* Show the text value */
2142 s = *((uschar **)value);
2143 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing2(s, FALSE));
2144 break;
2145
2146 case opt_int:
2147 printf("%s = %d\n", name, *((int *)value));
2148 break;
2149
2150 case opt_mkint:
2151 {
2152 int x = *((int *)value);
2153 if (x != 0 && (x & 1023) == 0)
2154 {
2155 int c = 'K';
2156 x >>= 10;
2157 if ((x & 1023) == 0)
2158 {
2159 c = 'M';
2160 x >>= 10;
2161 }
2162 printf("%s = %d%c\n", name, x, c);
2163 }
2164 else printf("%s = %d\n", name, x);
2165 }
2166 break;
2167
2168 case opt_Kint:
2169 {
2170 int x = *((int *)value);
2171 if (x == 0) printf("%s = 0\n", name);
2172 else if ((x & 1023) == 0) printf("%s = %dM\n", name, x >> 10);
2173 else printf("%s = %dK\n", name, x);
2174 }
2175 break;
2176
2177 case opt_octint:
2178 printf("%s = %#o\n", name, *((int *)value));
2179 break;
2180
2181 /* Can be negative only when "unset", in which case integer */
2182
2183 case opt_fixed:
2184 {
2185 int x = *((int *)value);
2186 int f = x % 1000;
2187 int d = 100;
2188 if (x < 0) printf("%s =\n", name); else
2189 {
2190 printf("%s = %d.", name, x/1000);
2191 do
2192 {
2193 printf("%d", f/d);
2194 f %= d;
2195 d /= 10;
2196 }
2197 while (f != 0);
2198 printf("\n");
2199 }
2200 }
2201 break;
2202
2203 /* If the numerical value is unset, try for the string value */
2204
2205 case opt_expand_uid:
2206 if (! *get_set_flag(name, oltop, last, options_block))
2207 {
2208 sprintf(CS name2, "*expand_%.50s", name);
2209 ol2 = find_option(name2, oltop, last);
2210 if (ol2 != NULL)
2211 {
2212 void *value2 = ol2->value;
2213 if (options_block != NULL)
2214 value2 = (void *)((uschar *)options_block + (long int)value2);
2215 s = *((uschar **)value2);
2216 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2217 break;
2218 }
2219 }
2220
2221 /* Else fall through */
2222
2223 case opt_uid:
2224 if (! *get_set_flag(name, oltop, last, options_block))
2225 printf("%s =\n", name);
2226 else
2227 {
2228 pw = getpwuid(*((uid_t *)value));
2229 if (pw == NULL)
2230 printf("%s = %ld\n", name, (long int)(*((uid_t *)value)));
2231 else printf("%s = %s\n", name, pw->pw_name);
2232 }
2233 break;
2234
2235 /* If the numerical value is unset, try for the string value */
2236
2237 case opt_expand_gid:
2238 if (! *get_set_flag(name, oltop, last, options_block))
2239 {
2240 sprintf(CS name2, "*expand_%.50s", name);
2241 ol2 = find_option(name2, oltop, last);
2242 if (ol2 != NULL && (ol2->type & opt_mask) == opt_stringptr)
2243 {
2244 void *value2 = ol2->value;
2245 if (options_block != NULL)
2246 value2 = (void *)((uschar *)options_block + (long int)value2);
2247 s = *((uschar **)value2);
2248 printf("%s = %s\n", name, (s == NULL)? US"" : string_printing(s));
2249 break;
2250 }
2251 }
2252
2253 /* Else fall through */
2254
2255 case opt_gid:
2256 if (! *get_set_flag(name, oltop, last, options_block))
2257 printf("%s =\n", name);
2258 else
2259 {
2260 gr = getgrgid(*((int *)value));
2261 if (gr == NULL)
2262 printf("%s = %ld\n", name, (long int)(*((int *)value)));
2263 else printf("%s = %s\n", name, gr->gr_name);
2264 }
2265 break;
2266
2267 case opt_uidlist:
2268 uidlist = *((uid_t **)value);
2269 printf("%s =", name);
2270 if (uidlist != NULL)
2271 {
2272 int i;
2273 uschar sep = ' ';
2274 for (i = 1; i <= (int)(uidlist[0]); i++)
2275 {
2276 uschar *name = NULL;
2277 pw = getpwuid(uidlist[i]);
2278 if (pw != NULL) name = US pw->pw_name;
2279 if (name != NULL) printf("%c%s", sep, name);
2280 else printf("%c%ld", sep, (long int)(uidlist[i]));
2281 sep = ':';
2282 }
2283 }
2284 printf("\n");
2285 break;
2286
2287 case opt_gidlist:
2288 gidlist = *((gid_t **)value);
2289 printf("%s =", name);
2290 if (gidlist != NULL)
2291 {
2292 int i;
2293 uschar sep = ' ';
2294 for (i = 1; i <= (int)(gidlist[0]); i++)
2295 {
2296 uschar *name = NULL;
2297 gr = getgrgid(gidlist[i]);
2298 if (gr != NULL) name = US gr->gr_name;
2299 if (name != NULL) printf("%c%s", sep, name);
2300 else printf("%c%ld", sep, (long int)(gidlist[i]));
2301 sep = ':';
2302 }
2303 }
2304 printf("\n");
2305 break;
2306
2307 case opt_time:
2308 printf("%s = %s\n", name, readconf_printtime(*((int *)value)));
2309 break;
2310
2311 case opt_timelist:
2312 {
2313 int i;
2314 int *list = (int *)value;
2315 printf("%s = ", name);
2316 for (i = 0; i < list[1]; i++)
2317 printf("%s%s", (i == 0)? "" : ":", readconf_printtime(list[i+2]));
2318 printf("\n");
2319 }
2320 break;
2321
2322 case opt_bit:
2323 printf("%s%s\n", ((*((int *)value)) & (1 << ((ol->type >> 16) & 31)))?
2324 "" : "no_", name);
2325 break;
2326
2327 case opt_expand_bool:
2328 sprintf(CS name2, "*expand_%.50s", name);
2329 ol2 = find_option(name2, oltop, last);
2330 if (ol2 != NULL && ol2->value != NULL)
2331 {
2332 void *value2 = ol2->value;
2333 if (options_block != NULL)
2334 value2 = (void *)((uschar *)options_block + (long int)value2);
2335 s = *((uschar **)value2);
2336 if (s != NULL)
2337 {
2338 printf("%s = %s\n", name, string_printing(s));
2339 break;
2340 }
2341 /* s == NULL => string not set; fall through */
2342 }
2343
2344 /* Fall through */
2345
2346 case opt_bool:
2347 case opt_bool_verify:
2348 case opt_bool_set:
2349 printf("%s%s\n", (*((BOOL *)value))? "" : "no_", name);
2350 break;
2351 }
2352 }
2353
2354
2355
2356 /*************************************************
2357 * Print value from main configuration *
2358 *************************************************/
2359
2360 /* This function, called as a result of encountering the -bP option,
2361 causes the value of any main configuration variable to be output if the
2362 second argument is NULL. There are some special values:
2363
2364 all print all main configuration options
2365 configure_file print the name of the configuration file
2366 routers print the routers' configurations
2367 transports print the transports' configuration
2368 authenticators print the authenticators' configuration
2369 macros print the macros' configuration
2370 router_list print a list of router names
2371 transport_list print a list of transport names
2372 authenticator_list print a list of authentication mechanism names
2373 macro_list print a list of macro names
2374 +name print a named list item
2375 local_scan print the local_scan options
2376
2377 If the second argument is not NULL, it must be one of "router", "transport",
2378 "authenticator" or "macro" in which case the first argument identifies the
2379 driver whose options are to be printed.
2380
2381 Arguments:
2382 name option name if type == NULL; else driver name
2383 type NULL or driver type name, as described above
2384
2385 Returns: nothing
2386 */
2387
2388 void
2389 readconf_print(uschar *name, uschar *type)
2390 {
2391 BOOL names_only = FALSE;
2392 optionlist *ol;
2393 optionlist *ol2 = NULL;
2394 driver_instance *d = NULL;
2395 macro_item *m;
2396 int size = 0;
2397
2398 if (type == NULL)
2399 {
2400 if (*name == '+')
2401 {
2402 int i;
2403 tree_node *t;
2404 BOOL found = FALSE;
2405 static uschar *types[] = { US"address", US"domain", US"host",
2406 US"localpart" };
2407 static tree_node **anchors[] = { &addresslist_anchor, &domainlist_anchor,
2408 &hostlist_anchor, &localpartlist_anchor };
2409
2410 for (i = 0; i < 4; i++)
2411 {
2412 t = tree_search(*(anchors[i]), name+1);
2413 if (t != NULL)
2414 {
2415 found = TRUE;
2416 printf("%slist %s = %s\n", types[i], name+1,
2417 ((namedlist_block *)(t->data.ptr))->string);
2418 }
2419 }
2420
2421 if (!found)
2422 printf("no address, domain, host, or local part list called \"%s\" "
2423 "exists\n", name+1);
2424
2425 return;
2426 }
2427
2428 if (Ustrcmp(name, "configure_file") == 0)
2429 {
2430 printf("%s\n", CS config_main_filename);
2431 return;
2432 }
2433
2434 if (Ustrcmp(name, "all") == 0)
2435 {
2436 for (ol = optionlist_config;
2437 ol < optionlist_config + optionlist_config_size; ol++)
2438 {
2439 if ((ol->type & opt_hidden) == 0)
2440 print_ol(ol, US ol->name, NULL, optionlist_config, optionlist_config_size);
2441 }
2442 return;
2443 }
2444
2445 if (Ustrcmp(name, "local_scan") == 0)
2446 {
2447 #ifndef LOCAL_SCAN_HAS_OPTIONS
2448 printf("local_scan() options are not supported\n");
2449 #else
2450 for (ol = local_scan_options;
2451 ol < local_scan_options + local_scan_options_count; ol++)
2452 {
2453 print_ol(ol, US ol->name, NULL, local_scan_options,
2454 local_scan_options_count);
2455 }
2456 #endif
2457 return;
2458 }
2459
2460 if (Ustrcmp(name, "routers") == 0)
2461 {
2462 type = US"router";
2463 name = NULL;
2464 }
2465 else if (Ustrcmp(name, "transports") == 0)
2466 {
2467 type = US"transport";
2468 name = NULL;
2469 }
2470
2471 else if (Ustrcmp(name, "authenticators") == 0)
2472 {
2473 type = US"authenticator";
2474 name = NULL;
2475 }
2476
2477 else if (Ustrcmp(name, "macros") == 0)
2478 {
2479 type = US"macro";
2480 name = NULL;
2481 }
2482
2483 else if (Ustrcmp(name, "router_list") == 0)
2484 {
2485 type = US"router";
2486 name = NULL;
2487 names_only = TRUE;
2488 }
2489
2490 else if (Ustrcmp(name, "transport_list") == 0)
2491 {
2492 type = US"transport";
2493 name = NULL;
2494 names_only = TRUE;
2495 }
2496
2497 else if (Ustrcmp(name, "authenticator_list") == 0)
2498 {
2499 type = US"authenticator";
2500 name = NULL;
2501 names_only = TRUE;
2502 }
2503
2504 else if (Ustrcmp(name, "macro_list") == 0)
2505 {
2506 type = US"macro";
2507 name = NULL;
2508 names_only = TRUE;
2509 }
2510
2511 else
2512 {
2513 print_ol(find_option(name, optionlist_config, optionlist_config_size),
2514 name, NULL, optionlist_config, optionlist_config_size);
2515 return;
2516 }
2517 }
2518
2519 /* Handle the options for a router or transport. Skip options that are flagged
2520 as hidden. Some of these are options with names starting with '*', used for
2521 internal alternative representations of other options (which the printing
2522 function will sort out). Others are synonyms kept for backward compatibility.
2523 */
2524
2525 if (Ustrcmp(type, "router") == 0)
2526 {
2527 d = (driver_instance *)routers;
2528 ol2 = optionlist_routers;
2529 size = optionlist_routers_size;
2530 }
2531 else if (Ustrcmp(type, "transport") == 0)
2532 {
2533 d = (driver_instance *)transports;
2534 ol2 = optionlist_transports;
2535 size = optionlist_transports_size;
2536 }
2537 else if (Ustrcmp(type, "authenticator") == 0)
2538 {
2539 d = (driver_instance *)auths;
2540 ol2 = optionlist_auths;
2541 size = optionlist_auths_size;
2542 }
2543
2544 else if (Ustrcmp(type, "macro") == 0)
2545 {
2546 /* People store passwords in macros and they were previously not available
2547 for printing. So we have an admin_users restriction. */
2548 if (!admin_user)
2549 {
2550 fprintf(stderr, "exim: permission denied\n");
2551 exit(EXIT_FAILURE);
2552 }
2553 for (m = macros; m != NULL; m = m->next)
2554 {
2555 if (name == NULL || Ustrcmp(name, m->name) == 0)
2556 {
2557 if (names_only)
2558 printf("%s\n", CS m->name);
2559 else
2560 printf("%s=%s\n", CS m->name, CS m->replacement);
2561 if (name != NULL)
2562 return;
2563 }
2564 }
2565 if (name != NULL)
2566 printf("%s %s not found\n", type, name);
2567 return;
2568 }
2569
2570 if (names_only)
2571 {
2572 for (; d != NULL; d = d->next) printf("%s\n", CS d->name);
2573 return;
2574 }
2575
2576 /* Either search for a given driver, or print all of them */
2577
2578 for (; d != NULL; d = d->next)
2579 {
2580 if (name == NULL)
2581 printf("\n%s %s:\n", d->name, type);
2582 else if (Ustrcmp(d->name, name) != 0) continue;
2583
2584 for (ol = ol2; ol < ol2 + size; ol++)
2585 {
2586 if ((ol->type & opt_hidden) == 0)
2587 print_ol(ol, US ol->name, d, ol2, size);
2588 }
2589
2590 for (ol = d->info->options;
2591 ol < d->info->options + *(d->info->options_count); ol++)
2592 {
2593 if ((ol->type & opt_hidden) == 0)
2594 print_ol(ol, US ol->name, d, d->info->options, *(d->info->options_count));
2595 }
2596 if (name != NULL) return;
2597 }
2598 if (name != NULL) printf("%s %s not found\n", type, name);
2599 }
2600
2601
2602
2603 /*************************************************
2604 * Read a named list item *
2605 *************************************************/
2606
2607 /* This function reads a name and a list (i.e. string). The name is used to
2608 save the list in a tree, sorted by its name. Each entry also has a number,
2609 which can be used for caching tests, but if the string contains any expansion
2610 items other than $key, the number is set negative to inhibit caching. This
2611 mechanism is used for domain, host, and address lists that are referenced by
2612 the "+name" syntax.
2613
2614 Arguments:
2615 anchorp points to the tree anchor
2616 numberp points to the current number for this tree
2617 max the maximum number permitted
2618 s the text of the option line, starting immediately after the name
2619 of the list type
2620 tname the name of the list type, for messages
2621
2622 Returns: nothing
2623 */
2624
2625 static void
2626 read_named_list(tree_node **anchorp, int *numberp, int max, uschar *s,
2627 uschar *tname)
2628 {
2629 BOOL forcecache = FALSE;
2630 uschar *ss;
2631 tree_node *t;
2632 namedlist_block *nb = store_get(sizeof(namedlist_block));
2633
2634 if (Ustrncmp(s, "_cache", 6) == 0)
2635 {
2636 forcecache = TRUE;
2637 s += 6;
2638 }
2639
2640 if (!isspace(*s))
2641 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unrecognized configuration line");
2642
2643 if (*numberp >= max)
2644 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "too many named %ss (max is %d)\n",
2645 tname, max);
2646
2647 while (isspace(*s)) s++;
2648 ss = s;
2649 while (isalnum(*s) || *s == '_') s++;
2650 t = store_get(sizeof(tree_node) + s-ss);
2651 Ustrncpy(t->name, ss, s-ss);
2652 t->name[s-ss] = 0;
2653 while (isspace(*s)) s++;
2654
2655 if (!tree_insertnode(anchorp, t))
2656 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2657 "duplicate name \"%s\" for a named %s", t->name, tname);
2658
2659 t->data.ptr = nb;
2660 nb->number = *numberp;
2661 *numberp += 1;
2662
2663 if (*s++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
2664 "missing '=' after \"%s\"", t->name);
2665 while (isspace(*s)) s++;
2666 nb->string = read_string(s, t->name);
2667 nb->cache_data = NULL;
2668
2669 /* Check the string for any expansions; if any are found, mark this list
2670 uncacheable unless the user has explicited forced caching. */
2671
2672 if (!forcecache && Ustrchr(nb->string, '$') != NULL) nb->number = -1;
2673 }
2674
2675
2676
2677
2678 /*************************************************
2679 * Unpick data for a rate limit *
2680 *************************************************/
2681
2682 /* This function is called to unpick smtp_ratelimit_{mail,rcpt} into four
2683 separate values.
2684
2685 Arguments:
2686 s string, in the form t,b,f,l
2687 where t is the threshold (integer)
2688 b is the initial delay (time)
2689 f is the multiplicative factor (fixed point)
2690 k is the maximum time (time)
2691 threshold where to store threshold
2692 base where to store base in milliseconds
2693 factor where to store factor in milliseconds
2694 limit where to store limit
2695
2696 Returns: nothing (panics on error)
2697 */
2698
2699 static void
2700 unpick_ratelimit(uschar *s, int *threshold, int *base, double *factor,
2701 int *limit)
2702 {
2703 uschar bstring[16], lstring[16];
2704
2705 if (sscanf(CS s, "%d, %15[0123456789smhdw.], %lf, %15s", threshold, bstring,
2706 factor, lstring) == 4)
2707 {
2708 *base = readconf_readtime(bstring, 0, TRUE);
2709 *limit = readconf_readtime(lstring, 0, TRUE);
2710 if (*base >= 0 && *limit >= 0) return;
2711 }
2712 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malformed ratelimit data: %s", s);
2713 }
2714
2715
2716
2717
2718 /*************************************************
2719 * Read main configuration options *
2720 *************************************************/
2721
2722 /* This function is the first to be called for configuration reading. It
2723 opens the configuration file and reads general configuration settings until
2724 it reaches the end of the configuration section. The file is then left open so
2725 that the remaining configuration data can subsequently be read if needed for
2726 this run of Exim.
2727
2728 The configuration file must be owned either by root or exim, and be writeable
2729 only by root or uid/gid exim. The values for Exim's uid and gid can be changed
2730 in the config file, so the test is done on the compiled in values. A slight
2731 anomaly, to be carefully documented.
2732
2733 The name of the configuration file is taken from a list that is included in the
2734 binary of Exim. It can be altered from the command line, but if that is done,
2735 root privilege is immediately withdrawn unless the caller is root or exim.
2736 The first file on the list that exists is used.
2737
2738 For use on multiple systems that share file systems, first look for a
2739 configuration file whose name has the current node name on the end. If that is
2740 not found, try the generic name. For really contorted configurations, that run
2741 multiple Exims with different uid settings, first try adding the effective uid
2742 before the node name. These complications are going to waste resources on most
2743 systems. Therefore they are available only when requested by compile-time
2744 options. */
2745
2746 void
2747 readconf_main(void)
2748 {
2749 int sep = 0;
2750 struct stat statbuf;
2751 uschar *s, *filename;
2752 uschar *list = config_main_filelist;
2753
2754 /* Loop through the possible file names */
2755
2756 while((filename = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
2757 != NULL)
2758 {
2759 /* Cut out all the fancy processing unless specifically wanted */
2760
2761 #if defined(CONFIGURE_FILE_USE_NODE) || defined(CONFIGURE_FILE_USE_EUID)
2762 uschar *suffix = filename + Ustrlen(filename);
2763
2764 /* Try for the node-specific file if a node name exists */
2765
2766 #ifdef CONFIGURE_FILE_USE_NODE
2767 struct utsname uts;
2768 if (uname(&uts) >= 0)
2769 {
2770 #ifdef CONFIGURE_FILE_USE_EUID
2771 sprintf(CS suffix, ".%ld.%.256s", (long int)original_euid, uts.nodename);
2772 config_file = Ufopen(filename, "rb");
2773 if (config_file == NULL)
2774 #endif /* CONFIGURE_FILE_USE_EUID */
2775 {
2776 sprintf(CS suffix, ".%.256s", uts.nodename);
2777 config_file = Ufopen(filename, "rb");
2778 }
2779 }
2780 #endif /* CONFIGURE_FILE_USE_NODE */
2781
2782 /* Otherwise, try the generic name, possibly with the euid added */
2783
2784 #ifdef CONFIGURE_FILE_USE_EUID
2785 if (config_file == NULL)
2786 {
2787 sprintf(CS suffix, ".%ld", (long int)original_euid);
2788 config_file = Ufopen(filename, "rb");
2789 }
2790 #endif /* CONFIGURE_FILE_USE_EUID */
2791
2792 /* Finally, try the unadorned name */
2793
2794 if (config_file == NULL)
2795 {
2796 *suffix = 0;
2797 config_file = Ufopen(filename, "rb");
2798 }
2799 #else /* if neither defined */
2800
2801 /* This is the common case when the fancy processing is not included. */
2802
2803 config_file = Ufopen(filename, "rb");
2804 #endif
2805
2806 /* If the file does not exist, continue to try any others. For any other
2807 error, break out (and die). */
2808
2809 if (config_file != NULL || errno != ENOENT) break;
2810 }
2811
2812 /* On success, save the name for verification; config_filename is used when
2813 logging configuration errors (it changes for .included files) whereas
2814 config_main_filename is the name shown by -bP. Failure to open a configuration
2815 file is a serious disaster. */
2816
2817 if (config_file != NULL)
2818 {
2819 config_filename = config_main_filename = string_copy(filename);
2820 }
2821 else
2822 {
2823 if (filename == NULL)
2824 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "non-existent configuration file(s): "
2825 "%s", config_main_filelist);
2826 else
2827 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", string_open_failed(errno,
2828 "configuration file %s", filename));
2829 }
2830
2831 /* Check the status of the file we have opened, unless it was specified on
2832 the command line, in which case privilege was given away at the start. */
2833
2834 if (!config_changed)
2835 {
2836 if (fstat(fileno(config_file), &statbuf) != 0)
2837 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to stat configuration file %s",
2838 big_buffer);
2839
2840 if ((statbuf.st_uid != root_uid && /* owner not root */
2841 statbuf.st_uid != exim_uid /* owner not exim */
2842 #ifdef CONFIGURE_OWNER
2843 && statbuf.st_uid != config_uid /* owner not the special one */
2844 #endif
2845 ) || /* or */
2846 (statbuf.st_gid != exim_gid /* group not exim & */
2847 #ifdef CONFIGURE_GROUP
2848 && statbuf.st_gid != config_gid /* group not the special one */
2849 #endif
2850 && (statbuf.st_mode & 020) != 0) || /* group writeable */
2851 /* or */
2852 ((statbuf.st_mode & 2) != 0)) /* world writeable */
2853
2854 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Exim configuration file %s has the "
2855 "wrong owner, group, or mode", big_buffer);
2856 }
2857
2858 /* Process the main configuration settings. They all begin with a lower case
2859 letter. If we see something starting with an upper case letter, it is taken as
2860 a macro definition. */
2861
2862 while ((s = get_config_line()) != NULL)
2863 {
2864 if (isupper(s[0])) read_macro_assignment(s);
2865
2866 else if (Ustrncmp(s, "domainlist", 10) == 0)
2867 read_named_list(&domainlist_anchor, &domainlist_count,
2868 MAX_NAMED_LIST, s+10, US"domain list");
2869
2870 else if (Ustrncmp(s, "hostlist", 8) == 0)
2871 read_named_list(&hostlist_anchor, &hostlist_count,
2872 MAX_NAMED_LIST, s+8, US"host list");
2873
2874 else if (Ustrncmp(s, US"addresslist", 11) == 0)
2875 read_named_list(&addresslist_anchor, &addresslist_count,
2876 MAX_NAMED_LIST, s+11, US"address list");
2877
2878 else if (Ustrncmp(s, US"localpartlist", 13) == 0)
2879 read_named_list(&localpartlist_anchor, &localpartlist_count,
2880 MAX_NAMED_LIST, s+13, US"local part list");
2881
2882 else
2883 (void) readconf_handle_option(s, optionlist_config, optionlist_config_size,
2884 NULL, US"main option \"%s\" unknown");
2885 }
2886
2887
2888 /* If local_sender_retain is set, local_from_check must be unset. */
2889
2890 if (local_sender_retain && local_from_check)
2891 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "both local_from_check and "
2892 "local_sender_retain are set; this combination is not allowed");
2893
2894 /* If the timezone string is empty, set it to NULL, implying no TZ variable
2895 wanted. */
2896
2897 if (timezone_string != NULL && *timezone_string == 0) timezone_string = NULL;
2898
2899 /* The max retry interval must not be greater than 24 hours. */
2900
2901 if (retry_interval_max > 24*60*60) retry_interval_max = 24*60*60;
2902
2903 /* remote_max_parallel must be > 0 */
2904
2905 if (remote_max_parallel <= 0) remote_max_parallel = 1;
2906
2907 /* Save the configured setting of freeze_tell, so we can re-instate it at the
2908 start of a new SMTP message. */
2909
2910 freeze_tell_config = freeze_tell;
2911
2912 /* The primary host name may be required for expansion of spool_directory
2913 and log_file_path, so make sure it is set asap. It is obtained from uname(),
2914 but if that yields an unqualified value, make a FQDN by using gethostbyname to
2915 canonize it. Some people like upper case letters in their host names, so we
2916 don't force the case. */
2917
2918 if (primary_hostname == NULL)
2919 {
2920 uschar *hostname;
2921 struct utsname uts;
2922 if (uname(&uts) < 0)
2923 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "uname() failed to yield host name");
2924 hostname = US uts.nodename;
2925
2926 if (Ustrchr(hostname, '.') == NULL)
2927 {
2928 int af = AF_INET;
2929 struct hostent *hostdata;
2930
2931 #if HAVE_IPV6
2932 if (!disable_ipv6 && (dns_ipv4_lookup == NULL ||
2933 match_isinlist(hostname, &dns_ipv4_lookup, 0, NULL, NULL, MCL_DOMAIN,
2934 TRUE, NULL) != OK))
2935 af = AF_INET6;
2936 #else
2937 af = AF_INET;
2938 #endif
2939
2940 for (;;)
2941 {
2942 #if HAVE_IPV6
2943 #if HAVE_GETIPNODEBYNAME
2944 int error_num;
2945 hostdata = getipnodebyname(CS hostname, af, 0, &error_num);
2946 #else
2947 hostdata = gethostbyname2(CS hostname, af);
2948 #endif
2949 #else
2950 hostdata = gethostbyname(CS hostname);
2951 #endif
2952
2953 if (hostdata != NULL)
2954 {
2955 hostname = US hostdata->h_name;
2956 break;
2957 }
2958
2959 if (af == AF_INET) break;
2960 af = AF_INET;
2961 }
2962 }
2963
2964 primary_hostname = string_copy(hostname);
2965 }
2966
2967 /* Set up default value for smtp_active_hostname */
2968
2969 smtp_active_hostname = primary_hostname;
2970
2971 /* If spool_directory wasn't set in the build-time configuration, it must have
2972 got set above. Of course, writing to the log may not work if log_file_path is
2973 not set, but it will at least get to syslog or somewhere, with any luck. */
2974
2975 if (*spool_directory == 0)
2976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "spool_directory undefined: cannot "
2977 "proceed");
2978
2979 /* Expand the spool directory name; it may, for example, contain the primary
2980 host name. Same comment about failure. */
2981
2982 s = expand_string(spool_directory);
2983 if (s == NULL)
2984 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand spool_directory "
2985 "\"%s\": %s", spool_directory, expand_string_message);
2986 spool_directory = s;
2987
2988 /* Expand log_file_path, which must contain "%s" in any component that isn't
2989 the null string or "syslog". It is also allowed to contain one instance of %D.
2990 However, it must NOT contain % followed by anything else. */
2991
2992 if (*log_file_path != 0)
2993 {
2994 uschar *ss, *sss;
2995 int sep = ':'; /* Fixed for log file path */
2996 s = expand_string(log_file_path);
2997 if (s == NULL)
2998 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand log_file_path "
2999 "\"%s\": %s", log_file_path, expand_string_message);
3000
3001 ss = s;
3002 while ((sss = string_nextinlist(&ss,&sep,big_buffer,big_buffer_size)) != NULL)
3003 {
3004 uschar *t;
3005 if (sss[0] == 0 || Ustrcmp(sss, "syslog") == 0) continue;
3006 t = Ustrstr(sss, "%s");
3007 if (t == NULL)
3008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" does not "
3009 "contain \"%%s\"", sss);
3010 *t = 'X';
3011 t = Ustrchr(sss, '%');
3012 if (t != NULL)
3013 {
3014 if (t[1] != 'D' || Ustrchr(t+2, '%') != NULL)
3015 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_file_path \"%s\" contains "
3016 "unexpected \"%%\" character", s);
3017 }
3018 }
3019
3020 log_file_path = s;
3021 }
3022
3023 /* Interpret syslog_facility into an integer argument for 'ident' param to
3024 openlog(). Default is LOG_MAIL set in globals.c. Allow the user to omit the
3025 leading "log_". */
3026
3027 if (syslog_facility_str != NULL)
3028 {
3029 int i;
3030 uschar *s = syslog_facility_str;
3031
3032 if ((Ustrlen(syslog_facility_str) >= 4) &&
3033 (strncmpic(syslog_facility_str, US"log_", 4) == 0))
3034 s += 4;
3035
3036 for (i = 0; i < syslog_list_size; i++)
3037 {
3038 if (strcmpic(s, syslog_list[i].name) == 0)
3039 {
3040 syslog_facility = syslog_list[i].value;
3041 break;
3042 }
3043 }
3044
3045 if (i >= syslog_list_size)
3046 {
3047 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3048 "failed to interpret syslog_facility \"%s\"", syslog_facility_str);
3049 }
3050 }
3051
3052 /* Expand pid_file_path */
3053
3054 if (*pid_file_path != 0)
3055 {
3056 s = expand_string(pid_file_path);
3057 if (s == NULL)
3058 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to expand pid_file_path "
3059 "\"%s\": %s", pid_file_path, expand_string_message);
3060 pid_file_path = s;
3061 }
3062
3063 /* Compile the regex for matching a UUCP-style "From_" line in an incoming
3064 message. */
3065
3066 regex_From = regex_must_compile(uucp_from_pattern, FALSE, TRUE);
3067
3068 /* Unpick the SMTP rate limiting options, if set */
3069
3070 if (smtp_ratelimit_mail != NULL)
3071 {
3072 unpick_ratelimit(smtp_ratelimit_mail, &smtp_rlm_threshold,
3073 &smtp_rlm_base, &smtp_rlm_factor, &smtp_rlm_limit);
3074 }
3075
3076 if (smtp_ratelimit_rcpt != NULL)
3077 {
3078 unpick_ratelimit(smtp_ratelimit_rcpt, &smtp_rlr_threshold,
3079 &smtp_rlr_base, &smtp_rlr_factor, &smtp_rlr_limit);
3080 }
3081
3082 /* The qualify domains default to the primary host name */
3083
3084 if (qualify_domain_sender == NULL)
3085 qualify_domain_sender = primary_hostname;
3086 if (qualify_domain_recipient == NULL)
3087 qualify_domain_recipient = qualify_domain_sender;
3088
3089 /* Setting system_filter_user in the configuration sets the gid as well if a
3090 name is given, but a numerical value does not. */
3091
3092 if (system_filter_uid_set && !system_filter_gid_set)
3093 {
3094 struct passwd *pw = getpwuid(system_filter_uid);
3095 if (pw == NULL)
3096 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to look up uid %ld",
3097 (long int)system_filter_uid);
3098 system_filter_gid = pw->pw_gid;
3099 system_filter_gid_set = TRUE;
3100 }
3101
3102 /* If the errors_reply_to field is set, check that it is syntactically valid
3103 and ensure it contains a domain. */
3104
3105 if (errors_reply_to != NULL)
3106 {
3107 uschar *errmess;
3108 int start, end, domain;
3109 uschar *recipient = parse_extract_address(errors_reply_to, &errmess,
3110 &start, &end, &domain, FALSE);
3111
3112 if (recipient == NULL)
3113 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3114 "error in errors_reply_to (%s): %s", errors_reply_to, errmess);
3115
3116 if (domain == 0)
3117 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3118 "errors_reply_to (%s) does not contain a domain", errors_reply_to);
3119 }
3120
3121 /* If smtp_accept_queue or smtp_accept_max_per_host is set, then
3122 smtp_accept_max must also be set. */
3123
3124 if (smtp_accept_max == 0 &&
3125 (smtp_accept_queue > 0 || smtp_accept_max_per_host != NULL))
3126 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3127 "smtp_accept_max must be set if smtp_accept_queue or "
3128 "smtp_accept_max_per_host is set");
3129
3130 /* Set up the host number if anything is specified. It is an expanded string
3131 so that it can be computed from the host name, for example. We do this last
3132 so as to ensure that everything else is set up before the expansion. */
3133
3134 if (host_number_string != NULL)
3135 {
3136 uschar *end;
3137 uschar *s = expand_string(host_number_string);
3138 long int n = Ustrtol(s, &end, 0);
3139 while (isspace(*end)) end++;
3140 if (*end != 0)
3141 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3142 "localhost_number value is not a number: %s", s);
3143 if (n > LOCALHOST_MAX)
3144 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3145 "localhost_number is greater than the maximum allowed value (%d)",
3146 LOCALHOST_MAX);
3147 host_number = n;
3148 }
3149
3150 #ifdef SUPPORT_TLS
3151 /* If tls_verify_hosts is set, tls_verify_certificates must also be set */
3152
3153 if ((tls_verify_hosts != NULL || tls_try_verify_hosts != NULL) &&
3154 tls_verify_certificates == NULL)
3155 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3156 "tls_%sverify_hosts is set, but tls_verify_certificates is not set",
3157 (tls_verify_hosts != NULL)? "" : "try_");
3158 #endif
3159 }
3160
3161
3162
3163 /*************************************************
3164 * Initialize one driver *
3165 *************************************************/
3166
3167 /* This is called once the driver's generic options, if any, have been read.
3168 We can now find the driver, set up defaults for the private options, and
3169 unset any "set" bits in the private options table (which might have been
3170 set by another incarnation of the same driver).
3171
3172 Arguments:
3173 d pointer to driver instance block, with generic
3174 options filled in
3175 drivers_available vector of available drivers
3176 size_of_info size of each block in drivers_available
3177 class class of driver, for error message
3178
3179 Returns: pointer to the driver info block
3180 */
3181
3182 static driver_info *
3183 init_driver(driver_instance *d, driver_info *drivers_available,
3184 int size_of_info, uschar *class)
3185 {
3186 driver_info *dd;
3187
3188 for (dd = drivers_available; dd->driver_name[0] != 0;
3189 dd = (driver_info *)(((uschar *)dd) + size_of_info))
3190 {
3191 if (Ustrcmp(d->driver_name, dd->driver_name) == 0)
3192 {
3193 int i;
3194 int len = dd->options_len;
3195 d->info = dd;
3196 d->options_block = store_get(len);
3197 memcpy(d->options_block, dd->options_block, len);
3198 for (i = 0; i < *(dd->options_count); i++)
3199 dd->options[i].type &= ~opt_set;
3200 return dd;
3201 }
3202 }
3203
3204 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3205 "%s %s: cannot find %s driver \"%s\"", class, d->name, class, d->driver_name);
3206
3207 return NULL; /* never obeyed */
3208 }
3209
3210
3211
3212
3213 /*************************************************
3214 * Initialize driver list *
3215 *************************************************/
3216
3217 /* This function is called for routers, transports, and authentication
3218 mechanisms. It reads the data from the current point in the configuration file
3219 up to the end of the section, and sets up a chain of instance blocks according
3220 to the file's contents. The file will already have been opened by a call to
3221 readconf_main, and must be left open for subsequent reading of further data.
3222
3223 Any errors cause a panic crash. Note that the blocks with names driver_info and
3224 driver_instance must map the first portions of all the _info and _instance
3225 blocks for this shared code to work.
3226
3227 Arguments:
3228 class "router", "transport", or "authenticator"
3229 anchor &routers, &transports, &auths
3230 drivers_available available drivers
3231 size_of_info size of each info block
3232 instance_default points to default data for an instance
3233 instance_size size of instance block
3234 driver_optionlist generic option list
3235 driver_optionlist_count count of generic option list
3236
3237 Returns: nothing
3238 */
3239
3240 void
3241 readconf_driver_init(
3242 uschar *class,
3243 driver_instance **anchor,
3244 driver_info *drivers_available,
3245 int size_of_info,
3246 void *instance_default,
3247 int instance_size,
3248 optionlist *driver_optionlist,
3249 int driver_optionlist_count)
3250 {
3251 driver_instance **p = anchor;
3252 driver_instance *d = NULL;
3253 uschar *buffer;
3254
3255 while ((buffer = get_config_line()) != NULL)
3256 {
3257 uschar name[64];
3258 uschar *s;
3259
3260 /* Read the first name on the line and test for the start of a new driver. A
3261 macro definition indicates the end of the previous driver. If this isn't the
3262 start of a new driver, the line will be re-read. */
3263
3264 s = readconf_readname(name, sizeof(name), buffer);
3265
3266 /* Handle macro definition, first finishing off the initialization of the
3267 previous driver, if any. */
3268
3269 if (isupper(*name) && *s == '=')
3270 {
3271 if (d != NULL)
3272 {
3273 if (d->driver_name == NULL)
3274 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3275 "no driver defined for %s \"%s\"", class, d->name);
3276 (d->info->init)(d);
3277 d = NULL;
3278 }
3279 read_macro_assignment(buffer);
3280 continue;
3281 }
3282
3283 /* If the line starts with a name terminated by a colon, we are at the
3284 start of the definition of a new driver. The rest of the line must be
3285 blank. */
3286
3287 if (*s++ == ':')
3288 {
3289 int i;
3290
3291 /* Finish off initializing the previous driver. */
3292
3293 if (d != NULL)
3294 {
3295 if (d->driver_name == NULL)
3296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3297 "no driver defined for %s \"%s\"", class, d->name);
3298 (d->info->init)(d);
3299 }
3300
3301 /* Check that we haven't already got a driver of this name */
3302
3303 for (d = *anchor; d != NULL; d = d->next)
3304 if (Ustrcmp(name, d->name) == 0)
3305 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3306 "there are two %ss called \"%s\"", class, name);
3307
3308 /* Set up a new driver instance data block on the chain, with
3309 its default values installed. */
3310
3311 d = store_get(instance_size);
3312 memcpy(d, instance_default, instance_size);
3313 *p = d;
3314 p = &(d->next);
3315 d->name = string_copy(name);
3316
3317 /* Clear out the "set" bits in the generic options */
3318
3319 for (i = 0; i < driver_optionlist_count; i++)
3320 driver_optionlist[i].type &= ~opt_set;
3321
3322 /* Check nothing more on this line, then do the next loop iteration. */
3323
3324 while (isspace(*s)) s++;
3325 if (*s != 0) extra_chars_error(s, US"driver name ", name, US"");
3326 continue;
3327 }
3328
3329 /* Not the start of a new driver. Give an error if we have not set up a
3330 current driver yet. */
3331
3332 if (d == NULL) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3333 "%s name missing", class);
3334
3335 /* First look to see if this is a generic option; if it is "driver",
3336 initialize the driver. If is it not a generic option, we can look for a
3337 private option provided that the driver has been previously set up. */
3338
3339 if (readconf_handle_option(buffer, driver_optionlist,
3340 driver_optionlist_count, d, NULL))
3341 {
3342 if (d->info == NULL && d->driver_name != NULL)
3343 init_driver(d, drivers_available, size_of_info, class);
3344 }
3345
3346 /* Handle private options - pass the generic block because some may
3347 live therein. A flag with each option indicates if it is in the public
3348 block. */
3349
3350 else if (d->info != NULL)
3351 {
3352 readconf_handle_option(buffer, d->info->options,
3353 *(d->info->options_count), d, US"option \"%s\" unknown");
3354 }
3355
3356 /* The option is not generic and the driver name has not yet been given. */
3357
3358 else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "option \"%s\" unknown "
3359 "(\"driver\" must be specified before any private options)", name);
3360 }
3361
3362 /* Run the initialization function for the final driver. */
3363
3364 if (d != NULL)
3365 {
3366 if (d->driver_name == NULL)
3367 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
3368 "no driver defined for %s \"%s\"", class, d->name);
3369 (d->info->init)(d);
3370 }
3371 }
3372
3373
3374
3375 /*************************************************
3376 * Check driver dependency *
3377 *************************************************/
3378
3379 /* This function is passed a driver instance and a string. It checks whether
3380 any of the string options for the driver contains the given string as an
3381 expansion variable.
3382
3383 Arguments:
3384 d points to a driver instance block
3385 s the string to search for
3386
3387 Returns: TRUE if a dependency is found
3388 */
3389
3390 BOOL
3391 readconf_depends(driver_instance *d, uschar *s)
3392 {
3393 int count = *(d->info->options_count);
3394 optionlist *ol;
3395 uschar *ss;
3396
3397 for (ol = d->info->options; ol < d->info->options + count; ol++)
3398 {
3399 void *options_block;
3400 uschar *value;
3401 int type = ol->type & opt_mask;
3402 if (type != opt_stringptr) continue;
3403 options_block = ((ol->type & opt_public) == 0)? d->options_block : (void *)d;
3404 value = *(uschar **)((uschar *)options_block + (long int)(ol->value));
3405 if (value != NULL && (ss = Ustrstr(value, s)) != NULL)
3406 {
3407 if (ss <= value || (ss[-1] != '$' && ss[-1] != '{') ||
3408 isalnum(ss[Ustrlen(s)])) continue;
3409 DEBUG(D_transport) debug_printf("driver %s: \"%s\" option depends on %s\n",
3410 d->name, ol->name, s);
3411 return TRUE;
3412 }
3413 }
3414
3415 DEBUG(D_transport) debug_printf("driver %s does not depend on %s\n", d->name, s);
3416 return FALSE;
3417 }
3418
3419
3420
3421
3422 /*************************************************
3423 * Decode an error type for retries *
3424 *************************************************/
3425
3426 /* This function is global because it is also called from the main
3427 program when testing retry information. It decodes strings such as "quota_7d"
3428 into numerical error codes.
3429
3430 Arguments:
3431 pp points to start of text
3432 p points past end of text
3433 basic_errno points to an int to receive the main error number
3434 more_errno points to an int to receive the secondary error data
3435
3436 Returns: NULL if decoded correctly; else points to error text
3437 */
3438
3439 uschar *
3440 readconf_retry_error(uschar *pp, uschar *p, int *basic_errno, int *more_errno)
3441 {
3442 int len;
3443 uschar *q = pp;
3444 while (q < p && *q != '_') q++;
3445 len = q - pp;
3446
3447 if (len == 5 && strncmpic(pp, US"quota", len) == 0)
3448 {
3449 *basic_errno = ERRNO_EXIMQUOTA;
3450 if (q != p && (*more_errno = readconf_readtime(q+1, *p, FALSE)) < 0)
3451 return US"bad time value";
3452 }
3453
3454 else if (len == 7 && strncmpic(pp, US"refused", len) == 0)
3455 {
3456 *basic_errno = ECONNREFUSED;
3457 if (q != p)
3458 {
3459 if (strncmpic(q+1, US"MX", p-q-1) == 0) *more_errno = 'M';
3460 else if (strncmpic(q+1, US"A", p-q-1) == 0) *more_errno = 'A';
3461 else return US"A or MX expected after \"refused\"";
3462 }
3463 }
3464
3465 else if (len == 7 && strncmpic(pp, US"timeout", len) == 0)
3466 {
3467 *basic_errno = ETIMEDOUT;
3468 if (q != p)
3469 {
3470 int i;
3471 int xlen = p - q - 1;
3472 uschar *x = q + 1;
3473
3474 static uschar *extras[] =
3475 { US"A", US"MX", US"connect", US"connect_A", US"connect_MX" };
3476 static int values[] =
3477 { 'A', 'M', RTEF_CTOUT, RTEF_CTOUT|'A', RTEF_CTOUT|'M' };
3478
3479 for (i = 0; i < sizeof(extras)/sizeof(uschar *); i++)
3480 {
3481 if (strncmpic(x, extras[i], xlen) == 0)
3482 {
3483 *more_errno = values[i];
3484 break;
3485 }
3486 }
3487
3488 if (i >= sizeof(extras)/sizeof(uschar *))
3489 {
3490 if (strncmpic(x, US"DNS", xlen) == 0)
3491 {
3492 log_write(0, LOG_MAIN|LOG_PANIC, "\"timeout_dns\" is no longer "
3493 "available in retry rules (it has never worked) - treated as "
3494 "\"timeout\"");
3495 }
3496 else return US"\"A\", \"MX\", or \"connect\" expected after \"timeout\"";
3497 }
3498 }
3499 }
3500
3501 else if (strncmpic(pp, US"mail_4", 6) == 0 ||
3502 strncmpic(pp, US"rcpt_4", 6) == 0 ||
3503 strncmpic(pp, US"data_4", 6) == 0)
3504 {
3505 BOOL bad = FALSE;
3506 int x = 255; /* means "any 4xx code" */
3507 if (p != pp + 8) bad = TRUE; else
3508 {
3509 int a = pp[6], b = pp[7];
3510 if (isdigit(a))
3511 {
3512 x = (a - '0') * 10;
3513 if (isdigit(b)) x += b - '0';
3514 else if (b == 'x') x += 100;
3515 else bad = TRUE;
3516 }
3517 else if (a != 'x' || b != 'x') bad = TRUE;
3518 }
3519
3520 if (bad)
3521 return string_sprintf("%.4s_4 must be followed by xx, dx, or dd, where "
3522 "x is literal and d is any digit", pp);
3523
3524 *basic_errno = (*pp == 'm')? ERRNO_MAIL4XX :
3525 (*pp == 'r')? ERRNO_RCPT4XX : ERRNO_DATA4XX;
3526 *more_errno = x << 8;
3527 }
3528
3529 else if (len == 4 && strncmpic(pp, US"auth", len) == 0 &&
3530 strncmpic(q+1, US"failed", p-q-1) == 0)
3531 *basic_errno = ERRNO_AUTHFAIL;
3532
3533 else if (strncmpic(pp, US"lost_connection", p - pp) == 0)
3534 *basic_errno = ERRNO_SMTPCLOSED;
3535
3536 else if (strncmpic(pp, US"tls_required", p - pp) == 0)
3537 *basic_errno = ERRNO_TLSREQUIRED;
3538
3539 else if (len != 1 || Ustrncmp(pp, "*", 1) != 0)
3540 return string_sprintf("unknown or malformed retry error \"%.*s\"", p-pp, pp);
3541
3542 return NULL;
3543 }
3544
3545
3546
3547
3548 /*************************************************
3549 * Read retry information *
3550 *************************************************/
3551
3552 /* Each line of retry information contains:
3553
3554 . A domain name pattern or an address pattern;
3555
3556 . An error name, possibly with additional data, or *;
3557
3558 . An optional sequence of retry items, each consisting of an identifying
3559 letter, a cutoff time, and optional parameters.
3560
3561 All this is decoded and placed into a control block. */
3562
3563
3564 /* Subroutine to read an argument, preceded by a comma and terminated
3565 by comma, semicolon, whitespace, or newline. The types are: 0 = time value,
3566 1 = fixed point number (returned *1000).
3567
3568 Arguments:
3569 paddr pointer to pointer to current character; updated
3570 type 0 => read a time; 1 => read a fixed point number
3571
3572 Returns: time in seconds or fixed point number * 1000
3573 */
3574
3575 static int
3576 retry_arg(uschar **paddr, int type)
3577 {
3578 uschar *p = *paddr;
3579 uschar *pp;
3580
3581 if (*p++ != ',') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma expected");
3582
3583 while (isspace(*p)) p++;
3584 pp = p;
3585 while (isalnum(*p) || (type == 1 && *p == '.')) p++;
3586
3587 if (*p != 0 && !isspace(*p) && *p != ',' && *p != ';')
3588 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "comma or semicolon expected");
3589
3590 *paddr = p;
3591 switch (type)
3592 {
3593 case 0:
3594 return readconf_readtime(pp, *p, FALSE);
3595 case 1:
3596 return readconf_readfixed(pp, *p);
3597 }
3598 return 0; /* Keep picky compilers happy */
3599 }
3600
3601 /* The function proper */
3602
3603 void
3604 readconf_retries(void)
3605 {
3606 retry_config **chain = &retries;
3607 retry_config *next;
3608 uschar *p;
3609
3610 while ((p = get_config_line()) != NULL)
3611 {
3612 retry_rule **rchain;
3613 uschar *pp, *error;
3614
3615 next = store_get(sizeof(retry_config));
3616 next->next = NULL;
3617 *chain = next;
3618 chain = &(next->next);
3619 next->basic_errno = next->more_errno = 0;
3620 next->senders = NULL;
3621 next->rules = NULL;
3622 rchain = &(next->rules);
3623
3624 next->pattern = string_dequote(&p);
3625 while (isspace(*p)) p++;
3626 pp = p;
3627 while (mac_isgraph(*p)) p++;
3628 if (p - pp <= 0) log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3629 "missing error type");
3630
3631 /* Test error names for things we understand. */
3632
3633 if ((error = readconf_retry_error(pp, p, &(next->basic_errno),
3634 &(next->more_errno))) != NULL)
3635 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "%s", error);
3636
3637 /* There may be an optional address list of senders to be used as another
3638 constraint on the rule. This was added later, so the syntax is a bit of a
3639 fudge. Anything that is not a retry rule starting "F," or "G," is treated as
3640 an address list. */
3641
3642 while (isspace(*p)) p++;
3643 if (Ustrncmp(p, "senders", 7) == 0)
3644 {
3645 p += 7;
3646 while (isspace(*p)) p++;
3647 if (*p++ != '=') log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3648 "\"=\" expected after \"senders\" in retry rule");
3649 while (isspace(*p)) p++;
3650 next->senders = string_dequote(&p);
3651 }
3652
3653 /* Now the retry rules. Keep the maximum timeout encountered. */
3654
3655 while (isspace(*p)) p++;
3656
3657 while (*p != 0)
3658 {
3659 retry_rule *rule = store_get(sizeof(retry_rule));
3660 *rchain = rule;
3661 rchain = &(rule->next);
3662 rule->next = NULL;
3663 rule->rule = toupper(*p++);
3664 rule->timeout = retry_arg(&p, 0);
3665 if (rule->timeout > retry_maximum_timeout)
3666 retry_maximum_timeout = rule->timeout;
3667
3668 switch (rule->rule)
3669 {
3670 case 'F': /* Fixed interval */
3671 rule->p1 = retry_arg(&p, 0);
3672 break;
3673
3674 case 'G': /* Geometrically increasing intervals */
3675 case 'H': /* Ditto, but with randomness */
3676 rule->p1 = retry_arg(&p, 0);
3677 rule->p2 = retry_arg(&p, 1);
3678 break;
3679
3680 default:
3681 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "unknown retry rule letter");
3682 break;
3683 }
3684
3685 if (rule->timeout <= 0 || rule->p1 <= 0 ||
3686 (rule->rule != 'F' && rule->p2 < 1000))
3687 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3688 "bad parameters for retry rule");
3689
3690 while (isspace(*p)) p++;
3691 if (*p == ';')
3692 {
3693 p++;
3694 while (isspace(*p)) p++;
3695 }
3696 else if (*p != 0)
3697 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "semicolon expected");
3698 }
3699 }
3700 }
3701
3702
3703
3704 /*************************************************
3705 * Initialize authenticators *
3706 *************************************************/
3707
3708 /* Read the authenticators section of the configuration file.
3709
3710 Arguments: none
3711 Returns: nothing
3712 */
3713
3714 static void
3715 auths_init(void)
3716 {
3717 auth_instance *au, *bu;
3718 readconf_driver_init(US"authenticator",
3719 (driver_instance **)(&auths), /* chain anchor */
3720 (driver_info *)auths_available, /* available drivers */
3721 sizeof(auth_info), /* size of info block */
3722 &auth_defaults, /* default values for generic options */
3723 sizeof(auth_instance), /* size of instance block */
3724 optionlist_auths, /* generic options */
3725 optionlist_auths_size);
3726
3727 for (au = auths; au != NULL; au = au->next)
3728 {
3729 if (au->public_name == NULL)
3730 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "no public name specified for "
3731 "the %s authenticator", au->name);
3732 for (bu = au->next; bu != NULL; bu = bu->next)
3733 {
3734 if (strcmpic(au->public_name, bu->public_name) == 0)
3735 {
3736 if ((au->client && bu->client) || (au->server && bu->server))
3737 log_write(0, LOG_PANIC_DIE|LOG_CONFIG, "two %s authenticators "
3738 "(%s and %s) have the same public name (%s)",
3739 (au->client)? US"client" : US"server", au->name, bu->name,
3740 au->public_name);
3741 }
3742 }
3743 }
3744 }
3745
3746
3747
3748
3749 /*************************************************
3750 * Read ACL information *
3751 *************************************************/
3752
3753 /* If this run of Exim is not doing something that involves receiving a
3754 message, we can just skip over the ACL information. No need to parse it.
3755
3756 First, we have a function for acl_read() to call back to get the next line. We
3757 need to remember the line we passed, because at the end it will contain the
3758 name of the next ACL. */
3759
3760 static uschar *acl_line;
3761
3762 static uschar *
3763 acl_callback(void)
3764 {
3765 acl_line = get_config_line();
3766 return acl_line;
3767 }
3768
3769
3770 /* Now the main function:
3771
3772 Arguments:
3773 skip TRUE when this Exim process is doing something that will
3774 not need the ACL data
3775
3776 Returns: nothing
3777 */
3778
3779 static void
3780 readconf_acl(BOOL skip)
3781 {
3782 uschar *p;
3783
3784 /* Not receiving messages, don't need to parse the ACL data */
3785
3786 if (skip)
3787 {
3788 DEBUG(D_acl) debug_printf("skipping ACL configuration - not needed\n");
3789 while ((p = get_config_line()) != NULL);
3790 return;
3791 }
3792
3793 /* Read each ACL and add it into the tree. Macro (re)definitions are allowed
3794 between ACLs. */
3795
3796 acl_line = get_config_line();
3797
3798 while(acl_line != NULL)
3799 {
3800 uschar name[64];
3801 tree_node *node;
3802 uschar *error;
3803
3804 p = readconf_readname(name, sizeof(name), acl_line);
3805 if (isupper(*name) && *p == '=')
3806 {
3807 read_macro_assignment(acl_line);
3808 acl_line = get_config_line();
3809 continue;
3810 }
3811
3812 if (*p != ':' || name[0] == 0)
3813 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "missing or malformed ACL name");
3814
3815 node = store_get(sizeof(tree_node) + Ustrlen(name));
3816 Ustrcpy(node->name, name);
3817 if (!tree_insertnode(&acl_anchor, node))
3818 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3819 "there are two ACLs called \"%s\"", name);
3820
3821 node->data.ptr = acl_read(acl_callback, &error);
3822
3823 if (node->data.ptr == NULL && error != NULL)
3824 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "error in ACL: %s", error);
3825 }
3826 }
3827
3828
3829
3830 /*************************************************
3831 * Read configuration for local_scan() *
3832 *************************************************/
3833
3834 /* This function is called after "begin local_scan" is encountered in the
3835 configuration file. If the local_scan() function allows for configuration
3836 options, we can process them. Otherwise, we expire in a panic.
3837
3838 Arguments: none
3839 Returns: nothing
3840 */
3841
3842 static void
3843 local_scan_init(void)
3844 {
3845 #ifndef LOCAL_SCAN_HAS_OPTIONS
3846 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN, "local_scan() options not supported: "
3847 "(LOCAL_SCAN_HAS_OPTIONS not defined in Local/Makefile)");
3848 #else
3849
3850 uschar *p;
3851 while ((p = get_config_line()) != NULL)
3852 {
3853 (void) readconf_handle_option(p, local_scan_options, local_scan_options_count,
3854 NULL, US"local_scan option \"%s\" unknown");
3855 }
3856 #endif
3857 }
3858
3859
3860
3861 /*************************************************
3862 * Read rest of configuration (after main) *
3863 *************************************************/
3864
3865 /* This function reads the rest of the runtime configuration, after the main
3866 configuration. It is called only when actually needed. Each subsequent section
3867 of the configuration starts with a line of the form
3868
3869 begin name
3870
3871 where the name is "routers", "transports", etc. A section is terminated by
3872 hitting the next "begin" line, and the next name is left in next_section.
3873 Because it may confuse people as to whether the names are singular or plural,
3874 we add "s" if it's missing. There is always enough room in next_section for
3875 this. This function is basically just a switch.
3876
3877 Arguments:
3878 skip_acl TRUE if ACL information is not needed
3879
3880 Returns: nothing
3881 */
3882
3883 static uschar *section_list[] = {
3884 US"acls",
3885 US"authenticators",
3886 US"local_scans",
3887 US"retrys",
3888 US"rewrites",
3889 US"routers",
3890 US"transports"};
3891
3892 void
3893 readconf_rest(BOOL skip_acl)
3894 {
3895 int had = 0;
3896
3897 while(next_section[0] != 0)
3898 {
3899 int bit;
3900 int first = 0;
3901 int last = sizeof(section_list) / sizeof(uschar *);
3902 int mid = last/2;
3903 int n = Ustrlen(next_section);
3904
3905 if (tolower(next_section[n-1]) != 's') Ustrcpy(next_section+n, "s");
3906
3907 for (;;)
3908 {
3909 int c = strcmpic(next_section, section_list[mid]);
3910 if (c == 0) break;
3911 if (c > 0) first = mid + 1; else last = mid;
3912 if (first >= last)
3913 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3914 "\"%.*s\" is not a known configuration section name", n, next_section);
3915 mid = (last + first)/2;
3916 }
3917
3918 bit = 1 << mid;
3919 if (((had ^= bit) & bit) == 0)
3920 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_IN,
3921 "\"%.*s\" section is repeated in the configuration file", n,
3922 next_section);
3923
3924 switch(mid)
3925 {
3926 case 0: readconf_acl(skip_acl); break;
3927 case 1: auths_init(); break;
3928 case 2: local_scan_init(); break;
3929 case 3: readconf_retries(); break;
3930 case 4: readconf_rewrites(); break;
3931 case 5: route_init(); break;
3932 case 6: transport_init(); break;
3933 }
3934 }
3935
3936 (void)fclose(config_file);
3937 }
3938
3939 /* End of readconf.c */