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