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