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